Drag[en]gine Script Module DragonScript Script API  1.0
CActionActorSpeak Class Reference

Conversation action making actors speak. More...

Inheritance diagram for CActionActorSpeak:
ConversationAction 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 executeEyesLookAt (ConversationPlayback playback, ConversationActor actor)
 Execute eyes look-at. More...
 
void executeFacePose (ConversationPlayback playback, ConversationActor actor)
 Execute face pose. More...
 
void executeGesture (ConversationPlayback playback, ConversationActor actor)
 Execute gesture. More...
 
void executeHeadLookAt (ConversationPlayback playback, ConversationActor actor)
 Execute head look-at. More...
 
float executeSpeechAnimation (ConversationPlayback playback, ConversationActor actor)
 Execute speech animation. More...
 
void executeSubTitle (ConversationPlayback playback, ConversationActor actor, float speechTime)
 Execute sub title. 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...
 
int getActorIndex ()
 Actor index or -1 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...
 
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...
 
String persistencyFactoryName ()
 Name of PersistencyFactory required to load object 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 setActorIndex (int index)
 Set actor index or -1 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 setUseSpeechAnimation (bool useSpeechAnimation)
 Set if speech animation is used for this action. More...
 
void writeObjectToFile (PersistencyEnvironment env, FileWriter writer)
 Write object to file writer. More...
 
- Public Member Functions inherited from ConversationAction
void dispose ()
 Dispose of action. More...
 
void execute (ConversationPlayback playback)
 Execute the action. More...
 
float getDelay ()
 Delay in seconds before processing this action. More...
 
int getWaitForActorSpeak ()
 Actor to wait speaking for or -1 for no wait. More...
 
ConversationAction new ()
 Create conversation action. More...
 
ConversationAction new (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void setDelay (float delay)
 Set delay in seconds before processing this action. More...
 
void setWaitForActorSpeak (int actor)
 Set actor to wait speaking for or -1 for no wait. More...
 

Detailed Description

Conversation action making actors speak.

Member Function Documentation

◆ addBodyLookAt()

void addBodyLookAt ( ConversationStrip  lookAt)

Adds a body look-at.

◆ addEyesLookAt()

void addEyesLookAt ( ConversationStrip  lookAt)

Adds a eyes look-at.

◆ addFacePose()

void addFacePose ( ConversationStrip  facePose)

Add face pose.

◆ addGesture()

void addGesture ( ConversationStrip  gesture)

Adds a gesture.

◆ addHeadLookAt()

void addHeadLookAt ( ConversationStrip  lookAt)

Adds a head look-at.

◆ addWord()

void addWord ( ConversationStrip  word)

Add word.

◆ execute()

void execute ( ConversationPlayback  playback)

Execute action.

◆ executeEyesLookAt()

void executeEyesLookAt ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute eyes look-at.

◆ executeFacePose()

void executeFacePose ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute face pose.

◆ executeGesture()

void executeGesture ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute gesture.

◆ executeHeadLookAt()

void executeHeadLookAt ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute head look-at.

◆ executeSpeechAnimation()

float executeSpeechAnimation ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute speech animation.

Returns
speech time or 0 if no sound is played.

◆ executeSubTitle()

void executeSubTitle ( ConversationPlayback  playback,
ConversationActor  actor,
float  speechTime 
)

Execute sub title.

◆ executeVoiceSound()

float executeVoiceSound ( ConversationPlayback  playback,
ConversationActor  actor 
)

Execute voice sound.

Returns
speech time or 0 if no sound is played.

◆ forEachBodyLookAt()

void forEachBodyLookAt ( Block  aBlock)

Visits all body look-ats.

◆ forEachEyesLookAt()

void forEachEyesLookAt ( Block  aBlock)

Visits all eyes look-ats.

◆ forEachFacePose()

void forEachFacePose ( Block  aBlock)

Visits all face poses.

◆ forEachGesture()

void forEachGesture ( Block  aBlock)

Visits all gestures.

◆ forEachHeadLookAt()

void forEachHeadLookAt ( Block  aBlock)

Visits all head look-ats.

◆ forEachWord()

void forEachWord ( Block  aBlock)

Visits all words.

◆ getActorID()

StringID getActorID ( )

Actor ID or null if not set.

◆ getActorIndex()

int getActorIndex ( )

Actor index or -1 if not set.

◆ getMinSpeechTime()

float getMinSpeechTime ( )

Minimum time the actor is speaking.

◆ getPathSound()

String getPathSound ( )

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

◆ getSound()

Sound getSound ( )

Sound file loading it if not loaded already.

◆ getTextBoxText()

UnicodeString getTextBoxText ( )

Text box text or null to not set the text.

◆ getTextBoxTextStyle()

StringID getTextBoxTextStyle ( )

Text box text style id.

◆ getUseSpeechAnimation()

bool getUseSpeechAnimation ( )

Speech animation is used for this action.

◆ new() [1/2]

Create conversation action.

◆ new() [2/2]

Read from file.

◆ persistencyFactoryName()

String persistencyFactoryName ( )

Name of PersistencyFactory required to load object from file.

Name of PersistencyFactory is first written to the file as string with 8-bit length. Then writeToFile() is called to write the object itself. Empty name is not allowed as is names longer than 255 characters. Name has to match a PersistencyFactory present in the Persistency instance used for loading objects. Object is read using PersistencyFactory.readObjectFromFile() of the matching PersistencyFactory.

Implements Persistable.

◆ playVoiceAudio()

void playVoiceAudio ( ConversationActor  actor,
Sound  sound 
)

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

◆ setActorID()

void setActorID ( StringID  id)

Set actor ID or null if not set.

◆ setActorIndex()

void setActorIndex ( int  index)

Set actor index or -1 if not set.

◆ setMinSpeechTime()

void setMinSpeechTime ( float  minSpeechTime)

Set minimum time the actor is speaking.

◆ setPathSound()

void setPathSound ( String  path)

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

◆ setTextBoxText()

void setTextBoxText ( UnicodeString  text)

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

◆ setTextBoxTextStyle()

void setTextBoxTextStyle ( StringID  styleID)

Set text box text style.

◆ setUseSpeechAnimation()

void setUseSpeechAnimation ( bool  useSpeechAnimation)

Set if speech animation is used for this action.

◆ writeObjectToFile()

void writeObjectToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write object to file writer.

Implements Persistable.


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