Lysa  0.0
Lysa 3D Engine
Event Class Referenceabstract

Detailed Description

An engine event carrying a typed payload.

Lua full name: lysa.Event

Public Member Functions

number get_double ()
 Returns the event payload as a double. More...
 
number get_float ()
 Returns the event payload as a float. More...
 
integer get_int32 ()
 Returns the event payload as an int32. More...
 
InputEvent get_input_event ()
 Returns the event payload as an InputEvent. More...
 

Properties

integer id
 Unique event identifier.
 
any type
 The event type string or constant.
 
boolean consumed
 True if the event has already been consumed; set to true to stop further processing.
 

Member Function Documentation

number get_double ( )

Returns the event payload as a double.

Returns
number
number get_float ( )

Returns the event payload as a float.

Returns
number
integer get_int32 ( )

Returns the event payload as an int32.

Returns
integer
InputEvent get_input_event ( )

Returns the event payload as an InputEvent.

Returns
InputEvent

Property Documentation

integer id

Unique event identifier.

any type

The event type string or constant.

boolean consumed

True if the event has already been consumed; set to true to stop further processing.