BRL.EventQueue: | Globals | Functions | Modinfo | Source |
Global CurrentEvent:TEvent | |
Description | Current Event. |
Information | The CurrentEvent global variable contains the event most recently returned by PollEvent or WaitEvent. |
Function EventData() | |
Returns | The data field of the CurrentEvent global variable. |
Description | Get current event data. |
Function EventExtra:Object() | |
Returns | The extra field of the CurrentEvent global variable. |
Description | Get current event extra value. |
Function EventID() | |
Returns | The id field of the CurrentEvent global variable. |
Description | Get current event id. |
Function EventMods() | |
Returns | The mods field of the CurrentEvent global variable. |
Description | Get current event modifiers. |
Function EventSource:Object() | |
Returns | The source field of the CurrentEvent global variable. |
Description | Get current event source object. |
Function EventSourceHandle() | |
Returns | The source field of the CurrentEvent global variable converted to an integer handle. |
Description | Get current event source object handle. |
Function EventText$() | |
Returns | The extra field of the CurrentEvent global variable converted to a string. |
Description | Get current event extra value converted to a string. |
Function EventX() | |
Returns | The x field of the CurrentEvent global variable. |
Description | Get current event x value. |
Function EventY() | |
Returns | The y field of the CurrentEvent global variable. |
Description | Get current event y value. |
Function PeekEvent:TEvent() | |
Description | Examine the next event in the event queue. |
Information | PeekEvent examines the next event in the event queue, without removing it from the event
queue or modifying the CurrentEvent global variable. If there are no events in the event queue, PeekEvent returns Null. |
Function PollEvent() | |
Returns | The id of the next event in the event queue, or 0 if the event queue is empty. |
Description | Get the next event from the event queue. |
Information | PollEvent removes an event from the event queue and updates the CurrentEvent
global variable. If there are no events in the event queue, PollEvent returns Null. |
Function PostEvent( event:TEvent,update=False ) | |
Description | Post an event to the event queue. |
Information | PostEvent adds an event to the end of the event queue. The update flag can be used to update an existing event. If update is True and an event with the same id and source is found in the event queue, the existing event will be updated instead of event being added to the event queue. This can be useful to prevent high frequency events such as timer events from flooding the event queue. |
Function WaitEvent() | |
Returns | The id of the next event in the event queue. |
Description | Get the next event from the event queue, waiting if necessary. |
Information | WaitEvent removes an event from the event queue and updates the CurrentEvent
global variable. If there are no events in the event queue, WaitEvent halts program execution until an event is available. |
Version | 1.00 |
---|---|
Author | Mark Sibly |
License | Blitz Shared Source Code |
Copyright | Blitz Research Ltd |
Modserver | BRL |
History | 1.00 Release |
History | Created module |