GameState
EEex_GameState_AddAfterIncludesListener
Warning
This function is currently undocumented.
EEex_GameState_AddBeforeIncludesListener
Warning
This function is currently undocumented.
EEex_GameState_AddDestroyedListener
Summary
Registers a listener function that is called immediately after the engine has cleaned up a game session. Examples of when this occurs include the user quitting to the main menu, loading a save, etc.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
listener |
function |
The listener to register. |
EEex_GameState_AddInitializedListener
Summary
Registers a listener function that is called immediately after the engine's Lua environment has been initialized.
This only occurs once during the engine's early start up process. If the engine has already been initialized,
listener is called immediately.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
listener |
function |
The listener to register. |
EEex_GameState_AddShutdownListener
Warning
This function is currently undocumented.
EEex_GameState_GetGlobalInt
Summary
Returns the integer value of the variableName Global scoped to GLOBAL.
If no variable named variableName exists, returns 0.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
variableName |
string |
The name of the variable to fetch. |
Return Values:
Type |
Description |
|---|---|
number |
See summary. |
EEex_GameState_GetGlobalString
Summary
Returns the string value of the variableName Global scoped to GLOBAL.
If no variable named variableName exists, returns "".
Note
Global string values can only be accessed through EEex functions.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
variableName |
string |
The name of the variable to fetch. |
Return Values:
Type |
Description |
|---|---|
string |
See summary. |
EEex_GameState_GetInputMode
Warning
This function is currently undocumented.
EEex_GameState_SetGlobalInt
Summary
Sets the integer value of the variableName Global scoped to GLOBAL to value.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
variableName |
string |
The name of the variable to set. |
|
value |
number |
The value to set the variable to. |
EEex_GameState_SetGlobalString
Summary
Sets the string value of the variableName Global scoped to GLOBAL to value.
Note
Global string values can only be accessed through EEex functions.
Warning
Global string values can be a maximum of 32 characters. Attempting to set a value that is longer than 32 characters will result in the value being truncated.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
variableName |
string |
The name of the variable to set. |
|
value |
string |
The value to set the variable to. |
EEex_GameState_SetInputMode
Warning
This function is currently undocumented.
EEex_GameState_TogglePause
Summary
Toggles the pause status of the game.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
bLogPause |
boolean |
|
Determines whether a message is written to the combat log. |
bVisualPause |
boolean |
|
Determines whether the engine renders screen-edge arrows and forces party markers during pause. |
bRequireHostUnpause |
boolean |
|
Unknown. |
nIdPlayerPause |
number |
|
Unknown. |
bSendMessage |
boolean |
|
Unknown. |
EEex_GameState_WouldWorldScreenProcessInput
Summary
Returns true if the world screen would currently process a keypress.
Note
It is the caller's responsibility to check if the active engine is the world screen and if a text edit is currently focused.
Return Values:
Type |
Description |
|---|---|
boolean |
See summary. |