Behavior element behavior adding trigger support. More...
Classes | |
| class | BlockListenerFactory |
| Factory creating listeners using block. More... | |
| class | BooleanListener |
| Implementation of behavior instance listener using BooleanBehaviorListener. More... | |
| class | DefaultListener |
| Default implementation of behavior instance listener. More... | |
| class | Instance |
| Behavior instance. More... | |
| interface | Listener |
| Listener for behavior instance events. More... | |
| interface | ListenerFactory |
| Factory creating listeners. More... | |
Public Member Functions | |
| void | addListenerFactory (Block blockFactory) |
| Add listener factory using block. More... | |
| void | addListenerFactory (ListenerFactory factory) |
| Add listener factory. More... | |
| void | createListeners (Instance instance) |
| Create listeners from factories adding them to behavior instance. More... | |
| void | dispose () |
| Dispose of behavior. More... | |
| void | forEachListenerFactory (Block ablock) |
| Visit listener factories with block with argument ListenerFactory. More... | |
| ECPString | getTrigger () |
| Trigger. More... | |
| TSTriggerTable | getTriggerTable () |
| Trigger table. More... | |
| ECBehaviorTriggered | new (BehaviorElementClass eclass) |
| Create behavior element class. More... | |
| ECBehaviorTriggered | new (BehaviorElementClass eclass, String id) |
| Create behavior element class. More... | |
| ECBehaviorTriggered | new (BehaviorElementClass eclass, TSTriggerTable triggerTable) |
| Create behavior element class. More... | |
| ECBehaviorTriggered | new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id) |
| Create behavior element class. More... | |
| ECBehaviorTriggered | new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id, String propertyName) |
 Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior | |
| void | assignInstanceIndex (int instanceIndex) |
| Assign instance index. More... | |
| String | getBehaviorID () |
| Unique identifier of behavior. More... | |
| String | getID () |
| Identifier. More... | |
| int | getInstanceIndex () |
| Instance index. More... | |
| void | loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance) |
| Load instance data of another behavior. More... | |
| bool | supportsBehaviorID (String identifier) |
| Behavior supports loading instance data of another behavior. More... | |
| Public Member Functions inherited from Dragengine.Scenery.ECBehavior | |
| ECBehaviorInstance | createInstance (BehaviorElement element) |
| Create Behavior instance. More... | |
Static Public Member Functions | |
| static ECBehaviorTriggered | getBehaviorIn (BehaviorElementClass eclass) |
| Get behavior in element class or null if absent. More... | |
Public Attributes | |
| Array | pListenerFactories |
| ECPString | pTrigger |
| TSTriggerTable | pTriggerTable |
Protected Member Functions | |
| void | setTriggerTable (TSTriggerTable triggerTable) |
| Set trigger table. More... | |
| Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior | |
| void | setBehaviorID (String identifier) |
| Set behavior identifier. More... | |
| void | useClassNameAsBehaviorID () |
| Set behavior identifier to "<class-name>:<identifier>". More... | |
| void | useFullyQualifiedClassNameAsBehaviorID () |
| Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More... | |
Detailed Description
Behavior element behavior adding trigger support.
Adds a trigger expression to the behavior element. If the trigger expression changes value notifies the behavior element or other behaviors using listeners.
The default stub property name for the trigger expression is "trigger" if ID is empty or "{id}.trigger" if the ID is not empty. The stub property name can be changed which is typically done by ECBehavior using ECBehaviorTriggered in a composed way.
The initial state of the element is "false". If the element is added to the game world notifyListeners() is only called if the trigger expression is "true" at this time.
Element class property is named "trigger{(id)}".
This behavior does not require the element class to be persistable (setPersistable).
Member Function Documentation
◆ addListenerFactory() [1/2]
| void Dragengine.Scenery.ECBehaviorTriggered.addListenerFactory | ( | Block | blockFactory | ) |
◆ addListenerFactory() [2/2]
| void Dragengine.Scenery.ECBehaviorTriggered.addListenerFactory | ( | ListenerFactory | factory | ) |
Add listener factory.
◆ createListeners()
| void Dragengine.Scenery.ECBehaviorTriggered.createListeners | ( | Instance | instance | ) |
Create listeners from factories adding them to behavior instance.
◆ dispose()
| void Dragengine.Scenery.ECBehaviorTriggered.dispose | ( | ) |
Dispose of behavior.
Reimplemented from Dragengine.Scenery.DefaultECBehavior.
◆ forEachListenerFactory()
| void Dragengine.Scenery.ECBehaviorTriggered.forEachListenerFactory | ( | Block | ablock | ) |
Visit listener factories with block with argument ListenerFactory.
◆ getBehaviorIn()
|
static |
Get behavior in element class or null if absent.
Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.
◆ getTrigger()
| ECPString Dragengine.Scenery.ECBehaviorTriggered.getTrigger | ( | ) |
Trigger.
◆ getTriggerTable()
| TSTriggerTable Dragengine.Scenery.ECBehaviorTriggered.getTriggerTable | ( | ) |
Trigger table.
◆ new() [1/5]
| ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.new | ( | BehaviorElementClass | eclass | ) |
Create behavior element class.
Reimplemented from Dragengine.Scenery.DefaultECBehavior.
◆ new() [2/5]
| ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.new | ( | BehaviorElementClass | eclass, |
| String | id | ||
| ) |
Create behavior element class.
Reimplemented from Dragengine.Scenery.DefaultECBehavior.
◆ new() [3/5]
| ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.new | ( | BehaviorElementClass | eclass, |
| TSTriggerTable | triggerTable | ||
| ) |
Create behavior element class.
◆ new() [4/5]
| ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.new | ( | BehaviorElementClass | eclass, |
| TSTriggerTable | triggerTable, | ||
| String | id | ||
| ) |
Create behavior element class.
◆ new() [5/5]
| ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.new | ( | BehaviorElementClass | eclass, |
| TSTriggerTable | triggerTable, | ||
| String | id, | ||
| String | propertyName | ||
| ) |
◆ setTriggerTable()
|
protected |
Set trigger table.
Member Data Documentation
◆ pListenerFactories
| Array Dragengine.Scenery.ECBehaviorTriggered.pListenerFactories |
◆ pTrigger
| ECPString Dragengine.Scenery.ECBehaviorTriggered.pTrigger |
◆ pTriggerTable
| TSTriggerTable Dragengine.Scenery.ECBehaviorTriggered.pTriggerTable |
The documentation for this class was generated from the following file:
