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

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorActorTransmission.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Classes

class  WaitInConversation
 Wait in conversation if running. More...
 

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
void addPart (UnicodeString text)
 Add transmission part. More...
 
void addPart (UnicodeString text, float timeout)
 Add transmission part. More...
 
void addPart (UnicodeString text, StringID style)
 Add transmission part. More...
 
void addPart (UnicodeString text, StringID style, float timeout)
 Add transmission part. More...
 
void clear ()
 Clear all parts and hide subtitle. More...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
bool getClearEnterConversation ()
 Clear transmission upon entering conversation. More...
 
ECPBoolean getClearEnterConversation ()
 Clear transmission upon entering conversation. More...
 
ECBehaviorConversationActor.Instance getConversationActor ()
 Conversation actor behavior. More...
 
ECBehaviorConversationActor getConversationActor ()
 Conversation actor behavior to animate. More...
 
ECBehaviorActorTransmission getECBehavior ()
 Behavior. More...
 
Part getPartAt (int index)
 Part at index. More...
 
int getPartCount ()
 Count of parts. More...
 
StringID getStyle ()
 Style to use. More...
 
ECPStringID getStyle ()
 Style. More...
 
ConversationPlaybackSubTitle getSubTitle ()
 Sub title. More...
 
SubTitleBoxText getSubTitleText ()
 Sub title text or null if not set. More...
 
float getTimeout ()
 Timeout in seconds to display each part. More...
 
ECPFloat getTimeout ()
 Timeout. More...
 
bool getWaitInConversation ()
 Wait in conversation is enabled. More...
 
ECPBoolean getWaitInConversation ()
 Enable wait in conversation. More...
 
void init (StubElement stub)
 Initialize behavior from stub. More...
 
bool isRunning ()
 Transmission is running. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor)
 Create behavior element class. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor, ConversationPlaybackSubTitle subTitle)
 Create behavior element class. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorConversationActor conversationActor, ConversationPlaybackSubTitle subTitle, String prefix)
 Create behavior element class. More...
 
Instance new (ECBehaviorActorTransmission ecbehavior, BehaviorElement element)
 Create behavior instance. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setClearEnterConversation (bool clearEnterConversation)
 Set to clear transmission upon entering conversation. More...
 
void setStyle (StringID style)
 Set style to use. More...
 
void setSubTitle (ConversationPlaybackSubTitle subTitle)
 Set sub title. More...
 
void setTimeout (float timeout)
 Set timeout in seconds to display each part. More...
 
void setWaitInConversation (bool waitInConversation)
 Set to wait in conversation is enabled. More...
 
void think (float elapsed)
 Frame update. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior to file. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void addToGameWorld ()
 Add element to game world. More...
 
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void enterFrame ()
 Frame update started. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior instance from file. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 

Static Public Member Functions

static ECBehaviorActorTransmission getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

bool pClearEnterConversation
 
ECPBoolean pClearEnterConversation
 
ECBehaviorConversationActor.Instance pConversationActor
 
ECBehaviorConversationActor pConversationActor
 
ECBehaviorActorTransmission pECBehavior
 
Array pListenerFactories
 
Array pListeners
 
Array pParts
 
float pRemainingDisplayTime
 
StringID pStyle
 
ECPStringID pStyle
 
ConversationPlaybackSubTitle pSubTitle
 
SubTitleBoxText pSubTitleText
 
float pTimeout
 
ECPFloat pTimeout
 
bool pWaitInConversation
 
ECPBoolean pWaitInConversation
 

Protected Member Functions

void displayPart (Part part)
 Display part. More...
 
void onFinished ()
 Transmission finished. More...
 
void onPartDisplayed (Part part)
 Part displayed. More...
 
void onStarted ()
 Transmission started. More...
 
void setSubTitleText (SubTitleBoxText text)
 Set sub title text or null to clear it. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

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
textText 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
textText to speak.
timeoutTime 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
textText to speak.
styleIdentifier 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
textText to speak.
styleIdentifier of style to adjust font, color or sub title in general or null.
timeoutTime in seconds to display transmission part.

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

◆ 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

◆ getStyle() [1/2]

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

Style to use.

◆ getStyle() [2/2]

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

Style.

◆ getSubTitle()

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.

◆ 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

◆ 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

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