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

Behavior element behavior adding player controlling support to actor. More...

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

Classes

class  BlockListenerFactory
 Factory creating listeners using block. More...
 
class  ConvoCommand
 Conversation command. More...
 
class  ConvoCondition
 Conversation condition. 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...
 
class  Tracker
 Keeps track of the active player actor. More...
 

Public Member Functions

void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
ECBehaviorInstance createInstance (BehaviorElement element)
 Create 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...
 
Tracker getTracker ()
 Tracker. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorPlayerControllable new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorPlayerControllable new (BehaviorElementClass eclass, Tracker tracker)
 
void setConversationActor (ECBehaviorConversationActor conversationActor)
 Set conversation actor or null. More...
 
void setTracker (Tracker tracker)
 Set tracker. More...
 
- 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...
 

Static Public Member Functions

static ECBehaviorPlayerControllable getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element)
 Get instance in element or null if absent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
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 player controlling support to actor.

Actors with this behavior can become the player controlled actor. Requires an instance of ECBehaviorPlayerControllable.Tracker to be assigned. The instance keeps track of the active player actor and is typically stored globally in the game. BaseGameApp provides such an instance for easy use.

This behavior can be used only once in the behavior element.

This behavior does not require persistable element class (setPersistable).

If ECBehaviorConversationActor is present adds these conversation conditions and commands:

See the above mentioned classes for the supported syntax.

Member Function Documentation

◆ addListenerFactory() [1/2]

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

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

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

Add listener factory.

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorPlayerControllable.createInstance ( BehaviorElement  element)

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorPlayerControllable.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

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

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

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

◆ getConversationActor()

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorPlayerControllable.getConversationActor ( )

Conversation actor behavior or null.

◆ getInstanceIn()

static Instance Dragengine.Scenery.ECBehaviorPlayerControllable.getInstanceIn ( BehaviorElement  element)
static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorPlayerControllable.Instance .

◆ getTracker()

Tracker Dragengine.Scenery.ECBehaviorPlayerControllable.getTracker ( )

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/2]

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

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/2]

ECBehaviorPlayerControllable Dragengine.Scenery.ECBehaviorPlayerControllable.new ( BehaviorElementClass  eclass,
Tracker  tracker 
)

◆ setConversationActor()

void Dragengine.Scenery.ECBehaviorPlayerControllable.setConversationActor ( ECBehaviorConversationActor  conversationActor)

Set conversation actor or null.

If set adds conversation condition and command.

◆ setTracker()

void Dragengine.Scenery.ECBehaviorPlayerControllable.setTracker ( Tracker  tracker)

Set tracker.


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