Behavior element behavior adding anchor element support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorAnchorElement:

Classes
class	Factory
	Behavior factory. More...

class	Instance
	Behavior instance. More...

Public Member Functions
ECPStringID	getAnchorID ()
	Anchor name or empty string to not anchor.

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

ECBehaviorAnchorElement	new (BehaviorElementClass eclass)
	Create behavior element class.

ECBehaviorAnchorElement	new (BehaviorElementClass eclass, String propertyName)
	Create default composeable behavior.

Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void	assignInstanceIndex (int instanceIndex)
	Assign instance index.

void	dispose ()
	Dispose of behavior.

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 ECBehaviorAnchorElement	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECPStringID	pAnchorID

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 anchor element support.

Anchoring elements allows to locate elements in a GameWorld using a unique name set by the mapper. This is useful for game commands send by conversations scripts.

Element class property has name "anchorID".

This element behavior can be present only once in a BehaviorElement. Trying to add more than one instance results in an exception thrown.

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_anchorelement

Member Function Documentation

◆ getAnchorID()

ECPStringID Dragengine.Scenery.ECBehaviorAnchorElement.getAnchorID ( )

Anchor name or empty string to not anchor.

◆ getBehaviorIn()

static ECBehaviorAnchorElement Dragengine.Scenery.ECBehaviorAnchorElement.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 ECBehaviorCollider.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/2]

ECBehaviorAnchorElement Dragengine.Scenery.ECBehaviorAnchorElement.new ( BehaviorElementClass eclass )

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/2]

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

Create default composeable behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

Member Data Documentation

◆ pAnchorID

ECPStringID Dragengine.Scenery.ECBehaviorAnchorElement.pAnchorID

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

ECBehaviorAnchorElement.ds

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members