Skip to content

FireEventObject

The FireEventObject class provides helpers for reading event values passed to fire-event callbacks.


Properties

namestring

The name.


idnumber

The id.


keyValue{ [key: string]: any; }

The key value.


Methods

GetBool(key: string)boolean

Retrieves a boolean event value by key.

  • keystring - The key value.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetInt(key: string)number

Retrieves an integer event value by key.

  • keystring - The key value.

Returned:

  • number - The requested int.

GetFloat(key: string)number

Retrieves a floating-point event value by key.

  • keystring - The key value.

Returned:

  • number - The requested float.

GetString(key: string)string

Retrieves a string event value by key.

  • keystring - The key value.

Returned:

  • string - The requested string.