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

Behavior adding support to actors to align to a specific position and orientation. More...

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

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...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
ECBehaviorConversationActor getConversationActor ()
 Conversation actor behavior or null. More...
 
ECBehaviorLocomotion getLocomotion ()
 Locomotion behavior. More...
 
ECPFloat getSpeed ()
 Movement speed. More...
 
ECBehaviorAlignActor new (BehaviorElementClass eclass, ECBehaviorLocomotion locomotion, ECBehaviorConversationActor conversationActor)
 Create behavior element class. More...
 
ECBehaviorAlignActor new (BehaviorElementClass eclass, ECBehaviorLocomotion locomotion, ECBehaviorConversationActor conversationActor, 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 ECBehaviorAlignActor getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

ECBehaviorConversationActor pConversationActor
 
Array pListenerFactories
 
ECBehaviorLocomotion pLocomotion
 
ECPFloat pSpeed
 

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 align to a specific position and orientation.

Manipulates ECBehaviorLocomotion to move an actor a short distance to a specific position, orientation and looking direction. This is typically required for actors intending to interact with objects. In this case the animation of the actor has to match the object it is interacting with. Actor actions will use this behavior to achieve this goal.

To use this class add these behaviors to the actor:

For using Look-At handling these behaviors are required:

Add a listener to be notified if the actor finished aligning or poll the behavior.

During each update step the actor is moved towards the goal position in a straight line. The orientation and looking direction is also adjusted using a blend from the starting values to the final values.

Member Function Documentation

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorAlignActor.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorAlignActor.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createListeners()

void Dragengine.Scenery.ECBehaviorAlignActor.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ dispose()

void Dragengine.Scenery.ECBehaviorAlignActor.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorAlignActor.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

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

◆ getConversationActor()

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorAlignActor.getConversationActor ( )

Conversation actor behavior or null.

◆ getLocomotion()

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorAlignActor.getLocomotion ( )

Locomotion behavior.

◆ getSpeed()

ECPFloat Dragengine.Scenery.ECBehaviorAlignActor.getSpeed ( )

Movement speed.

◆ new() [1/2]

ECBehaviorAlignActor Dragengine.Scenery.ECBehaviorAlignActor.new ( BehaviorElementClass  eclass,
ECBehaviorLocomotion  locomotion,
ECBehaviorConversationActor  conversationActor 
)

Create behavior element class.

These values are optional and can be null: conversationActor.

◆ new() [2/2]

ECBehaviorAlignActor Dragengine.Scenery.ECBehaviorAlignActor.new ( BehaviorElementClass  eclass,
ECBehaviorLocomotion  locomotion,
ECBehaviorConversationActor  conversationActor,
String  prefix 
)

Member Data Documentation

◆ pConversationActor

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorAlignActor.pConversationActor

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorAlignActor.pListenerFactories

◆ pLocomotion

ECBehaviorLocomotion Dragengine.Scenery.ECBehaviorAlignActor.pLocomotion

◆ pSpeed

ECPFloat Dragengine.Scenery.ECBehaviorAlignActor.pSpeed

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