Basics

Common Scripting

Here is an (incomplete) list of the most commmon scripting elements.

Triggers

Name	RequestPartnerHelp
When	The player clicks on the guide character help button

Name	InspectObject
When	The player inspects an object that is not currently locked in the scene.
Arguments	objectId (identifier): The id of the object clicked

Name	Talk
When	The player clicks on a character in the scene
Who	The character specified by the clickable object
Arguments	objectId (identifier): The id of the object clicked

Name	InteractObject
When	The player clicks on an interactable object in the scene.
Arguments	objectId (identifier): The id of the object clicked
	locked (boolean): Whether or not the object is set as locked.
	(Optional) target (identifier): Character or Map id for the interactable object

Name	SceneStart
When	The player clicks on the guide character help button

Name	ViewEnter
When	The player enters a view (ex. the shop view, the job view)
Arguments	viewId (identifier): The id of the view

Variables

Name	scene:name
Description	Name of the currently loaded scene
Type	identifier

Name	scene:mapId
Description	Name of the currently loaded map
Type	identifier

Name	scene:lastEntrance
Description	Name of the last entrance the player took into the current scene
Type	identifier

Name	guide:help.requests
Description	Number of times the player has requested help from the guide character
Type	integer

Name	temp:interact.object
Description	The identifier of the object currently displayed with the contextual interaction prompt
Type	identifier

Name	temp:view
Description	The identifier of the current view
Type	identifier

Methods

Name	LoadScene(sceneId, entrance?)
Purpose	Loads into the given scene.
Arguments	sceneId (identifier): Name of the scene to load.
	(Optional) entrance (identifier): Name of the entrance to load the player to.