Dragengine.Scenery.ECBehaviorToggle Class Reference

Behavior element behavior toggling trigger target. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorToggle:

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.
String	getPrefix ()
	Prefix.
ECPBoolean	getStartActivated ()
	Initial state of trigger target when behavior is added to trigger table.
ECPString	getTarget ()
	Trigger target to operate.
ECBehaviorTriggered	getTriggered ()
	Trigger to toggle.
TSTriggerTable	getTriggerTable ()
	Trigger table or null if not used.
ECBehaviorToggle	new (BehaviorElementClass eclass)
	Create behavior element class.
ECBehaviorToggle	new (BehaviorElementClass eclass, String id)
	Create default composeable behavior.
ECBehaviorToggle	new (BehaviorElementClass eclass, TSTriggerTable triggerTable)
ECBehaviorToggle	new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id)
ECBehaviorToggle	new (BehaviorElementClass eclass, TSTriggerTable triggerTable, String id, String subID)
ECBehaviorToggle	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 ECBehaviorToggle	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECComposeBTSM	pBTSMs
Array	pListenerFactories
String	pPrefix
ECPBoolean	pStartActivated
ECPString	pTarget
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 toggling trigger target.

Toggles trigger target between fired and reset state whenever evaluation state of trigger expression changes to true.

Element class properties have the prefix "toggle{(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_toggle

Member Function Documentation

addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorToggle.addListenerFactory

(

Block

blockFactory

)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorToggle.addListenerFactory

(

ListenerFactory

factory

)

Add listener factory.

createListeners()

void Dragengine.Scenery.ECBehaviorToggle.createListeners

(

Instance

instance

)

Create listeners from factories adding them to behavior instance.

dispose()

void Dragengine.Scenery.ECBehaviorToggle.dispose

(

)

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorToggle.forEachListenerFactory

(

Block

ablock

)

Visit listener factories with block with argument ListenerFactory.

getBehaviorIn()

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

(

)

Compose behavior trees and state machines.

Version

1.26

getPrefix()

String Dragengine.Scenery.ECBehaviorToggle.getPrefix

(

)

Prefix.

Version

1.26

getStartActivated()

ECPBoolean Dragengine.Scenery.ECBehaviorToggle.getStartActivated

(

)

Initial state of trigger target when behavior is added to trigger table.

getTarget()

ECPString Dragengine.Scenery.ECBehaviorToggle.getTarget

(

)

Trigger target to operate.

getTriggered()

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorToggle.getTriggered

(

)

Trigger to toggle.

getTriggerTable()

TSTriggerTable Dragengine.Scenery.ECBehaviorToggle.getTriggerTable

(

)

Trigger table or null if not used.

new() [1/6]

ECBehaviorToggle Dragengine.Scenery.ECBehaviorToggle.new

(

BehaviorElementClass

eclass

)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

new() [2/6]

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

Create default composeable behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

new() [3/6]

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

new() [4/6]

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

new() [5/6]

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

new() [6/6]

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

setTriggerTable()

void Dragengine.Scenery.ECBehaviorToggle.setTriggerTable ( TSTriggerTable  triggerTable )

protected

Set trigger table or null if not used.

Member Data Documentation

pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorToggle.pBTSMs

pListenerFactories

Array Dragengine.Scenery.ECBehaviorToggle.pListenerFactories

pPrefix

String Dragengine.Scenery.ECBehaviorToggle.pPrefix

pStartActivated

ECPBoolean Dragengine.Scenery.ECBehaviorToggle.pStartActivated

pTarget

ECPString Dragengine.Scenery.ECBehaviorToggle.pTarget

pTriggered

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorToggle.pTriggered

pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorToggle.pTriggerTable

---

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

• ECBehaviorToggle.ds