Dragengine.Scenery.ECBehaviorTriggered Class Reference

Behavior element behavior adding trigger support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorTriggered:

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	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.
ECBehaviorTriggered	getSynchronize ()
	Trigger to synchronize with or null.
ECPString	getTrigger ()
	Trigger.
TSTriggerTable	getTriggerTable ()
	Trigger table.
ECBehaviorTriggered	new (BehaviorElementClass eclass)
	Create behavior element class.
ECBehaviorTriggered	new (BehaviorElementClass eclass, String id)
	Create behavior element class.
ECBehaviorTriggered	new (BehaviorElementClass eclass, TSTriggerTable triggerTable)
	Create behavior element class.
ECBehaviorTriggered	new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id)
	Create behavior element class.
ECBehaviorTriggered	new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id, String propertyName)
void	setSynchronize (BehaviorElementClass eclass, String id)
	Set trigger to synchronize with using identifier.
void	setSynchronize (ECBehaviorTriggered behavior)
	Set trigger to synchronize with or null.
void	setTriggerTable (TSTriggerTable triggerTable)
	Set trigger table.
ECBehaviorTriggered	synchronizedOrSelf ()
	Synchronize trigger if not null otherwise this.
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 ECBehaviorTriggered	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECComposeBTSM	pBTSMs
Array	pListenerFactories
ECBehaviorTriggered	pSynchronize
ECPString	pTrigger
TSTriggerTable	pTriggerTable

Additional Inherited Members
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 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.

Optionally a synchronized trigger can be specified. If set users of this trigger should use the synchronized trigger instead of this trigger. This allows setting a single trigger expression in an element stub to affect multiple triggers in the same element class.

Element class property is named "trigger{(id)}".

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

See also

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

Member Function Documentation

addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorTriggered.addListenerFactory

(

Block

blockFactory

)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

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 ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.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.ECBehaviorTriggered.getBTSMs

(

)

Compose behavior trees and state machines.

Version

1.26

getSynchronize()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.getSynchronize

(

)

Trigger to synchronize with or null.

Version

1.25

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
	)

setSynchronize() [1/2]

void Dragengine.Scenery.ECBehaviorTriggered.setSynchronize	(	BehaviorElementClass	eclass,
		String	id
	)

Set trigger to synchronize with using identifier.

Version

1.25

If identifier is null or empty string clears synchronize behavior. Otherwise looks up ECBehaviorTriggered with identifier. If behavior is absent throws an exception.

For use with behavior factories using ECBehaviorTriggered like this:

behavior.setSynchronize(eclass, parameters.getAt("trigger.synchronize", null) cast String)

setSynchronize() [2/2]

void Dragengine.Scenery.ECBehaviorTriggered.setSynchronize

(

ECBehaviorTriggered

behavior

)

Set trigger to synchronize with or null.

Version

1.25

setTriggerTable()

void Dragengine.Scenery.ECBehaviorTriggered.setTriggerTable

(

TSTriggerTable

triggerTable

)

Set trigger table.

synchronizedOrSelf()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.synchronizedOrSelf

(

)

Synchronize trigger if not null otherwise this.

Version

1.25

Call this function to obtain the behavior to use supporting synchronize triggers.

Member Data Documentation

pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorTriggered.pBTSMs

pListenerFactories

Array Dragengine.Scenery.ECBehaviorTriggered.pListenerFactories

pSynchronize

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTriggered.pSynchronize

pTrigger

ECPString Dragengine.Scenery.ECBehaviorTriggered.pTrigger

pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorTriggered.pTriggerTable

---

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

• ECBehaviorTriggered.ds