Events
Introduction
The FRB Editor supports the addition of events to screens and entities. The most common types of events include:
Responding to a variable changing. For more info see the Variable Event page.
Responding to collision (on a CollisionRelationship)
Other objects such as IWindows can also expose events, but these are less common.
The only type of event which requires using the FlatRedBall Editor is variable events. All other events can be performed purely in code. CollisionRelationship events are often defined in the FlatRedBall Editor since doing so provides a single place to see all responses to a collision.
Variable Example
Variable events allow for custom code to react to a variable being assigned. To add an event for a variable:
Create a variable on your entity
Drag+drop the variable onto the Events folder
This creates an event in the Event.cs file for the container. For example, if the event is created in the Player entity, then the event handler is added to Player.Event.cs.
IWindow Example
Note that IWindows are not used as often in modern FlatRedBall development due to the introduction of FlatRedBall.Forms. However, the following example does show how events can be used for custom implementations of IWindow. The events available to a screen, entity, or object depend on the respective container's properties. For example, if an entity implements IWindow (for more information, see the Implements IWindow page), the entity will have additional events available.
Editing Event Code
Every event in Glue creates a corresponding method in your code project which can be edited in Visual Studio. For example, consider the example of a GameScreen which has an event ResolutionOrOrientationChanged:
The presence of this event will result in 2 new code files:
GameScreen.Event.cs
GameScreen.Generated.Event.cs
As usual, the file with Generated in the name is a generated file which should not be edited because Glue may overwrite any manual changes. The non-generated file (GameScreen.Event.cs) can be freely edited to modify the logic associated with a given event.
Last updated
