Teleport Location

Signature

teleportLocation(locationId, positionIndex)

Description

Teleports the party to a location.

The teleport includes an animation, a sound effect, and a white fade in and out.

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).

Notes

You should only teleport to a location that is already accessible by the party. Otherwise it can cause issues such as triggering a cutscene that messes with the player's story progress, and more.

This function is run asynchronously and will not block code execution until it's completed. If it's executed while another instance of it is already running, it will just return instead.

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