Static Public Member Functions | Static Private Member Functions

ScriptEventController Class Reference

Class that handles all event related functions. More...

#include <script_event.hpp>

Inheritance diagram for ScriptEventController:
ScriptObject SimpleCountedObject

Static Public Member Functions

static bool IsEventWaiting ()
 Check if there is an event waiting.
static ScriptEventGetNextEvent ()
 Get the next event.
static void InsertEvent (ScriptEvent *event)
 Insert an event to the queue for the company.
static void FreeEventPointer ()
 Free the event pointer.

Static Private Member Functions

static void CreateEventPointer ()
 Create the event pointer.

Detailed Description

Class that handles all event related functions.

ai

Note:
it is not needed to create an instance of ScriptEvent to access it, as all members are static, and all data is stored AI-wide.

Definition at line 81 of file script_event.hpp.


Member Function Documentation

void ScriptEventController::FreeEventPointer (  )  [static]

Free the event pointer.

-all

Definition at line 29 of file script_event.cpp.

References ScriptObject::GetEventPointer(), and ScriptEventData::stack.

ScriptEvent * ScriptEventController::GetNextEvent (  )  [static]

Get the next event.

Returns:
a class of the event-child issues.

Definition at line 52 of file script_event.cpp.

References CreateEventPointer(), ScriptObject::GetEventPointer(), and ScriptEventData::stack.

void ScriptEventController::InsertEvent ( ScriptEvent event  )  [static]

Insert an event to the queue for the company.

Parameters:
event The event to insert. -all

Definition at line 64 of file script_event.cpp.

References CreateEventPointer(), ScriptObject::GetEventPointer(), and ScriptEventData::stack.

bool ScriptEventController::IsEventWaiting (  )  [static]

Check if there is an event waiting.

Returns:
true if there is an event on the stack.

Definition at line 44 of file script_event.cpp.

References CreateEventPointer(), ScriptObject::GetEventPointer(), and ScriptEventData::stack.


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