Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorStepAside Class Reference

Behavior adding support to actors to step aside if told. More...

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

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

void dispose ()
 Dispose of behavior. More...
 
ECBehaviorActorMover getActorMover ()
 Actor mover behavior. More...
 
ECPBoolean getEnabled ()
 Behavior is initially enabled. More...
 
ECPFloat getRadius ()
 Avoid radius. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorStepAside new (BehaviorElementClass eclass, ECBehaviorActorMover actorMover)
 Create behavior element class. More...
 
ECBehaviorStepAside new (BehaviorElementClass eclass, ECBehaviorActorMover actorMover, 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 ECBehaviorStepAside 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 adding support to actors to step aside if told.

This behavior is useful for situations where actors can get in the way of the player or other actors. The behavior is a reactive behavior not acting by itself. It is triggered by ECBehaviorClearPath or other behaviors supporting it if the find a future collision.

This behavior has no effect if actor mover has a goal set.

This behavior can be disabled temporarily to prevent actors from stepping aside.

Requires these behaviors to be present:

Member Function Documentation

◆ dispose()

void Dragengine.Scenery.ECBehaviorStepAside.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getActorMover()

ECBehaviorActorMover Dragengine.Scenery.ECBehaviorStepAside.getActorMover ( )

Actor mover behavior.

◆ getBehaviorIn()

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

◆ getEnabled()

ECPBoolean Dragengine.Scenery.ECBehaviorStepAside.getEnabled ( )

Behavior is initially enabled.

◆ getRadius()

ECPFloat Dragengine.Scenery.ECBehaviorStepAside.getRadius ( )

Avoid radius.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/2]

ECBehaviorStepAside Dragengine.Scenery.ECBehaviorStepAside.new ( BehaviorElementClass  eclass,
ECBehaviorActorMover  actorMover 
)

Create behavior element class.

◆ new() [2/2]

ECBehaviorStepAside Dragengine.Scenery.ECBehaviorStepAside.new ( BehaviorElementClass  eclass,
ECBehaviorActorMover  actorMover,
String  prefix 
)

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