Drag[en]gine Script Module DragonScript Script API  1.0
CActionActorSpeak Class Reference
Inheritance diagram for CActionActorSpeak:
ConversationAction

Public Member Functions

void addBodyLookAt (ConversationStrip lookAt)
 
void addEyesLookAt (ConversationStrip lookAt)
 
void addFacePose (ConversationStrip facePose)
 
void addGesture (ConversationStrip gesture)
 
void addHeadLookAt (ConversationStrip lookAt)
 
void addWord (ConversationStrip word)
 
void execute (ConversationPlayback playback)
 
void executeEyesLookAt (ConversationPlayback playback, ConversationActor actor)
 
void executeFacePose (ConversationPlayback playback, ConversationActor actor)
 
void executeGesture (ConversationPlayback playback, ConversationActor actor)
 
void executeHeadLookAt (ConversationPlayback playback, ConversationActor actor)
 
float executeSpeechAnimation (ConversationPlayback playback, ConversationActor actor)
 Execute speech animation. More...
 
void executeSubTitle (ConversationPlayback playback, ConversationActor actor, float speechTime)
 
float executeVoiceSound (ConversationPlayback playback, ConversationActor actor)
 Execute voice sound. More...
 
void forEachBodyLookAt (Block aBlock)
 
void forEachEyesLookAt (Block aBlock)
 
void forEachFacePose (Block aBlock)
 
void forEachGesture (Block aBlock)
 
void forEachHeadLookAt (Block aBlock)
 
void forEachWord (Block aBlock)
 
StringID getActorID ()
 
int getActorIndex ()
 
float getMinSpeechTime ()
 
String getPathSound ()
 
Sound getSound ()
 
UnicodeString getTextBoxText ()
 
StringID getTextBoxTextStyle ()
 
bool getUseSpeechAnimation ()
 
CActionActorSpeak new ()
 
void playVoiceAudio (ConversationActor actor, Sound sound)
 
void setActorID (StringID id)
 
void setActorIndex (int index)
 
void setMinSpeechTime (float minSpeechTime)
 
void setPathSound (String path)
 
void setTextBoxText (UnicodeString text)
 
void setTextBoxTextStyle (StringID styleID)
 
void setUseSpeechAnimation (bool useSpeechAnimation)
 
- Public Member Functions inherited from ConversationAction
void dispose ()
 
void execute (ConversationPlayback playback)
 
Array getActionsForSaveID (int saveID)
 
float getDelay ()
 
int getSaveIDForActions (Array actions)
 
int getWaitForActorSpeak ()
 
ConversationAction new ()
 
void setDelay (float delay)
 
void setWaitForActorSpeak (int actor)
 

Detailed Description

Conversation action making actors speak.

Author
Roland Pl├╝ss
Version
1.0

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)

Adds a 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)

Adds a word.

§ execute()

void execute ( ConversationPlayback  playback)

Execute the 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 ( )

Retrieves the actor ID or null if not set.

§ getActorIndex()

int getActorIndex ( )

Retrieves the actor index or -1 if not set.

§ getMinSpeechTime()

float getMinSpeechTime ( )

Retrieves the minimum time the actor is speaking.

§ getPathSound()

String getPathSound ( )

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

§ getSound()

Sound getSound ( )

Retrieves the sound file loading it if not loaded already.

§ getTextBoxText()

UnicodeString getTextBoxText ( )

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

§ getTextBoxTextStyle()

StringID getTextBoxTextStyle ( )

Retrieves the text box text style id.

§ getUseSpeechAnimation()

bool getUseSpeechAnimation ( )

Determines if speech animation is used for this action.

§ new()

Create a new conversation action.

§ playVoiceAudio()

void playVoiceAudio ( ConversationActor  actor,
Sound  sound 
)

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

§ setActorID()

void setActorID ( StringID  id)

Sets the actor ID or null if not set.

§ setActorIndex()

void setActorIndex ( int  index)

Sets the actor index or -1 if not set.

§ setMinSpeechTime()

void setMinSpeechTime ( float  minSpeechTime)

Sets the minimum time the actor is speaking.

§ setPathSound()

void setPathSound ( String  path)

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

§ setTextBoxText()

void setTextBoxText ( UnicodeString  text)

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

§ setTextBoxTextStyle()

void setTextBoxTextStyle ( StringID  styleID)

Sets the text box text style.

§ setUseSpeechAnimation()

void setUseSpeechAnimation ( bool  useSpeechAnimation)

Sets if speech animation is used for this action.


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