Change Location Step

Moves the player to a different location on the world map.

Interface

interface ChangeLocationStep {
  kind: 'location';
  condition?: string;
  location: string;
  updatePlayerLocation?: boolean;
}

Properties

kind - Always 'location'

location - Name of destination location.

condition (optional) - Flag expression that must evaluate to true for the step to execute.

updatePlayerLocation (optional) - Whether to update the player’s current location.

Examples

Temporary location change for duration of event

{
  kind: 'changeLocation',
  location: 'Sect Grounds'
}

Actual Location Change

{
  kind: 'location',
  location: 'Mountain Peak',
  updatePlayerLocation: true
}

Conditional Travel

{
  kind: 'location',
  condition: 'has_travel_pass == 1',
  location: 'Forbidden Valley',
  updatePlayerLocation: true
}