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

ECBehaviorInstance	createInstance (BehaviorElement element)
	Create Behavior instance. More...

void	dispose ()
	Dispose of behavior. More...

void	forEachListenerFactory (Block ablock)
	Visit listener factories with block with argument ListenerFactory. More...

ECPBoolean	getStartActivated ()
	Initial state of trigger target when behavior is added to trigger table. More...

ECPString	getTarget ()
	Trigger target to operate. More...

ECBehaviorTriggered	getTriggered ()
	Trigger to toggle. More...

TSTriggerTable	getTriggerTable ()
	Trigger table or null if not used. More...

Instance	instance (BehaviorElement element)
	Get instance in element from owner element class. More...

ECBehaviorToggle	new (BehaviorElementClass eclass)
	Create behavior element class. More...

ECBehaviorToggle	new (BehaviorElementClass eclass, String id)
	Create default composeable behavior. More...

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

Static Public Member Functions
static Array	getAllBehaviorsIn (BehaviorElementClass eclass)
	Get list of all behaviors in element. More...

static Array	getAllInstancesIn (BehaviorElement element)
	Get list of all instances in element. More...

static ECBehaviorToggle	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent. More...

static ECBehaviorToggle	getBehaviorIn (BehaviorElementClass eclass, String id)
	Get behavior with id in element class or null if absent. More...

static Instance	getInstanceIn (BehaviorElement element)
	Get instance in element or null if absent. More...

static Instance	getInstanceIn (BehaviorElement element, String id)
	Get instance with id in element 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 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).

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.

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorToggle.createInstance ( BehaviorElement element )

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

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

◆ getAllBehaviorsIn()

static Array Dragengine.Scenery.ECBehaviorToggle.getAllBehaviorsIn ( BehaviorElementClass eclass )

static

Get list of all behaviors in element.

Returns list contains ECBehaviorToggle behaviors in the order they have been created in the element.

◆ getAllInstancesIn()

static Array Dragengine.Scenery.ECBehaviorToggle.getAllInstancesIn ( BehaviorElement element )

static

Get list of all instances in element.

Returns list contains ECBehaviorToggle.Instance instances in the order they have been created in the element.

◆ getBehaviorIn() [1/2]

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.

◆ getBehaviorIn() [2/2]

static ECBehaviorToggle Dragengine.Scenery.ECBehaviorToggle.getBehaviorIn	(	BehaviorElementClass	eclass,
		String	id
	)

static

Get behavior with id in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorToggle with specific identifier.

◆ getInstanceIn() [1/2]

static Instance Dragengine.Scenery.ECBehaviorToggle.getInstanceIn ( BehaviorElement element )

static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorToggle.Instance . If more than one instance is present returns the first instance.

◆ getInstanceIn() [2/2]

static Instance Dragengine.Scenery.ECBehaviorToggle.getInstanceIn	(	BehaviorElement	element,
		String	id
	)

static

Get instance with id in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorToggle.Instance with specific identifier.

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

◆ instance()

Instance Dragengine.Scenery.ECBehaviorToggle.instance ( BehaviorElement element )

Get instance in element from owner element class.

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

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

ECBehaviorToggle.ds

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addListenerFactory() [1/2]

◆ addListenerFactory() [2/2]

◆ createInstance()

◆ dispose()

◆ forEachListenerFactory()

◆ getAllBehaviorsIn()

◆ getAllInstancesIn()

◆ getBehaviorIn() [1/2]

◆ getBehaviorIn() [2/2]

◆ getInstanceIn() [1/2]

◆ getInstanceIn() [2/2]

◆ getStartActivated()

◆ getTarget()

◆ getTriggered()

◆ getTriggerTable()

◆ instance()

◆ new() [1/6]

◆ new() [2/6]

◆ new() [3/6]

◆ new() [4/6]

◆ new() [5/6]

◆ new() [6/6]

◆ setTriggerTable()