Dragengine.Scenery.ECBehaviorTimer Class Reference

Behavior element behavior timer trigger target. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorTimer:

Classes
class	BlockListenerFactory
	Factory creating listeners using block. More...
class	DefaultListener
	Default implementation of behavior instance listener. More...
class	Factory
	Behavior factory. 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.
void	addListenerFactory (ListenerFactory factory)
	Add listener factory.
void	createListeners (Instance instance)
	Create listeners from factories adding them to behavior instance.
void	dispose ()
	Dispose of behavior.
void	forEachListenerFactory (Block ablock)
	Visit listener factories with block with argument ListenerFactory.
ECComposeBTSM	getBTSMs ()
	Compose behavior trees and state machines.
ECPBoolean	getCancelOnReset ()
	Trigger timer is cancelled if trigger expression evaluates to false.
ECPBoolean	getFireOnTimeout ()
	Target is fired (true) or reset (false) after timeout elapses.
ECPBoolean	getFullReset ()
	Full reset target instead of simple reset.
String	getPrefix ()
	Prefix.
ECPBoolean	getPulse ()
	Pulse target if timeout elapses.
ECPBoolean	getStartActivated ()
	Trigger starts out activated.
ECPString	getTarget ()
	Trigger target to operate.
ECPFloat	getTimeout ()
	Time in seconds until target is fired/reset after expression becomes true.
ECPBoolean	getTimeoutRearm ()
	Rearm trigger on timeout if still enabled.
ECPFloat	getTimeoutSpread ()
	Random timeout spread in seconds.
ECBehaviorTriggered	getTriggered ()
	Trigger to start timer.
TSTriggerTable	getTriggerTable ()
	Trigger table or null if not used.
ECBehaviorTimer	new (BehaviorElementClass eclass)
	Create behavior element class.
ECBehaviorTimer	new (BehaviorElementClass eclass, String id)
	Create default composeable behavior.
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.
String	getBehaviorID ()
	Unique identifier of behavior.
String	getID ()
	Identifier.
int	getInstanceIndex ()
	Instance index.
void	loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
	Load instance data of another behavior.
bool	supportsBehaviorID (String identifier)
	Behavior supports loading instance data of another behavior.
Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance	createInstance (BehaviorElement element)
	Create Behavior instance.

Static Public Member Functions
static ECBehaviorTimer	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECComposeBTSM	pBTSMs
Array	pListenerFactories
String	pPrefix
ECPString	pTarget
ECPFloat	pTimeout
ECPBoolean	pTimeoutRearm
ECBehaviorTriggered	pTriggered
TSTriggerTable	pTriggerTable

Protected Member Functions
void	setTriggerTable (TSTriggerTable triggerTable)
	Set trigger table or null if not used.
Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void	setBehaviorID (String identifier)
	Set behavior identifier.
void	useClassNameAsBehaviorID ()
	Set behavior identifier to "<class-name>:<identifier>".
void	useFullyQualifiedClassNameAsBehaviorID ()
	Set behavior identifier to "<fully-qualified-class-name>:<identifier>".

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).

See also

https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_timer

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.

getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorTimer.getBTSMs

(

)

Compose behavior trees and state machines.

Version

1.26

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.

getPrefix()

String Dragengine.Scenery.ECBehaviorTimer.getPrefix

(

)

Prefix.

Version

1.26

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.

Member Data Documentation

pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorTimer.pBTSMs

pListenerFactories

Array Dragengine.Scenery.ECBehaviorTimer.pListenerFactories

pPrefix

String Dragengine.Scenery.ECBehaviorTimer.pPrefix

pTarget

ECPString Dragengine.Scenery.ECBehaviorTimer.pTarget

pTimeout

ECPFloat Dragengine.Scenery.ECBehaviorTimer.pTimeout

pTimeoutRearm

ECPBoolean Dragengine.Scenery.ECBehaviorTimer.pTimeoutRearm

pTriggered

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTimer.pTriggered

pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorTimer.pTriggerTable

---

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

• ECBehaviorTimer.ds