Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorTimer.Instance:

Public Member Functions
void	addToGameWorld ()
	Add element to game world.

void	armTimer ()
	Arm timer if timeout is larger than 0 otherwise operate target immediately.

void	dispose ()
	Dispose of composeable instance.

bool	getCancelOnReset ()
	Trigger timer is cancelled if trigger expression evaluates to false.

ECBehaviorTimer	getECBehavior ()
	Behavior.

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

bool	getFullReset ()
	Full reset target instead of simple reset.

bool	getPulse ()
	Pulse target if timeout elapses.

float	getRemainingTime ()
	Remaining time until timeout.

bool	getStartActivated ()
	Trigger starts out activated.

TSNamedTriggerTarget	getTarget ()
	Trigger target or null.

float	getTimeout ()
	Time in seconds until target is fired/reset after expression becomes true.

bool	getTimeoutRearm ()
	Rearm trigger on timeout if still enabled.

float	getTimeoutSpread ()
	Random timeout spread in seconds.

bool	getTimerRunning ()
	Timer is running.

ECBehaviorTriggered.Instance	getTrigger ()
	Trigger or null.

void	init (StubElement stub)
	Initialize element from stub.

Instance	new (ECBehaviorTimer ecbehavior, BehaviorElement element)
	Create element.

void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read behavior instance from file.

void	removeFromGameWorld ()
	Remove element from game world.

void	removeListener (Listener listener)
	Remove listener.

void	think (float elapsed)
	Think about what to do for the next frame update.

void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write behavior instance to file.

Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	attachToParent (Element parent)
	Attach element to object set by the mapper in the IGDE World Editor.

void	enterFrame ()
	Frame update started.

void	geometryChanged ()
	Position or orientation changed.

BehaviorElement	getElement ()
	Behavior element to apply behavior to.

int	getInstanceIndex ()
	Behavior instance index.

DefaultECBehaviorInstance	new (BehaviorElement element)
	Create default composeable instance.

void	postThink (float elapsed)
	Post thinking after physics processing is finished.

bool	requiresEnterFrame ()
	Behavior instance requires enterFrame() to be called.

bool	requiresThink ()
	Behavior instance requires think() to be called.

void	stateChanged ()
	State changed (visble, touchable).

Public Attributes
ECComposeBTSM.Instance	pBTSMs

ECBehaviorTimer	pECBehavior

Array	pListeners

float	pRemainingTime

TSNamedTriggerTarget	pTarget

float	pTimeout

bool	pTimeoutRearm

bool	pTimerRunning

ECBehaviorTriggered.Instance	pTrigger

Public Attributes inherited from Dragengine.Scenery.DefaultECBehaviorInstance
BehaviorElement	pElement

int	pInstanceIndex

bool	pRequiresEnterFrame

bool	pRequiresThink

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	setRequiresEnterFrame (bool required)
	Set if behavior instance requires enterFrame() to be called.

void	setRequiresThink (bool required)
	Set if behavior instance requires think() to be called.

Detailed Description

Behavior instance.

Member Function Documentation

◆ addToGameWorld()

void Dragengine.Scenery.ECBehaviorTimer.Instance.addToGameWorld ( )

Add element to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ armTimer()

void Dragengine.Scenery.ECBehaviorTimer.Instance.armTimer ( )

Arm timer if timeout is larger than 0 otherwise operate target immediately.

◆ dispose()

void Dragengine.Scenery.ECBehaviorTimer.Instance.dispose ( )

Dispose of composeable instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getCancelOnReset()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getCancelOnReset ( )

Trigger timer is cancelled if trigger expression evaluates to false.

◆ getECBehavior()

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.Instance.getECBehavior ( )

Behavior.

◆ getFireOnTimeout()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getFireOnTimeout ( )

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

◆ getFullReset()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getFullReset ( )

Full reset target instead of simple reset.

◆ getPulse()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.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.

◆ getRemainingTime()

float Dragengine.Scenery.ECBehaviorTimer.Instance.getRemainingTime ( )

Remaining time until timeout.

◆ getStartActivated()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getStartActivated ( )

Trigger starts out activated.

◆ getTarget()

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTimer.Instance.getTarget ( )

Trigger target or null.

◆ getTimeout()

float Dragengine.Scenery.ECBehaviorTimer.Instance.getTimeout ( )

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

◆ getTimeoutRearm()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getTimeoutRearm ( )

Rearm trigger on timeout if still enabled.

Version: 1.12

◆ getTimeoutSpread()

float Dragengine.Scenery.ECBehaviorTimer.Instance.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.

◆ getTimerRunning()

bool Dragengine.Scenery.ECBehaviorTimer.Instance.getTimerRunning ( )

Timer is running.

◆ getTrigger()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorTimer.Instance.getTrigger ( )

Trigger or null.

◆ init()

void Dragengine.Scenery.ECBehaviorTimer.Instance.init ( StubElement stub )

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

Instance Dragengine.Scenery.ECBehaviorTimer.Instance.new	(	ECBehaviorTimer	ecbehavior,
		BehaviorElement	element
	)

Create element.

◆ readFromFile()

void Dragengine.Scenery.ECBehaviorTimer.Instance.readFromFile	(	PersistencyEnvironment	env,
		FileReader	reader
	)

Read behavior instance from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeFromGameWorld()

void Dragengine.Scenery.ECBehaviorTimer.Instance.removeFromGameWorld ( )

Remove element from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorTimer.Instance.removeListener ( Listener listener )

Remove listener.

◆ think()

void Dragengine.Scenery.ECBehaviorTimer.Instance.think ( float elapsed )

Think about what to do for the next frame update.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ writeToFile()

void Dragengine.Scenery.ECBehaviorTimer.Instance.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write behavior instance to file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

Member Data Documentation

◆ pBTSMs

ECComposeBTSM.Instance Dragengine.Scenery.ECBehaviorTimer.Instance.pBTSMs

◆ pECBehavior

ECBehaviorTimer Dragengine.Scenery.ECBehaviorTimer.Instance.pECBehavior

◆ pListeners

Array Dragengine.Scenery.ECBehaviorTimer.Instance.pListeners

◆ pRemainingTime

float Dragengine.Scenery.ECBehaviorTimer.Instance.pRemainingTime

◆ pTarget

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTimer.Instance.pTarget

◆ pTimeout

float Dragengine.Scenery.ECBehaviorTimer.Instance.pTimeout

◆ pTimeoutRearm

bool Dragengine.Scenery.ECBehaviorTimer.Instance.pTimeoutRearm

◆ pTimerRunning

bool Dragengine.Scenery.ECBehaviorTimer.Instance.pTimerRunning

◆ pTrigger

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorTimer.Instance.pTrigger

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

ECBehaviorTimer.ds

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToGameWorld()

◆ armTimer()

◆ dispose()

◆ getCancelOnReset()

◆ getECBehavior()

◆ getFireOnTimeout()

◆ getFullReset()

◆ getPulse()

◆ getRemainingTime()

◆ getStartActivated()

◆ getTarget()

◆ getTimeout()

◆ getTimeoutRearm()

◆ getTimeoutSpread()

◆ getTimerRunning()

◆ getTrigger()

◆ init()

◆ new()

◆ readFromFile()

◆ removeFromGameWorld()

◆ removeListener()

◆ think()

◆ writeToFile()

Member Data Documentation

◆ pBTSMs

◆ pECBehavior

◆ pListeners

◆ pRemainingTime

◆ pTarget

◆ pTimeout

◆ pTimeoutRearm

◆ pTimerRunning

◆ pTrigger