Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.EventQueue Class Reference

A Component to manage and process queue of events. More...

Inherits Otter.EventProcessor.

Public Member Functions

void Add (params EventProcessorEvent[] evt)
 Add events to the queue. More...
 
void Push (params EventProcessorEvent[] evt)
 Push events into the front of the queue. More...
 
override void Update ()
 Called during the Update on the parent Entity. More...
 
- Public Member Functions inherited from Otter.Component
virtual void Added ()
 Called when the Component is added to the Entity. More...
 
virtual void Removed ()
 Called when the Component is removed from the Entity. More...
 
void RemoveSelf ()
 Removes the Component from its parent Entity. More...
 
virtual void UpdateFirst ()
 Called during the UpdateFirst on the parent Entity. More...
 
virtual void Render ()
 Called during the Render on the parent Entity. More...
 
virtual void UpdateLast ()
 Called during the UpdateLast on the parent Entity. More...
 
GetComponent< T > ()
 Gets the first Component of type T from this Component's Entity. More...
 
List< T > GetComponents< T > ()
 Gets a list of Components of type T from this Component's Entity. More...
 

Additional Inherited Members

- Public Attributes inherited from Otter.EventProcessor
List< EventProcessorEventEvents = new List<EventProcessorEvent>()
 The list of EventQueueEvents to execute. More...
 
bool RunEvents = true
 Determines if the events will be run. Defaults to true. More...
 
- Public Attributes inherited from Otter.Component
Entity Entity
 The parent Entity of the Component. More...
 
bool RenderAfterEntity = true
 Determines if the Component should render after the Entity has rendered. More...
 
bool Visible = true
 Determines if the Component will render. More...
 
float Timer = 0
 How long the Component has been alive (added to an Entity and updated.) More...
 
- Protected Attributes inherited from Otter.EventProcessor
bool isFreshEvent = true
 
- Properties inherited from Otter.EventProcessor
EventProcessorEvent CurrentEvent [get, set]
 The current event that is being executed. More...
 
bool HasEvents [get]
 True if the number of events in the queue is greater than zero. More...
 
- Properties inherited from Otter.Component
Scene Scene [get]
 The Scene that the parent Entity is in. More...
 
Collider Collider [get]
 The first Collider of the parent Entity. More...
 
Graphic Graphic [get]
 The first Graphic of the parent Entity. More...
 
List< GraphicGraphics [get]
 The list of Graphics from the parent Entity. More...
 
List< ColliderColliders [get]
 The list of Colliders from the parent Entity. More...
 

Detailed Description

A Component to manage and process queue of events.

Member Function Documentation

void Otter.EventQueue.Add ( params EventProcessorEvent[]  evt)

Add events to the queue.

Parameters
evtThe events to add.
void Otter.EventQueue.Push ( params EventProcessorEvent[]  evt)

Push events into the front of the queue.

Parameters
evtThe events to push.
override void Otter.EventQueue.Update ( )
virtual

Called during the Update on the parent Entity.

Reimplemented from Otter.Component.


The documentation for this class was generated from the following file: