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

Public Member Functions

GetScene< T > ()
 The Scene that has the Entity that has the EventProcessor that this event belongs to. More...
 
virtual void Begin ()
 Called when the Event first starts. More...
 
virtual void End ()
 Called when the Event finishes and is cleared from the queue. More...
 
void Finish ()
 Finishes the event. More...
 
void Start ()
 Starts the event. More...
 
virtual void Update ()
 Called every update from the EventProcessor. More...
 

Public Attributes

EventProcessor EventProcessor
 The EventProcessor that this event belongs to. More...
 
float Timer = 0
 The elapsed time for this event. More...
 

Properties

Entity Entity [get]
 The Entity that has the EventProcessor that this event belongs to. More...
 
Scene Scene [get]
 The Scene that has the Entity that has the EventProcessor that this event belongs to. More...
 
bool IsFinished [get, set]
 Whether or not the Event has finished. More...
 

Member Function Documentation

virtual void Otter.EventProcessorEvent.Begin ( )
virtual

Called when the Event first starts.

virtual void Otter.EventProcessorEvent.End ( )
virtual

Called when the Event finishes and is cleared from the queue.

void Otter.EventProcessorEvent.Finish ( )

Finishes the event.

T Otter.EventProcessorEvent.GetScene< T > ( )

The Scene that has the Entity that has the EventProcessor that this event belongs to.

Template Parameters
TThe Type the Scene should be cast to.
Returns
The Scene that has the Entity that has the EventProcessor that this event belongs to.
Type Constraints
T :Scene 
void Otter.EventProcessorEvent.Start ( )

Starts the event.

virtual void Otter.EventProcessorEvent.Update ( )
virtual

Called every update from the EventProcessor.

Member Data Documentation

EventProcessor Otter.EventProcessorEvent.EventProcessor

The EventProcessor that this event belongs to.

float Otter.EventProcessorEvent.Timer = 0

The elapsed time for this event.

Property Documentation

Entity Otter.EventProcessorEvent.Entity
get

The Entity that has the EventProcessor that this event belongs to.

bool Otter.EventProcessorEvent.IsFinished
getset

Whether or not the Event has finished.

Scene Otter.EventProcessorEvent.Scene
get

The Scene that has the Entity that has the EventProcessor that this event belongs to.


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