Game logic - Entity label – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Ylands " to "[[Ylands:")
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
Entity label is a '''collection of entities'''. Entities can be easily added or removed from a label, either by editing the label properties or trough visual scripting instructions. It is possible to check whenever a entity is part of a label and utilize this information in a game script.
Entity label is a '''collection of entities'''. Entities can be easily added or removed from a label, either by editing the label properties or trough visual scripting instructions. It is possible to check whenever a entity is part of a label and utilize this information in a game script.


=Properties=
= Properties =
===Entities===
=== Entities ===
*List of entities belonging to current Label.
*List of entities belonging to current Label.
*Click '''+''' to add new entries and then use picker to select entity from scene.
*Click '''+''' to add new entries and then use picker to select entity from scene.


=Notes=
= Notes =
*Each entity can be part of any number of Labels.  
*Each entity can be part of any number of Labels.  
*It is possible to constrain [[Ylands Game logic - Trigger zone|'''Trigger Zone''']] to react only to entities with specific label.  
*It is possible to constrain [[Ylands:Game logic - Trigger zone|'''Trigger Zone''']] to react only to entities with specific label.  
*It is possible to constrain [[Ylands Game logic - Event listener|'''Event Listener''']] to listen events only on entities with specific Label.  
*It is possible to constrain [[Ylands:Game logic - Event listener|'''Event Listener''']] to listen events only on entities with specific Label.  
*Label collection is dynamic. It is possible to add/remove entities during play.
*Label collection is dynamic. It is possible to add/remove entities during play.
*New entities assigned trough script are put at the end of the list.
*New entities assigned trough script are put at the end of the list.
Line 16: Line 16:
*Any player after death/respawn is not removed from the world so he keeps himself in all associated Labels.
*Any player after death/respawn is not removed from the world so he keeps himself in all associated Labels.


=Entity label events=
= Entity label events =
*[[Ylands Tile - Entity label On Entity Added-Removed|On Entity Added / Removed]]
*[[Ylands:Tile - Entity label On Entity Added-Removed|On Entity Added / Removed]]
*[[Ylands Tile - Entity label On Count Changed|On Count Changed]]
*[[Ylands:Tile - Entity label On Count Changed|On Count Changed]]


=Related instructions=
= Related instructions =
===Entity label===
=== Entity label ===
*[[Ylands Tile - Add-Remove entity to label|Add / Remove entity]]
*[[Ylands:Tile - Add-Remove entity to label|Add / Remove entity]]
*[[Ylands Tile - Get label entities|Get entities]]
*[[Ylands:Tile - Get label entities|Get entities]]
*[[Ylands Tile - Get label entity count|Get entity count]]
*[[Ylands:Tile - Get label entity count|Get entity count]]


===Entities===
=== Entities ===
*[[Ylands Tile - Attach-Remove entity label|Attach / Remove entity label]]
*[[Ylands:Tile - Attach-Remove entity label|Attach / Remove entity label]]
*[[Ylands Tile - Get entity labels|Get entity labels]]
*[[Ylands:Tile - Get entity labels|Get entity labels]]
*[[Ylands Tile - Has entity label| Has entity label]]
*[[Ylands:Tile - Has entity label| Has entity label]]




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:Entity label}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|19}}}}


[[Category: Game Logic]]
[[Category: Game Logic]]
[[Category: Ylands 0.10]]
[[Category: Ylands 0.10]]

Revision as of 17:36, 16 November 2022

Description

Entity label is a collection of entities. Entities can be easily added or removed from a label, either by editing the label properties or trough visual scripting instructions. It is possible to check whenever a entity is part of a label and utilize this information in a game script.

Properties

Entities

  • List of entities belonging to current Label.
  • Click + to add new entries and then use picker to select entity from scene.

Notes

  • Each entity can be part of any number of Labels.
  • It is possible to constrain Trigger Zone to react only to entities with specific label.
  • It is possible to constrain Event Listener to listen events only on entities with specific Label.
  • Label collection is dynamic. It is possible to add/remove entities during play.
  • New entities assigned trough script are put at the end of the list.
  • Entities removed from the world (destroyed/exchanged for a corpse) will remove themselves from associated Labels automatically.
  • Any player after death/respawn is not removed from the world so he keeps himself in all associated Labels.

Entity label events

Related instructions

Entity label

Entities