Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorActorTransmission.Instance:

Public Member Functions
void	addListener (Listener listener)
	Add listener.

void	addListenerFactory (Block blockFactory)
	Add listener factory using block.

void	addListenerFactory (ListenerFactory factory)
	Add listener factory.

void	addPart (UnicodeString text)
	Add transmission part.

void	addPart (UnicodeString text, float timeout)
	Add transmission part.

void	addPart (UnicodeString text, StringID style)
	Add transmission part.

void	addPart (UnicodeString text, StringID style, float timeout)
	Add transmission part.

void	clear ()
	Clear all parts and hide subtitle.

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

void	dispose ()
	Dispose of 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.

bool	getClearEnterConversation ()
	Clear transmission upon entering conversation.

ECPBoolean	getClearEnterConversation ()
	Clear transmission upon entering conversation.

ECBehaviorConversationActor.Instance	getConversationActor ()
	Conversation actor behavior.

ECBehaviorConversationActor	getConversationActor ()
	Conversation actor behavior to animate.

ECBehaviorActorTransmission	getECBehavior ()
	Behavior.

Part	getPartAt (int index)
	Part at index.

int	getPartCount ()
	Count of parts.

String	getPrefix ()
	Prefix.

float	getRemainingDisplayTime ()
	Remaining display time of current part in seconds.

StringID	getStyle ()
	Style to use.

ECPStringID	getStyle ()
	Style.

ConversationPlaybackSubTitle	getSubTitle ()
	Sub title.

ConversationPlaybackSubTitle	getSubTitle ()
	Sub title.

SubTitleBoxText	getSubTitleText ()
	Sub title text or null if not set.

float	getTimeout ()
	Timeout in seconds to display each part.

ECPFloat	getTimeout ()
	Timeout.

bool	getWaitInConversation ()
	Wait in conversation is enabled.

ECPBoolean	getWaitInConversation ()
	Enable wait in conversation.

void	init (StubElement stub)
	Initialize behavior from stub.

bool	isRunning ()
	Transmission is running.

Instance	new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor)
	Create behavior element class.

Instance	new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor, ConversationPlaybackSubTitle subTitle)
	Create behavior element class.

Instance	new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor, ConversationPlaybackSubTitle subTitle, String prefix)
	Create behavior element class.

Instance	new (ECBehaviorActorTransmission ecbehavior, BehaviorElement element)
	Create behavior instance.

void	removeListener (Listener listener)
	Remove listener.

void	setClearEnterConversation (bool clearEnterConversation)
	Set to clear transmission upon entering conversation.

void	setStyle (StringID style)
	Set style to use.

void	setSubTitle (ConversationPlaybackSubTitle subTitle)
	Set sub title.

void	setTimeout (float timeout)
	Set timeout in seconds to display each part.

void	setWaitInConversation (bool waitInConversation)
	Set to wait in conversation is enabled.

void	skipPart ()
	Skip current part advancing to next one if possible.

void	think (float elapsed)
	Frame update.

void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write behavior to file.

Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	addToGameWorld ()
	Add element to game world.

void	attachToParent (Element parent)
	Attach element to object set by the mapper in the IGDE World Editor.

void	enterFrame ()
	Frame update started.

void	geometryChanged ()
	Position or orientation changed.

BehaviorElement	getElement ()
	Behavior element to apply behavior to.

int	getInstanceIndex ()
	Behavior instance index.

DefaultECBehaviorInstance	new (BehaviorElement element)
	Create default composeable instance.

void	postThink (float elapsed)
	Post thinking after physics processing is finished.

void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read behavior instance from file.

void	removeFromGameWorld ()
	Remove element from game world.

bool	requiresEnterFrame ()
	Behavior instance requires enterFrame() to be called.

bool	requiresThink ()
	Behavior instance requires think() to be called.

void	stateChanged ()
	State changed (visble, touchable).

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

Public Attributes
ECComposeBTSM.Instance	pBTSMs

ECComposeBTSM	pBTSMs

bool	pClearEnterConversation

ECPBoolean	pClearEnterConversation

ECBehaviorConversationActor.Instance	pConversationActor

ECBehaviorConversationActor	pConversationActor

ECBehaviorActorTransmission	pECBehavior

Array	pListenerFactories

Array	pListeners

Array	pParts

String	pPrefix

float	pRemainingDisplayTime

StringID	pStyle

ECPStringID	pStyle

ConversationPlaybackSubTitle	pSubTitle

SubTitleBoxText	pSubTitleText

float	pTimeout

ECPFloat	pTimeout

bool	pWaitInConversation

ECPBoolean	pWaitInConversation

Public Attributes inherited from Dragengine.Scenery.DefaultECBehaviorInstance
BehaviorElement	pElement

int	pInstanceIndex

bool	pRequiresEnterFrame

bool	pRequiresThink

Protected Member Functions
void	advanceToNextPart ()
	Advance to next part.

void	displayPart (Part part)
	Display part.

void	onFinished ()
	Transmission finished.

void	onPartDisplayed (Part part)
	Part displayed.

void	onStarted ()
	Transmission started.

void	setSubTitleText (SubTitleBoxText text)
	Set sub title text or null to clear it.

Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	setRequiresEnterFrame (bool required)
	Set if behavior instance requires enterFrame() to be called.

void	setRequiresThink (bool required)
	Set if behavior instance requires think() to be called.

Detailed Description

Behavior instance.

Member Function Documentation

◆ addListener()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addListener ( Listener listener )

Add listener.

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addListenerFactory ( Block blockFactory )

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addListenerFactory ( ListenerFactory factory )

Add listener factory.

◆ addPart() [1/4]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addPart ( UnicodeString text )

Add transmission part.

If no parts are present calls transmissionStart() on listeners and shows the transmission in the sub title box.

Parameters

text	Text to speak.

◆ addPart() [2/4]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addPart	(	UnicodeString	text,
		float	timeout
	)

Add transmission part.

If no parts are present calls transmissionStart() on listeners and shows the transmission in the sub title box.

Parameters

text	Text to speak.
timeout	Time in seconds to display transmission part.

◆ addPart() [3/4]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addPart	(	UnicodeString	text,
		StringID	style
	)

Add transmission part.

If no parts are present calls transmissionStart() on listeners and shows the transmission in the sub title box.

Parameters

text	Text to speak.
style	Identifier of style to adjust font, color or sub title in general or null.

◆ addPart() [4/4]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.addPart	(	UnicodeString	text,
		StringID	style,
		float	timeout
	)

Add transmission part.

If no parts are present calls transmissionStart() on listeners and shows the transmission in the sub title box.

Parameters

text	Text to speak.
style	Identifier of style to adjust font, color or sub title in general or null.
timeout	Time in seconds to display transmission part.

◆ advanceToNextPart()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.advanceToNextPart ( )

protected

Advance to next part.

Version: 1.24

If more parts can be shown the next part is shown using #displayPart().

If there are no more parts the subtitle text is cleared and requires thinking disabled. Furthermore #onFinished() is called and * Listener::transmissionFinished() is called on all listeners.

Call this method only if #isRunning() returns true.

◆ clear()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.clear ( )

Clear all parts and hide subtitle.

◆ createListeners()

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

Create listeners from factories adding them to behavior instance.

◆ displayPart()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.displayPart ( Part part )

protected

Display part.

◆ dispose() [1/2]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.dispose ( )

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose() [2/2]

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.forEachListenerFactory ( Block ablock )

Visit listener factories with block with argument ListenerFactory.

◆ getBehaviorIn()

static ECBehaviorActorTransmission Dragengine.Scenery.ECBehaviorActorTransmission.Instance.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 ECBehaviorConversationActor.

◆ getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getBTSMs ( )

Compose behavior trees and state machines.

Version: 1.26

◆ getClearEnterConversation() [1/2]

bool Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getClearEnterConversation ( )

Clear transmission upon entering conversation.

Version: 1.16

◆ getClearEnterConversation() [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getClearEnterConversation ( )

Clear transmission upon entering conversation.

Version: 1.16

◆ getConversationActor() [1/2]

ECBehaviorConversationActor.Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getConversationActor ( )

Conversation actor behavior.

◆ getConversationActor() [2/2]

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getConversationActor ( )

Conversation actor behavior to animate.

◆ getECBehavior()

ECBehaviorActorTransmission Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getECBehavior ( )

Behavior.

◆ getPartAt()

Part Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getPartAt ( int index )

Part at index.

Version: 1.19

◆ getPartCount()

int Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getPartCount ( )

Count of parts.

Version: 1.19

◆ getPrefix()

String Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getPrefix ( )

Prefix.

Version: 1.26

◆ getRemainingDisplayTime()

float Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getRemainingDisplayTime ( )

Remaining display time of current part in seconds.

Version: 1.26

◆ getStyle() [1/2]

StringID Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getStyle ( )

Style to use.

◆ getStyle() [2/2]

ECPStringID Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getStyle ( )

Style.

◆ getSubTitle() [1/2]

ConversationPlaybackSubTitle Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getSubTitle ( )

Sub title.

◆ getSubTitle() [2/2]

ConversationPlaybackSubTitle Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getSubTitle ( )

Sub title.

◆ getSubTitleText()

SubTitleBoxText Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getSubTitleText ( )

Sub title text or null if not set.

◆ getTimeout() [1/2]

float Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getTimeout ( )

Timeout in seconds to display each part.

◆ getTimeout() [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getTimeout ( )

Timeout.

◆ getWaitInConversation() [1/2]

bool Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getWaitInConversation ( )

Wait in conversation is enabled.

◆ getWaitInConversation() [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorActorTransmission.Instance.getWaitInConversation ( )

Enable wait in conversation.

◆ init()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.init ( StubElement stub )

Initialize behavior from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isRunning()

bool Dragengine.Scenery.ECBehaviorActorTransmission.Instance.isRunning ( )

Transmission is running.

◆ new() [1/4]

Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.new	(	BehaviorElementClass	eclass,
		ECBehaviorConversationActor	conversationActor
	)

Create behavior element class.

◆ new() [2/4]

Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.new	(	BehaviorElementClass	eclass,
		ECBehaviorConversationActor	conversationActor,
		ConversationPlaybackSubTitle	subTitle
	)

Create behavior element class.

◆ new() [3/4]

Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.new	(	BehaviorElementClass	eclass,
		ECBehaviorConversationActor	conversationActor,
		ConversationPlaybackSubTitle	subTitle,
		String	prefix
	)

Create behavior element class.

◆ new() [4/4]

Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.new	(	ECBehaviorActorTransmission	ecbehavior,
		BehaviorElement	element
	)

Create behavior instance.

◆ onFinished()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.onFinished ( )

protected

Transmission finished.

◆ onPartDisplayed()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.onPartDisplayed ( Part part )

protected

Part displayed.

◆ onStarted()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.onStarted ( )

protected

Transmission started.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.removeListener ( Listener listener )

Remove listener.

◆ setClearEnterConversation()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setClearEnterConversation ( bool clearEnterConversation )

Set to clear transmission upon entering conversation.

Version: 1.16

◆ setStyle()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setStyle ( StringID style )

Set style to use.

◆ setSubTitle()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setSubTitle ( ConversationPlaybackSubTitle subTitle )

Set sub title.

◆ setSubTitleText()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setSubTitleText ( SubTitleBoxText text )

protected

Set sub title text or null to clear it.

◆ setTimeout()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setTimeout ( float timeout )

Set timeout in seconds to display each part.

◆ setWaitInConversation()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.setWaitInConversation ( bool waitInConversation )

Set to wait in conversation is enabled.

◆ skipPart()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.skipPart ( )

Skip current part advancing to next one if possible.

Version: 1.24

Has no effect if #isRunning() returns false.

◆ think()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.think ( float elapsed )

Frame update.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ writeToFile()

void Dragengine.Scenery.ECBehaviorActorTransmission.Instance.writeToFile	(	PersistencyEnvironment	env,
		FileWriter	writer
	)

Write behavior to file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

Member Data Documentation

◆ pBTSMs [1/2]

ECComposeBTSM.Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pBTSMs

◆ pBTSMs [2/2]

ECComposeBTSM Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pBTSMs

◆ pClearEnterConversation [1/2]

bool Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pClearEnterConversation

◆ pClearEnterConversation [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pClearEnterConversation

◆ pConversationActor [1/2]

ECBehaviorConversationActor.Instance Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pConversationActor

◆ pConversationActor [2/2]

ECBehaviorConversationActor Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pConversationActor

◆ pECBehavior

ECBehaviorActorTransmission Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pECBehavior

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pListenerFactories

◆ pListeners

Array Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pListeners

◆ pParts

Array Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pParts

◆ pPrefix

String Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pPrefix

◆ pRemainingDisplayTime

float Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pRemainingDisplayTime

◆ pStyle [1/2]

StringID Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pStyle

◆ pStyle [2/2]

ECPStringID Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pStyle

◆ pSubTitle

ConversationPlaybackSubTitle Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pSubTitle

◆ pSubTitleText

SubTitleBoxText Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pSubTitleText

◆ pTimeout [1/2]

float Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pTimeout

◆ pTimeout [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pTimeout

◆ pWaitInConversation [1/2]

bool Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pWaitInConversation

◆ pWaitInConversation [2/2]

ECPBoolean Dragengine.Scenery.ECBehaviorActorTransmission.Instance.pWaitInConversation

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

ECBehaviorActorTransmission.ds

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addListener()

◆ addListenerFactory() [1/2]

◆ addListenerFactory() [2/2]

◆ addPart() [1/4]

◆ addPart() [2/4]

◆ addPart() [3/4]

◆ addPart() [4/4]

◆ advanceToNextPart()

◆ clear()

◆ createListeners()

◆ displayPart()

◆ dispose() [1/2]

◆ dispose() [2/2]

◆ forEachListenerFactory()

◆ getBehaviorIn()

◆ getBTSMs()

◆ getClearEnterConversation() [1/2]

◆ getClearEnterConversation() [2/2]

◆ getConversationActor() [1/2]

◆ getConversationActor() [2/2]

◆ getECBehavior()

◆ getPartAt()

◆ getPartCount()

◆ getPrefix()

◆ getRemainingDisplayTime()

◆ getStyle() [1/2]

◆ getStyle() [2/2]

◆ getSubTitle() [1/2]

◆ getSubTitle() [2/2]

◆ getSubTitleText()

◆ getTimeout() [1/2]

◆ getTimeout() [2/2]

◆ getWaitInConversation() [1/2]

◆ getWaitInConversation() [2/2]

◆ init()

◆ isRunning()

◆ new() [1/4]

◆ new() [2/4]

◆ new() [3/4]

◆ new() [4/4]

◆ onFinished()

◆ onPartDisplayed()

◆ onStarted()

◆ removeListener()

◆ setClearEnterConversation()

◆ setStyle()

◆ setSubTitle()

◆ setSubTitleText()

◆ setTimeout()

◆ setWaitInConversation()

◆ skipPart()

◆ think()

◆ writeToFile()

Member Data Documentation

◆ pBTSMs [1/2]

◆ pBTSMs [2/2]

◆ pClearEnterConversation [1/2]

◆ pClearEnterConversation [2/2]

◆ pConversationActor [1/2]

◆ pConversationActor [2/2]

◆ pECBehavior

◆ pListenerFactories

◆ pListeners

◆ pParts

◆ pPrefix

◆ pRemainingDisplayTime

◆ pStyle [1/2]

◆ pStyle [2/2]

◆ pSubTitle

◆ pSubTitleText

◆ pTimeout [1/2]

◆ pTimeout [2/2]

◆ pWaitInConversation [1/2]

◆ pWaitInConversation [2/2]