Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorTimer Class Reference

Behavior element behavior timer trigger target. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorTimer:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  BlockListenerFactory
 Factory creating listeners using block. 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...
 
ECPBoolean getCancelOnReset ()
 Trigger timer is cancelled if trigger expression evaluates to false. More...
 
ECPBoolean getFireOnTimeout ()
 Target is fired (true) or reset (false) after timeout elapses. More...
 
ECPBoolean getFullReset ()
 Full reset target instead of simple reset. More...
 
ECPBoolean getPulse ()
 Pulse target if timeout elapses. More...
 
ECPBoolean getStartActivated ()
 Trigger starts out activated. More...
 
ECPString getTarget ()
 Trigger target to operate. More...
 
ECPFloat getTimeout ()
 Time in seconds until target is fired/reset after expression becomes true. More...
 
ECPBoolean getTimeoutRearm ()
 Rearm trigger on timeout if still enabled. More...
 
ECPFloat getTimeoutSpread ()
 Random timeout spread in seconds. More...
 
ECBehaviorTriggered getTriggered ()
 Trigger to start timer. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table or null if not used. More...
 
ECBehaviorTimer new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorTimer new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
ECBehaviorTimer new (BehaviorElementClass eclass, TSTriggerTable triggerTable)
 
ECBehaviorTimer new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id)
 
ECBehaviorTimer new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id, String subID)
 
ECBehaviorTimer new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id, String subID, String prefix)
 
- 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 ECBehaviorTimer getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Protected Member Functions

void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table or null if not used. 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 timer trigger target.

Fires or resets trigger target after timeout after evaluation state of trigger expression changes to true.

Element class properties have the prefix "timer{(id)}.".

This behavior does require the element class to be persistable (setPersistable).

Member Function Documentation

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorTimer.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorTimer.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createListeners()

void Dragengine.Scenery.ECBehaviorTimer.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ dispose()

void Dragengine.Scenery.ECBehaviorTimer.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorTimer.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

static ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.getBehaviorIn ( BehaviorElementClass  eclass)
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.

◆ getCancelOnReset()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getCancelOnReset ( )

Trigger timer is cancelled if trigger expression evaluates to false.

◆ getFireOnTimeout()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getFireOnTimeout ( )

Target is fired (true) or reset (false) after timeout elapses.

◆ getFullReset()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getFullReset ( )

Full reset target instead of simple reset.

◆ getPulse()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getPulse ( )

Pulse target if timeout elapses.

If FireOnTimeout is true invokes fire() then reset()/fullReset() on the target. If FireOnTimeout is false invokes reset()/fullReset() then fire() on the target. Using pulse avoids the need to use two TriggerTimer to trigger a target multiple times in a row.

◆ getStartActivated()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getStartActivated ( )

Trigger starts out activated.

◆ getTarget()

ECPString Dragengine.Scenery.ECBehaviorTimer.getTarget ( )

Trigger target to operate.

◆ getTimeout()

ECPFloat Dragengine.Scenery.ECBehaviorTimer.getTimeout ( )

Time in seconds until target is fired/reset after expression becomes true.

◆ getTimeoutRearm()

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.getTimeoutRearm ( )

Rearm trigger on timeout if still enabled.

Version
1.12

◆ getTimeoutSpread()

ECPFloat Dragengine.Scenery.ECBehaviorTimer.getTimeoutSpread ( )

Random timeout spread in seconds.

Version
1.12

Timeout spread is added to regular timeout. Timeout is chosen randomly between -spread to spread seconds. Hence random timeout spreads the chosen time above and below the regular timeout up to "spread" seconds.

◆ getTriggered()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTimer.getTriggered ( )

Trigger to start timer.

◆ getTriggerTable()

TSTriggerTable Dragengine.Scenery.ECBehaviorTimer.getTriggerTable ( )

Trigger table or null if not used.

◆ new() [1/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass,
String  id 
)

Create default composeable behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [3/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable 
)

◆ new() [4/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
String  id 
)

◆ new() [5/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
String  id,
String  subID 
)

◆ new() [6/6]

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.new ( BehaviorElementClass  eclass,
TSTriggerTable  triggerTable,
String  id,
String  subID,
String  prefix 
)

◆ setTriggerTable()

void Dragengine.Scenery.ECBehaviorTimer.setTriggerTable ( TSTriggerTable  triggerTable)
protected

Set trigger table or null if not used.


The documentation for this class was generated from the following file: