Transition

┗> Event > Object > Class


This object is used to create transitions in the Overworld to shops or other maps.
Transition is an Event - Naming an object transition on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object.


Constructor


Transition(x: number, y: number, shape: number, properties: TransitionProperties)

Arguments:

x: number
y: number
shape: number
properties: TransitionProperties




Methods




Transition:onEnter(chara: Player)

Arguments:

chara: Player

The character controlled by the player when in the Overworld.




Fields


Transition.exit_delay: number

[Property exit_delay] Additional delay after entering the new map before playing the exit sound, in seconds (Defaults to 0)


Transition.exit_pitch: number

[Property exit_pitch] The pitch the exit sound should play at


Transition.exit_sound: string?

[Property exit_sound] An optional sound to play when entering the new map


Transition.pitch: number

[Property pitch] The pitch the entry sound should play at


Transition.sound: string?

[Property sound] An optional sound to play when the player activates this transition


Transition.target: string, shop

The target of this transition:
[Property map] The name of the map to send the player to
OR [Property shop] The name of the shop to send the player to

[Property x] The x co-ordinate the player should appear at in the new map
AND [Property y] The y-co-ordinate the player should appear at in the new map
OR [Property marker] The name of the marker to spawn the player at in the new map

[Property facing] The direction the player and party should face when they spawn in the new map