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

Inheritance diagram for Dragengine.Scenery.ECBehaviorPlayerControllable:

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	Factory
	Behavior factory. 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.

void	addListenerFactory (ListenerFactory factory)
	Add listener factory.

void	createListeners (Instance instance)
	Create listeners from factories adding them to behavior instance.

void	dispose ()
	Dispose of behavior.

void	forEachListenerFactory (Block ablock)
	Visit listener factories with block with argument ListenerFactory.

ECComposeBTSM	getBTSMs ()
	Compose behavior trees and state machines.

ECBehaviorConversationActor	getConversationActor ()
	Conversation actor behavior or null.

Tracker	getTracker ()
	Tracker.

ECBehaviorPlayerControllable	new (BehaviorElementClass eclass)
	Create behavior element class.

ECBehaviorPlayerControllable	new (BehaviorElementClass eclass, Tracker tracker)

void	setConversationActor (ECBehaviorConversationActor conversationActor)
	Set conversation actor or null.

void	setTracker (Tracker tracker)
	Set tracker.

Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void	assignInstanceIndex (int instanceIndex)
	Assign instance index.

String	getBehaviorID ()
	Unique identifier of behavior.

String	getID ()
	Identifier.

int	getInstanceIndex ()
	Instance index.

void	loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
	Load instance data of another behavior.

bool	supportsBehaviorID (String identifier)
	Behavior supports loading instance data of another behavior.

Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance	createInstance (BehaviorElement element)
	Create Behavior instance.

Static Public Member Functions
static ECBehaviorPlayerControllable	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECComposeBTSM	pBTSMs

ECBehaviorConversationActor	pConversationActor

Array	pListenerFactories

Tracker	pTracker

Additional Inherited Members
Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior	new (BehaviorElementClass eclass, String id)
	Create default composeable behavior.

void	setBehaviorID (String identifier)
	Set behavior identifier.

void	useClassNameAsBehaviorID ()
	Set behavior identifier to "<class-name>:<identifier>".

void	useFullyQualifiedClassNameAsBehaviorID ()
	Set behavior identifier to "<fully-qualified-class-name>:<identifier>".

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:

ECBehaviorPlayerControllable.ConvoCondition
ECBehaviorPlayerControllable.ConvoCommand

See the above mentioned classes for the supported syntax.

See also: https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_playercontrollable

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.

◆ createListeners()

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

Create listeners from factories adding them to behavior instance.

◆ 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.

◆ getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorPlayerControllable.getBTSMs ( )

Compose behavior trees and state machines.

Version: 1.26

◆ getConversationActor()

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorPlayerControllable.getConversationActor ( )

Conversation actor behavior or null.

◆ getTracker()

Tracker Dragengine.Scenery.ECBehaviorPlayerControllable.getTracker ( )

Tracker.

◆ 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.

Member Data Documentation

◆ pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorPlayerControllable.pBTSMs

◆ pConversationActor

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorPlayerControllable.pConversationActor

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorPlayerControllable.pListenerFactories

◆ pTracker

Tracker Dragengine.Scenery.ECBehaviorPlayerControllable.pTracker

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

ECBehaviorPlayerControllable.ds

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members