Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECBehaviorConvoCoordSystem Class Reference

Behavior element behavior adding conversation coordinate support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorConvoCoordSystem:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

ECPStringID getName ()
 Name of conversation coordinate system. More...
 
ECPVector getOrientation ()
 Orientation relative to behavior element. More...
 
ECPVector getPosition ()
 Position relative to behavior element. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorConvoCoordSystem new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorConvoCoordSystem new (BehaviorElementClass eclass, String id)
 Create behavior element class. More...
 
ECBehaviorConvoCoordSystem new (BehaviorElementClass eclass, String id, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
void dispose ()
 Dispose of behavior. 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...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

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

Additional Inherited Members

- 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 adding conversation coordinate support.

Instance adds a ElementConvoCoordSystem to the game world the element is added to. These can be added to conversation playbacks as targets for actions. Multiple ECBehaviorConvoCoordSystem can be added creating individual ElementConvoCoordSystem instances. The ElementConvoCoordSystem returns the position relative to the element if queried.

The default implementation registers the ElementConvoCoordSystem in the conversation coordinate system list of the GameWorld the element is added to. If name is empty string no convo coordinate system is created.

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

Member Function Documentation

◆ getBehaviorIn()

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

◆ getName()

ECPStringID Dragengine.Scenery.ECBehaviorConvoCoordSystem.getName ( )

Name of conversation coordinate system.

◆ getOrientation()

ECPVector Dragengine.Scenery.ECBehaviorConvoCoordSystem.getOrientation ( )

Orientation relative to behavior element.

◆ getPosition()

ECPVector Dragengine.Scenery.ECBehaviorConvoCoordSystem.getPosition ( )

Position relative to behavior element.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/3]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/3]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [3/3]

ECBehaviorConvoCoordSystem Dragengine.Scenery.ECBehaviorConvoCoordSystem.new ( BehaviorElementClass  eclass,
String  id,
String  prefix 
)

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