Drag[en]gine Script Module DragonScript  1.23
Dragengine.ConversationSystem.CActionActorSpeak Class Reference

Conversation action making actors speak. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionActorSpeak:
Dragengine.ConversationSystem.ConversationAction Dragengine.LoadSave.Persistable

Classes

class  Factory
 Factory for loading actor actions. More...
 

Public Member Functions

void addBodyLookAt (ConversationStrip lookAt)
 Adds a body look-at. More...
 
void addEyesLookAt (ConversationStrip lookAt)
 Adds a eyes look-at. More...
 
void addFacePose (ConversationStrip facePose)
 Add face pose. More...
 
void addGesture (ConversationStrip gesture)
 Adds a gesture. More...
 
void addHeadLookAt (ConversationStrip lookAt)
 Adds a head look-at. More...
 
void addWord (ConversationStrip word)
 Add word. More...
 
void execute (ConversationPlayback playback)
 Execute action. More...
 
void executeGesture (ConversationPlayback playback, ConversationActor actor)
 Execute gesture. More...
 
float executeSpeechAnimation (ConversationPlayback playback, ConversationActor actor)
 Execute speech animation. More...
 
float executeVoiceSound (ConversationPlayback playback, ConversationActor actor)
 Execute voice sound. More...
 
void forEachBodyLookAt (Block aBlock)
 Visits all body look-ats. More...
 
void forEachEyesLookAt (Block aBlock)
 Visits all eyes look-ats. More...
 
void forEachFacePose (Block aBlock)
 Visits all face poses. More...
 
void forEachGesture (Block aBlock)
 Visits all gestures. More...
 
void forEachHeadLookAt (Block aBlock)
 Visits all head look-ats. More...
 
void forEachWord (Block aBlock)
 Visits all words. More...
 
StringID getActorID ()
 Actor ID or null if not set. More...
 
float getMinSpeechTime ()
 Minimum time the actor is speaking. More...
 
String getPathSound ()
 Path to the sound file or null to not play sound. More...
 
Sound getSound ()
 Sound file loading it if not loaded already. More...
 
UnicodeString getTextBoxText ()
 Text box text or null to not set the text. More...
 
StringID getTextBoxTextStyle ()
 Text box text style id. More...
 
String getTextBoxTextTranslate ()
 Translated text box text or null to use regular text box text. More...
 
bool getUseSpeechAnimation ()
 Speech animation is used for this action. More...
 
CActionActorSpeak new ()
 Create conversation action. More...
 
CActionActorSpeak new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void playVoiceAudio (ConversationActor actor, Sound sound)
 Play back a sound file as voice of a conversation actor. More...
 
void setActorID (StringID id)
 Set actor ID or null if not set. More...
 
void setMinSpeechTime (float minSpeechTime)
 Set minimum time the actor is speaking. More...
 
void setPathSound (String path)
 Set path to the sound file or null to not play sound. More...
 
void setTextBoxText (UnicodeString text)
 Set text box text or null to not set the text. More...
 
void setTextBoxTextStyle (StringID styleID)
 Set text box text style. More...
 
void setTextBoxTextTranslate (String name)
 Set translated text box text or null to use regular text box text. More...
 
void setUseSpeechAnimation (bool useSpeechAnimation)
 Set if speech animation is used for this action. More...
 
- Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float getDelay ()
 Delay in seconds before processing this action. More...
 
bool getWaitForActor ()
 Wait for actor. More...
 
String getWaitForActorID ()
 ID of actor to wait for or null to wait for all actors. More...
 
void setDelay (float delay)
 Set delay in seconds before processing this action. More...
 
void setWaitForActor (bool wait)
 Set wait for actor. More...
 
void setWaitForActorID (String id)
 Set ID of actor to wait for or null to wait for all actors. More...
 
- Public Member Functions inherited from Dragengine.LoadSave.Persistable
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object from file. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 

Public Attributes

StringID pActorID
 
Array pBodyLookAts
 
Array pEyesLookAts
 
Array pFacePoses
 
Array pGestures
 
Array pHeadLookAts
 
float pMinSpeechTime
 
String pPathSound
 
Sound pSound
 
UnicodeString pTextBoxText
 
StringID pTextBoxTextStyle
 
String pTextBoxTextTranslate
 
bool pUseSpeechAnimation
 
Array pWords
 
- Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float pDelay
 Delay before processing the action. More...
 
bool pWaitForActor
 Wait for actor. More...
 
String pWaitForActorID
 ID of actor to wait for or null to wait for all actors. More...
 

Protected Member Functions

void readV0 (PersistencyEnvironment env, FileReader reader)
 

Detailed Description

Conversation action making actors speak.

Member Function Documentation

◆ addBodyLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.addBodyLookAt ( ConversationStrip  lookAt)

Adds a body look-at.

◆ addEyesLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.addEyesLookAt ( ConversationStrip  lookAt)

Adds a eyes look-at.

◆ addFacePose()

void Dragengine.ConversationSystem.CActionActorSpeak.addFacePose ( ConversationStrip  facePose)

Add face pose.

◆ addGesture()

void Dragengine.ConversationSystem.CActionActorSpeak.addGesture ( ConversationStrip  gesture)

Adds a gesture.

◆ addHeadLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.addHeadLookAt ( ConversationStrip  lookAt)

Adds a head look-at.

◆ addWord()

void Dragengine.ConversationSystem.CActionActorSpeak.addWord ( ConversationStrip  word)

Add word.

◆ execute()

void Dragengine.ConversationSystem.CActionActorSpeak.execute ( ConversationPlayback  playback)

Execute action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ executeGesture()

void Dragengine.ConversationSystem.CActionActorSpeak.executeGesture ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute gesture.

◆ executeSpeechAnimation()

float Dragengine.ConversationSystem.CActionActorSpeak.executeSpeechAnimation ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute speech animation.

Returns
speech time or 0 if no sound is played.

◆ executeVoiceSound()

float Dragengine.ConversationSystem.CActionActorSpeak.executeVoiceSound ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute voice sound.

Returns
speech time or 0 if no sound is played.

◆ forEachBodyLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachBodyLookAt ( Block  aBlock)

Visits all body look-ats.

◆ forEachEyesLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachEyesLookAt ( Block  aBlock)

Visits all eyes look-ats.

◆ forEachFacePose()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachFacePose ( Block  aBlock)

Visits all face poses.

◆ forEachGesture()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachGesture ( Block  aBlock)

Visits all gestures.

◆ forEachHeadLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachHeadLookAt ( Block  aBlock)

Visits all head look-ats.

◆ forEachWord()

void Dragengine.ConversationSystem.CActionActorSpeak.forEachWord ( Block  aBlock)

Visits all words.

◆ getActorID()

StringID Dragengine.ConversationSystem.CActionActorSpeak.getActorID ( )

Actor ID or null if not set.

◆ getMinSpeechTime()

float Dragengine.ConversationSystem.CActionActorSpeak.getMinSpeechTime ( )

Minimum time the actor is speaking.

◆ getPathSound()

String Dragengine.ConversationSystem.CActionActorSpeak.getPathSound ( )

Path to the sound file or null to not play sound.

◆ getSound()

Sound Dragengine.ConversationSystem.CActionActorSpeak.getSound ( )

Sound file loading it if not loaded already.

◆ getTextBoxText()

UnicodeString Dragengine.ConversationSystem.CActionActorSpeak.getTextBoxText ( )

Text box text or null to not set the text.

◆ getTextBoxTextStyle()

StringID Dragengine.ConversationSystem.CActionActorSpeak.getTextBoxTextStyle ( )

Text box text style id.

◆ getTextBoxTextTranslate()

String Dragengine.ConversationSystem.CActionActorSpeak.getTextBoxTextTranslate ( )

Translated text box text or null to use regular text box text.

Version
1.16

◆ getUseSpeechAnimation()

bool Dragengine.ConversationSystem.CActionActorSpeak.getUseSpeechAnimation ( )

Speech animation is used for this action.

◆ new() [1/2]

CActionActorSpeak Dragengine.ConversationSystem.CActionActorSpeak.new ( )

Create conversation action.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ new() [2/2]

CActionActorSpeak Dragengine.ConversationSystem.CActionActorSpeak.new ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

Reimplemented from Dragengine.ConversationSystem.ConversationAction.

◆ playVoiceAudio()

void Dragengine.ConversationSystem.CActionActorSpeak.playVoiceAudio ( ConversationActor  actor,
Sound  sound 
)

Play back a sound file as voice of a conversation actor.

◆ readV0()

void Dragengine.ConversationSystem.CActionActorSpeak.readV0 ( PersistencyEnvironment  env,
FileReader  reader 
)
protected

◆ setActorID()

void Dragengine.ConversationSystem.CActionActorSpeak.setActorID ( StringID  id)

Set actor ID or null if not set.

◆ setMinSpeechTime()

void Dragengine.ConversationSystem.CActionActorSpeak.setMinSpeechTime ( float  minSpeechTime)

Set minimum time the actor is speaking.

◆ setPathSound()

void Dragengine.ConversationSystem.CActionActorSpeak.setPathSound ( String  path)

Set path to the sound file or null to not play sound.

◆ setTextBoxText()

void Dragengine.ConversationSystem.CActionActorSpeak.setTextBoxText ( UnicodeString  text)

Set text box text or null to not set the text.

◆ setTextBoxTextStyle()

void Dragengine.ConversationSystem.CActionActorSpeak.setTextBoxTextStyle ( StringID  styleID)

Set text box text style.

◆ setTextBoxTextTranslate()

void Dragengine.ConversationSystem.CActionActorSpeak.setTextBoxTextTranslate ( String  name)

Set translated text box text or null to use regular text box text.

Version
1.16

◆ setUseSpeechAnimation()

void Dragengine.ConversationSystem.CActionActorSpeak.setUseSpeechAnimation ( bool  useSpeechAnimation)

Set if speech animation is used for this action.

Member Data Documentation

◆ pActorID

StringID Dragengine.ConversationSystem.CActionActorSpeak.pActorID

◆ pBodyLookAts

Array Dragengine.ConversationSystem.CActionActorSpeak.pBodyLookAts

◆ pEyesLookAts

Array Dragengine.ConversationSystem.CActionActorSpeak.pEyesLookAts

◆ pFacePoses

Array Dragengine.ConversationSystem.CActionActorSpeak.pFacePoses

◆ pGestures

Array Dragengine.ConversationSystem.CActionActorSpeak.pGestures

◆ pHeadLookAts

Array Dragengine.ConversationSystem.CActionActorSpeak.pHeadLookAts

◆ pMinSpeechTime

float Dragengine.ConversationSystem.CActionActorSpeak.pMinSpeechTime

◆ pPathSound

String Dragengine.ConversationSystem.CActionActorSpeak.pPathSound

◆ pSound

Sound Dragengine.ConversationSystem.CActionActorSpeak.pSound

◆ pTextBoxText

UnicodeString Dragengine.ConversationSystem.CActionActorSpeak.pTextBoxText

◆ pTextBoxTextStyle

StringID Dragengine.ConversationSystem.CActionActorSpeak.pTextBoxTextStyle

◆ pTextBoxTextTranslate

String Dragengine.ConversationSystem.CActionActorSpeak.pTextBoxTextTranslate

◆ pUseSpeechAnimation

bool Dragengine.ConversationSystem.CActionActorSpeak.pUseSpeechAnimation

◆ pWords

Array Dragengine.ConversationSystem.CActionActorSpeak.pWords

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