Game logic - Trigger zone – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Ylands editor navbox}}" to "{{Navbox/Ylands}}")
m (Text replacement - " (={2,})([^ = ])(.*)([^ = ])(={2,}) * " to " $1 $2$3$4 $5 ")
Line 5: Line 5:
[[File:{{PAGENAME}}.png|right|400px|Properties]]
[[File:{{PAGENAME}}.png|right|400px|Properties]]


===Enabled===
=== Enabled ===
*Trigger will not fire if not enabled.
*Trigger will not fire if not enabled.


===Animated===
=== Animated ===
*Allows to change Trigger Zone [[Ylands Tile - Game logic position-rotation-scale|'''position / rotation / scale''']] in real time.
*Allows to change Trigger Zone [[Ylands Tile - Game logic position-rotation-scale|'''position / rotation / scale''']] in real time.
*Due to technical limitations '''dynamic''' zones are '''limited''' to:
*Due to technical limitations '''dynamic''' zones are '''limited''' to:
Line 15: Line 15:
**Labeled entities.
**Labeled entities.


===Zone shape===  
=== Zone shape ===
*Shape of the trigger zone - box, sphere or capsule
*Shape of the trigger zone - box, sphere or capsule


===Radius / Dimensions===
=== Radius / Dimensions ===
*Size of the Trigger Zone boundaries.
*Size of the Trigger Zone boundaries.


===Visible===
=== Visible ===
*Makes the Trigger zone boundaries visible even in game.
*Makes the Trigger zone boundaries visible even in game.


===Color===
=== Color ===
*Color of Trigger zone boundaries (when visible).
*Color of Trigger zone boundaries (when visible).


===Is triggered by===  
=== Is triggered by ===
*Setup what kind of entity passing the area will fire the trigger.
*Setup what kind of entity passing the area will fire the trigger.
**'''Any''' animal / item / player / projectile etc.
**'''Any''' animal / item / player / projectile etc.
Line 35: Line 35:
**'''Player role''' - will react to players of specific [[Ylands Game logic - Player role|'''role''']].
**'''Player role''' - will react to players of specific [[Ylands Game logic - Player role|'''role''']].


===Perform===  
=== Perform ===
*Governs if the trigger will react to incoming / exiting entity if there is already another entity in the zone. That entity must meet trigger rules (e.g if trigger is set to "ANY PLAYER" animals and other types will not block the trigger).
*Governs if the trigger will react to incoming / exiting entity if there is already another entity in the zone. That entity must meet trigger rules (e.g if trigger is set to "ANY PLAYER" animals and other types will not block the trigger).


===Times triggered===  
=== Times triggered ===
*Number of times trigger can be fired, -1 sets to infinite. Entering and leaving trigger always removes one use (they do not count separately).
*Number of times trigger can be fired, -1 sets to infinite. Entering and leaving trigger always removes one use (they do not count separately).



Revision as of 19:07, 31 January 2021

Description

Trigger which fires when a object enters or exits its bounding area.

Properties

Enabled

  • Trigger will not fire if not enabled.

Animated

  • Allows to change Trigger Zone position / rotation / scale in real time.
  • Due to technical limitations dynamic zones are limited to:
    • Players.
    • Specific entities.
    • Labeled entities.

Zone shape

  • Shape of the trigger zone - box, sphere or capsule

Radius / Dimensions

  • Size of the Trigger Zone boundaries.

Visible

  • Makes the Trigger zone boundaries visible even in game.

Color

  • Color of Trigger zone boundaries (when visible).

Is triggered by

  • Setup what kind of entity passing the area will fire the trigger.
    • Any animal / item / player / projectile etc.
    • Entity type - after picking an entity, any instance of this entity will fire trigger.
    • Specific entity - after picking an entity, only this specific instance (ID) will fire trigger.
    • Labeled entities - will trigger only if trigger entity will be member of given label.
    • Player role - will react to players of specific role.

Perform

  • Governs if the trigger will react to incoming / exiting entity if there is already another entity in the zone. That entity must meet trigger rules (e.g if trigger is set to "ANY PLAYER" animals and other types will not block the trigger).

Times triggered

  • Number of times trigger can be fired, -1 sets to infinite. Entering and leaving trigger always removes one use (they do not count separately).

Trigger zone events

Notes

  • Enabled and Visible properties are independent on each other, meaning that is is possible to display even inactive Trigger zone.

Related instructions