GameInterfaceAPI
Functions
ConsoleCommand
GameInterfaceAPI.ConsoleCommand(command: string): void
No description provided.
Parameter
| Name | Type | Description |
command | string | No description provided. |
GetCurrentMap
GameInterfaceAPI.GetCurrentMap(): string | null
Gets the current map name, or null if no map is active.
GetGameUIState
GameInterfaceAPI.GetGameUIState(): GameUIState
Gets the current game state.
GetSettingBool
GameInterfaceAPI.GetSettingBool(key: string): boolean
No description provided.
Parameter
| Name | Type | Description |
key | string | No description provided. |
GetSettingColor
GameInterfaceAPI.GetSettingColor(key: string): string
No description provided.
Parameter
| Name | Type | Description |
key | string | No description provided. |
GetSettingFloat
GameInterfaceAPI.GetSettingFloat(key: string): float
No description provided.
Parameter
| Name | Type | Description |
key | string | No description provided. |
GetSettingInt
GameInterfaceAPI.GetSettingInt(key: string): int32
No description provided.
Parameter
| Name | Type | Description |
key | string | No description provided. |
GetSettingString
GameInterfaceAPI.GetSettingString(key: string): string
No description provided.
Parameter
| Name | Type | Description |
key | string | No description provided. |
RegisterGameEventHandler
GameInterfaceAPI.RegisterGameEventHandler(event_name: string, callback: Func<any[], void>): uuid
Registers a callback for a specific game event type, returns an event handler ID to unregister with
Parameters
| Name | Type | Description |
event_name | string | No description provided. |
callback | Func<any[], void> | No description provided. |
SetSettingBool
GameInterfaceAPI.SetSettingBool(key: string, value: boolean): void
No description provided.
Parameters
| Name | Type | Description |
key | string | No description provided. |
value | boolean | No description provided. |
SetSettingColor
GameInterfaceAPI.SetSettingColor(key: string, value: unknown): void
No description provided.
Parameters
| Name | Type | Description |
key | string | No description provided. |
value | unknown | No description provided. |
SetSettingFloat
GameInterfaceAPI.SetSettingFloat(key: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
key | string | No description provided. |
value | number | No description provided. |
SetSettingInt
GameInterfaceAPI.SetSettingInt(key: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
key | string | No description provided. |
value | number | No description provided. |
SetSettingString
GameInterfaceAPI.SetSettingString(key: string, value: string): void
No description provided.
Parameters
| Name | Type | Description |
key | string | No description provided. |
value | string | No description provided. |
UnregisterGameEventHandler
GameInterfaceAPI.UnregisterGameEventHandler(callback: number): void
Unregisters a previously registered event handler for a game event
Parameter
| Name | Type | Description |
callback | number | No description provided. |