On Map Jump

Signature

u32 onMapJump(u32 locationId, u32 posIndex, u32 flags, u32 unknown)

Description

Fires when a location is entered.

Arguments

Location Identifier

The identifier of the location.

Position Index

Determines at which position the party will spawn. In some locations, it can also have additional effects such as a foe spawning or not (e.g. trial stage).

If a value of -1 is passed, it will be changed to that of telepoIndex in the location script (ebp section 0).

If a value of -2 is passed, it will be changed to that of saveIndex in the location script (ebp section 0).

If a value of -3 is passed, it will be changed to that of anchorIndex in the location script (ebp section 0).

Flags

Controls fade out and teleport animation.

Bit	Name	Description
0	No Fade Out	Do not use a fade out.
1	Fade Out Color	Use black (0) or white (1) as fade out color.
2	Default Fadeout Time	Use default fade out duration instead of 0,8 seconds.
3	Teleport Animation	Use teleport animation on arrival.

Unknown

The purpose of this argument is unknown.

Notes

Starting a new game or loading a save game does not trigger a map jump, even though the location technically changes.

For a list of location identifiers, you can view the location spreadsheet in Resources.