Triggers

Triggers are map elements that cause certain events to occur when an actor enters it.

Example trigger

Rotation element is optional in every trigger element

<trigger type="<trigger_type>">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Death

Player will die.

<trigger type="death">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Win

Deprecated in triggers 2.0 in favor of the screen trigger

Player will win current map and new (next) map will be loaded.

<trigger type="win">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Radiation

Decrease player health over time.

<trigger type="radiation" intensity="1">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Audio

Play a audio track, loop attribute of triger element is optional, by default it is false

• loop attribute (boolean) of element trigger is optional, by default it is false
• file (mandatory) attribute is the file path relative to the packages data path where /audio is implied
• music (boolean) for this trigger will use the music volume for this audio file default is false

<trigger type="audio" loop="true" file="track1">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Map

Load new map

• file (mandatory) attribute is the file path relative to the packages data path where /maps and the .xml ending is implied

<trigger type="map" file="map name">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Screen

Load screen

• file (mandatory) attribute is the file path relative to the packages data path where /screens and the .xml ending is implied

<trigger type="screen" file="screen name">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Destination

Is used to reference position for checkpoints and player teleportation

<destination name="destination1">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
</destination>

Checkpoint

• destination (mandatory) destination where the player will spawn when reset to checkpoint

Respawns the player at position specified by destination on death. Rotation subelement of trigger (optional) determines rotation of trigger box, rotation subelement

<trigger type="checkpoint" destination="destination name">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Remove

Toggle means that triggering a second time will reverse the action. When action is set to true the action key has to be pressed in order for the trigger to fire.

<trigger type="remove" toggle="true" action="true" ref="wall-name">
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Teleport

• destination (mandatory) the destination that the teleport is linked to

<trigger type="teleport" destination="destination1">
  <position x="5.25" y="-3" z="5"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>

Scripts

• This trigger is still a draft

<trigger type="script" callback="jump()">
  <code>
    fun jump(){
      smooth(player.position.y, 3);
    }
  </code>
  <position x="5.25" y="-3" z="5"/>
  <rotation x="0" y="0" z="0"/>
  <scale x="0.5" y="4.0" z="4.0"/>
</trigger>