Przejdź do treści

EventHandler

This package allows to create new events and trigger them at desired times. The Gamestate package already uses it.

Warning

The EventHandler requires some basic understanding of the PermMem. The documentation can be found here.

Dependencies

Initialization

Initialize with LeGo_EventHandler flag. 

1
LeGo_Init(LeGo_EventHandler);

Implementation

EventHandler.d on GitHub

Functions

Event_Create

Creates a new event and returns a handle to it. 

1
func int Event_Create()
Return value

The function returns a new PermMem handle to an event.

Event_Delete

Alias to PermMem delete. Cleans up the handle. 

1
func void Event_Delete(var int event)
Parameters
  • var int event
    Handle returned from Event_Create

Event_Empty

Checks whether the event is "empty", i.e. nothing will happen after its execution. 

1
func int Event_Empty(var int event)
Parameters
  • var int event
    Handle returned from Event_Create

Return value

The function returns TRUE if event is empty, FALSE is returned otherwise.

Event_Has

Checks if function is added to the event. 

1
func int Event_Has(var int event, var func function)
Parameters
  • var int event
    Handle returned from Event_Create
  • var func function
    Checked function

Return value

The function returns TRUE if function is added, FALSE is returned otherwise.

Event_Add

Adds an event handler function. The handler is called after running Event_Execute. 

1
func void Event_Add(var int event, var func function)
Parameters
  • var int event
    Handle returned from Event_Create
  • var func function
    Function to be added

Event_AddOnce

Event_Add but checks if the handler function is already added, to prevent duplicates. 

1
func void Event_AddOnce(var int event, var func function)
Parameters
  • var int event
    Handle returned from Event_Create
  • var func function
    Function to be added

Event_Remove

Removes the event handler function from the event. 

1
func void Event_Remove(var int event, var func function)
Parameters
  • var int event
    Handle returned from Event_Create
  • var func function
    Function to be removed

Event_Execute

Core of the package. Calls all functions registered via Event_Add and Event_AddOnce. 

1
func void Event_Execute(var int event, var int data)
Parameters
  • var int event
    Handle returned from Event_Create
  • var int data
    Int parameter passed to all executed functions

Ptr functions

Tip

The pointer functions are used internally by the previous functions. If you created an event with Event_Create use functions without Ptr in the name, but if you created event with EventPtr_Create use only Ptr functions. The normal user will probably never need the pointer versions, however the choice, which one to use is yours.

EventPtr_Create

Creates a new event and returns a pointer to it. 

1
func int EventPtr_Create()
Return value

The function returns a new PermMem pointer to an event.

EventPtr_Delete

Alias to PermMem free. Cleans up the pointer. 

1
func void EventPtr_Delete(var int eventPtr)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create

EventPtr_Empty

Checks whether the event is "empty", i.e. nothing will happen after its execution. 

1
func int EventPtr_Empty(var int eventPtr)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create

Return value

The function returns TRUE if empty, FALSE is returned otherwise.

EventPtr_Has

Checks if function is added to an event. 

1
func int EventPtr_Has(var int eventPtr, var func function)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var func function
    Checked function

Return value

The function returns TRUE if function is added, FALSE is returned otherwise.

EventPtr_HasI

EventPtr_Has but with function ID instead of pointer. Used mainly internally. 

1
func int EventPtr_HasI(var int eventPtr, var int id)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var int id
    ID of checked function

Return value

The function returns TRUE if function is added, FALSE is returned otherwise.

EventPtr_Add

Adds an event handler function. The handler is called after running EventPtr_Execute. 

1
func void EventPtr_Add(var int eventPtr, var func function)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var func function
    Function to be added

EventPtr_AddI

EventPtr_Add but with function ID instead of pointer. Used mainly internally. 

1
func void EventPtr_AddI(var int eventPtr, var int id)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var int id
    ID of function to be added

EventPtr_AddOnce

Event_Add but checks if function is already added, to prevent duplicates. 

1
func void EventPtr_AddOnce(var int eventPtr, var func function)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var func function
    Function to be added

EventPtr_AddOnceI

EventPtr_AddI but checks if function is already added, to prevent duplicates. 

1
func void EventPtr_AddOnceI(var int eventPtr, var int id)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var int id
    ID of function to be added

EventPtr_Remove

Removes a function from the event's call list. 

1
func void EventPtr_Remove(var int eventPtr, var func function)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var func function
    Function to be removed

EventPtr_RemoveI

EventPtr_Remove but with function ID instead of pointer. Used mainly internally. 

1
func void EventPtr_RemoveI(var int eventPtr, var int id)
Parameters
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var int id
    ID of function to be removed

EventPtr_Execute

Core of the package. Calls all functions registered via EventPtr_Add and EventPtr_AddOnce. 

1
func void EventPtr_Execute(var int eventPtr, var int data)
  • var int eventPtr
    Pointer returned from EventPtr_Create
  • var int data
    Int parameter passed to all executed functions

Examples

Note

This article has no built-in examples, but the best way to understand how EventHandler works is reading source code of the Gamestate package.