Script
┗> Event > Object > Class
Scripts are Overworld events that trigger immediately when the player steps into them.
Naming an object script on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object.
Constructor
Script(x: number, y: number, shape: number, properties: number)
Arguments:
| x: number | |
| y: number | |
| shape: number | |
| properties: number |
Methods
Script:onAdd(parent: Event|World)
Arguments:
| parent: Event|World | The |
Script:onEnter(chara: Player)
Arguments:
| chara: Player | The character controlled by the player when in the Overworld. |
Returns:
| 1: boolean |
Fields
Script.cutscene: string
[Property cutscene] The name of a cutscene to start when this script is triggered
Script.once: boolean
[Property once] Whether this script can only be triggered once per save file (Defaults to true)
Script.script: string
[Property script] The name of a script file to run when this script is triggered
Script.set_flag: string
[Property setflag] The name of a flag to set the value of when this script is triggered
Script.set_value: any
[Property setvalue] The value to set on the flag specified by set_flag (Defaults to true)
Script.temp: boolean
[Property temp] Whether the script is temporarily persistent - appears even if once is true and it has been triggered (Defaults to false)