User Tools

Site Tools


global_event_scripts

Global Event Scripts


The Global Event Scripts tab, located in your Game Configuration, allows you to attach scripts to certain in-game events. Whenever the event described occurs, the assigned script will be immediately triggered. Refer to the table below for descriptions of the events that are currently supported.

IconEvent NameDescription
Camera Direction ChangesTriggered when the camera is rotated to a new cardinal direction (e.g. from NORTH to WEST), either by the player or a camera script. The script assigned to this event can check the camera's new direction using the camera.direction variable.
Player Character Levels UpTriggered when either the main player character or a party member levels up. The script assigned to this event can reference the character that leveled up using the self built-in variable.
Player is DefeatedTriggered when the main player character has been defeated, for example from a hazardous tile or real-time enemy damage. If desired, characters can be revived using the Revive Character function.
Character's Health ChangesTriggered when the health of any character changes. The script assigned to this event can reference the character whose health changed using the self built-in variable. The amount by which their health changed will be stored in the $amount local variable.
Character Enters a TileTriggered when any character enters a tile. The script assigned to this event can reference the tile that was entered using the self built-in variable. The character that entered the tile can be referenced using the initiator built-in variable.
Character Stops on a TileTriggered when any character stops on a tile. The script assigned to this event can reference the tile that was stopped on using the self built-in variable. The character that stopped on the tile can be referenced using the initiator built-in variable.
Character Exits a TileTriggered when any character exits a tile. The script assigned to this event can reference the tile that was exited using the self built-in variable. The character that exited the tile can be referenced using the initiator built-in variable.
Character is DamagedTriggered when any character receives damage. The script assigned to this event can reference the character that was damaged using the self built-in variable. The character that dealt the damage can be referenced using the initiator built-in variable. The $damage local variable will contain the amount of damage that was dealt.
Object is GrabbedTriggered when any character grabs a pushable object. The script assigned to this event can reference the object that was grabbed using the self built-in variable. The character that grabbed the object can be referenced using the initiator built-in variable.
Object is PushedTriggered when any character pushes a pushable object. The script assigned to this event can reference the object that was pushed using the self built-in variable. The character that pushed the object can be referenced using the initiator built-in variable. The $previous_tile and $target_tile local variables contain the tile from which the object was pushed and the new tile onto which the object is being pushed, respectively.
Object is ReleasedTriggered when any character releases a pushable object. The script assigned to this event can reference the object that was released using the self built-in variable. The character that released the object can be referenced using the initiator built-in variable.
Tool Item ChangesTriggered when the player's active tool changes. The script assigned to this event can reference the ID of the newly active tool item using the $item_id local variable. This variable will be null if no tool is active.
Quest GivenTriggered when the player is given a quest. The script assigned to this event can reference the ID of the quest that was given using the $quest_id local variable.
Quest CompletedTriggered when a quest has been completed. The script assigned to this event can reference the ID of the quest that was completed using the $quest_id local variable.
Quest FailedTriggered when a quest has been failed. The script assigned to this event can reference the ID of the quest that was failed using the $quest_id local variable.
global_event_scripts.txt · Last modified: 2022/12/13 21:43 by justin