Game logic - Event listener – 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 4: Line 4:
=Properties=
=Properties=
[[File:{{PAGENAME}}.png|right|400px|Properties]]
[[File:{{PAGENAME}}.png|right|400px|Properties]]
===Enabled===  
=== Enabled ===
*Defines whenever the trigger is activated or not.
*Defines whenever the trigger is activated or not.


===Execution limit===  
=== Execution limit ===
*Number of times event listener can be triggered, -1 sets to infinite.
*Number of times event listener can be triggered, -1 sets to infinite.


===Listen for===
=== Listen for ===
*Type of event to listen for, supported events are:
*Type of event to listen for, supported events are:
**'''Interaction with entity''' - Waits for a interaction occurring on target entity regardless the instigator.
**'''Interaction with entity''' - Waits for a interaction occurring on target entity regardless the instigator.
Line 17: Line 17:
**'''Player interaction with 2 entities''' - Special variant for events with 2 targets (e.g. Link / Unlink energy)
**'''Player interaction with 2 entities''' - Special variant for events with 2 targets (e.g. Link / Unlink energy)


===Instigated by===
=== Instigated by ===
*Available for player interactions.
*Available for player interactions.
*Distinguishes who can trigger the listener:
*Distinguishes who can trigger the listener:
Line 25: Line 25:
**'''Player team''' - only players of specific [Ylands Game logic - Player team|player team]] will trigger the listener
**'''Player team''' - only players of specific [Ylands Game logic - Player team|player team]] will trigger the listener


===Target===
=== Target ===
*Specifies the source of event the listener is waiting for.
*Specifies the source of event the listener is waiting for.
**'''Any entity''' - any entity.
**'''Any entity''' - any entity.
Line 33: Line 33:
**'''Labeled entities''' -  any entity with selected [[Ylands Game logic - Entity label|entity label]].
**'''Labeled entities''' -  any entity with selected [[Ylands Game logic - Entity label|entity label]].


===Events===  
=== Events ===
*Defines which actions / interactions (events) the listener will wait for. It is possible to set listener to react to more that 1 event.
*Defines which actions / interactions (events) the listener will wait for. It is possible to set listener to react to more that 1 event.



Revision as of 20:09, 31 January 2021

Description

Event listener is a special trigger, which is waiting for certain event to occur and then triggers.

Properties

Enabled

  • Defines whenever the trigger is activated or not.

Execution limit

  • Number of times event listener can be triggered, -1 sets to infinite.

Listen for

  • Type of event to listen for, supported events are:
    • Interaction with entity - Waits for a interaction occurring on target entity regardless the instigator.
    • Player action - Waits for specific player action (e.g On Jump)
    • Player interaction with entity - Adds possibility to disgusting who can trigger the listener.
    • Player interaction with 2 entities - Special variant for events with 2 targets (e.g. Link / Unlink energy)

Instigated by

  • Available for player interactions.
  • Distinguishes who can trigger the listener:
    • Any player - any player will trigger the listener
    • Labeled player - player with specific entity label
    • Player role - only players with specific player role will trigger the listener
    • Player team - only players of specific [Ylands Game logic - Player team|player team]] will trigger the listener

Target

  • Specifies the source of event the listener is waiting for.
    • Any entity - any entity.
    • Entity class - specific entity class as selected from drop down menu.
    • Entity type - specific entity type, type is defined by picking an entity from scene, entity can be then deleted.
    • Specific entity - one selected entity.
    • Labeled entities - any entity with selected entity label.

Events

  • Defines which actions / interactions (events) the listener will wait for. It is possible to set listener to react to more that 1 event.

Event listener events

Related instructions