SetFlagEvent
┗> Event > Object > Class
An Overworld region that sets a flag when the player steps into it.
SetFlagEvent is an Event - naming an object setflag on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object.
Constructor
SetFlagEvent(x: number, y: number, shape: number, properties: number)
Arguments:
| x: number | |
| y: number | |
| shape: number | |
| properties: number |
Methods
SetFlagEvent:onEnter(chara: Player)
Arguments:
| chara: Player | The character controlled by the player when in the Overworld. |
Returns:
| 1: boolean|nil |
Fields
SetFlagEvent.flag: string
[Property flag] The name of the flag to set a value on
SetFlagEvent.map_flag: boolean
[Property mapflag] Whether or not the flag is localized to the current map (Defaults to false, meaning the flag is global)
SetFlagEvent.once: boolean
[Property once] Whether the flag can only be set by this region once (Defaults to false)
SetFlagEvent.value: any
[Property value] The value to set on the flag