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

Behavior element behavior adding locomotion support for actors. More...

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

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

void dispose ()
 Dispose of behavior. More...
 
ECBehaviorCollider getCollider ()
 Collider behavior or null. More...
 
ECBehaviorColliderAI getColliderAI ()
 ColliderAI behavior or null. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorLocomotion new (BehaviorElementClass eclass, ECBehaviorCollider collider)
 
ECBehaviorLocomotion new (BehaviorElementClass eclass, ECBehaviorCollider collider, String prefix)
 
ECBehaviorLocomotion new (BehaviorElementClass eclass, ECBehaviorColliderAI colliderAI)
 Create behavior element class. More...
 
ECBehaviorLocomotion new (BehaviorElementClass eclass, ECBehaviorColliderAI colliderAI, 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...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
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 locomotion support for actors.

Adds Locomotion. Actors use Locomotion to move their AI colliders across the game world. Locomotion also provides values for AnimatorController to provide animation to actors matching their movement.

Uses collider of ECBehaviorColliderAI or ECBehaviorCollider depending which one is present. If both are present ECBehaviorColliderAI is preferred.

By default creates instance of Locomotion. This class provides all the basic behavior to do locomotion for different type of actors. Supports organic locomotion of 2-legged and 4-legged characters with natural and FPS type movement patterns as well as mechanical locomotion like vehicles.

This behavior supports persistable element class (setPersistable).

Member Function Documentation

◆ dispose()

void Dragengine.Scenery.ECBehaviorLocomotion.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getBehaviorIn()

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

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorLocomotion.getCollider ( )

Collider behavior or null.

◆ getColliderAI()

ECBehaviorColliderAI Dragengine.Scenery.ECBehaviorLocomotion.getColliderAI ( )

ColliderAI behavior or null.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/4]

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorLocomotion.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider 
)

◆ new() [2/4]

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorLocomotion.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider,
String  prefix 
)

◆ new() [3/4]

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorLocomotion.new ( BehaviorElementClass  eclass,
ECBehaviorColliderAI  colliderAI 
)

Create behavior element class.

◆ new() [4/4]

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorLocomotion.new ( BehaviorElementClass  eclass,
ECBehaviorColliderAI  colliderAI,
String  prefix 
)

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