Game logic - Trigger zone – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Ylands " to "[[Ylands:")
m (Some wiki formatting)
Line 1: Line 1:
=Description=
= Description =
Trigger which fires when a object enters or exits its bounding area.
Trigger which fires when a object enters or exits its bounding area.


Line 9: Line 9:


=== Animated ===
=== Animated ===
*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:
* Allows to change Trigger Zone [[Ylands:Tile - Game logic position-rotation-scale|'''position / rotation / scale''']] in real time.
**Players.
* Due to technical limitations '''dynamic''' zones are '''limited''' to:
**Specific entities.
** Players.
**Labeled entities.
** Specific 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.
 
**'''Any''' animal / item / player / projectile etc.
* Setup what kind of entity passing the area will fire the trigger.
**'''Entity type''' - after picking an entity, any instance of this entity will fire trigger.
** '''Any''' animal / item / player / projectile etc.
**'''Specific entity''' - after picking an entity, only this specific instance (ID) will fire trigger.
** '''Entity type''' - after picking an entity, any instance of this entity will fire trigger.
**'''Labeled entities''' - will trigger only if trigger entity will be member of given [[Ylands:Game logic - Entity label|'''label''']].
** '''Specific entity''' - after picking an entity, only this specific instance (ID) will fire trigger.
**'''Player role''' - will react to players of specific [[Ylands:Game logic - Player role|'''role''']].
** '''Labeled entities''' - will trigger only if trigger entity will be member of given [[Ylands:Game logic - Entity label|'''label''']].
** '''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).


= Trigger zone events =
= Trigger zone events =
*[[Ylands:Tile - On Trigger Enter-Exit|On Trigger Enter / Exit]]
 
* [[Ylands:Tile - On Trigger Enter-Exit|On Trigger Enter / Exit]]


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


= Related instructions =
= Related instructions =
*[[Ylands:Tile - Game logic enabled|Get / Set Enabled]]
 
*[[Ylands:Tile - Game logic position-rotation-scale|Get Position / Rotation / Scale]]
* [[Ylands:Tile - Game logic enabled|Get / Set Enabled]]
*[[Ylands:Tile - Reset trigger zone|Reset Trigger]]
* [[Ylands:Tile - Game logic position-rotation-scale|Get Position / Rotation / Scale]]
*[[Ylands:Tile - Get-Set zone visible|Get / Set Zone Visibility]]
* [[Ylands:Tile - Reset trigger zone|Reset Trigger]]
*[[Ylands:Tile - Get-Set zone color|Get / Set Zone Color]]
* [[Ylands:Tile - Get-Set zone visible|Get / Set Zone Visibility]]
* [[Ylands:Tile - Get-Set zone color|Get / Set Zone Color]]




Revision as of 22:54, 20 November 2023

Description

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

Properties

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


Ylands - Editor
Editor

Animated objects, Custom UI, Entity welding, Game export, Game ID, Monetization, MIDI music, Optimizations, Common Problems, FAQ

Script

Introduction, Conventions, Client script, Text scripting, Custom controls, Custom controller, Storage Data, Game set, Leaderboards, Matchmaking, Map markers

Game logic

AI Behaviour, Ask Player, Controller, Custom Camera, Custom Controls, Custom HUD, Custom Window, Data Set, Dialogue, Entity Label, Entity Storage, Entity Template, Environment, Event Listener, Game Logic Label, Game Logic Storage, Game Logic Template, Global Storage, Group Template, Image Library, Impassable Barrier, Light, Melee Attack Effect, Particle Effect, Particle Template, Path, Play Area, Player Role, Player Team, Position Animator, Post Process, Reference Point, Resource, Rotation Animator, Script Module, Skill, Sound Effect, Spawn Point, Time Trigger, Transaction, Trigger Zone, Voice Chat Channel, Water Volume

Script tiles

Game, Entities, Game Logic, Logic, Loops, Instructions, Number, Vector, Color, String, Array

Misc

WIKI FAQ

Retrieved from "https://community.bistudio.com/wiki?title=Ylands:Game_logic_-_Trigger_zone&oldid=349696"