Conversation action making actors speak. More...

Inheritance diagram for Dragengine.ConversationSystem.CActionActorSpeak:

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

Public Member Functions
void	addBodyLookAt (ConversationStrip lookAt)
	Adds a body look-at.

void	addEyesLookAt (ConversationStrip lookAt)
	Adds a eyes look-at.

void	addFacePose (ConversationStrip facePose)
	Add face pose.

void	addGesture (ConversationStrip gesture)
	Adds a gesture.

void	addHeadLookAt (ConversationStrip lookAt)
	Adds a head look-at.

void	addWord (ConversationStrip word)
	Add word.

void	execute (ConversationPlayback playback)
	Execute action.

void	executeGesture (ConversationPlayback playback, ConversationActor actor)
	Execute gesture.

float	executeSpeechAnimation (ConversationPlayback playback, ConversationActor actor)
	Execute speech animation.

float	executeVoiceSound (ConversationPlayback playback, ConversationActor actor)
	Execute voice sound.

void	forEachBodyLookAt (Block aBlock)
	Visits all body look-ats.

void	forEachEyesLookAt (Block aBlock)
	Visits all eyes look-ats.

void	forEachFacePose (Block aBlock)
	Visits all face poses.

void	forEachGesture (Block aBlock)
	Visits all gestures.

void	forEachHeadLookAt (Block aBlock)
	Visits all head look-ats.

void	forEachWord (Block aBlock)
	Visits all words.

StringID	getActorID ()
	Actor ID or null if not set.

int	getBodyLookAtCount ()
	Count of body look-ats.

int	getEyeLookAtCount ()
	Count of eye look-ats.

int	getFacePoseCount ()
	Count of face poses.

int	getGestureCount ()
	Count of gestures.

int	getHeadLookAtCount ()
	Count of head look-ats.

float	getMinSpeechTime ()
	Minimum time the actor is speaking.

float	getMissingPhonemeLength ()
	Length to use for missing phoneme.

String	getPathSound ()
	Path to the sound file or null to not play sound.

Sound	getSound ()
	Sound file loading it if not loaded already.

UnicodeString	getTextBoxText ()
	Text box text or null to not set the text.

StringID	getTextBoxTextStyle ()
	Text box text style id.

String	getTextBoxTextTranslate ()
	Translated text box text or null to use regular text box text.

bool	getUseSpeechAnimation ()
	Speech animation is used for this action.

int	getWordCount ()
	Count of words.

CActionActorSpeak	new ()
	Create conversation action.

CActionActorSpeak	new (PersistencyEnvironment env, FileReader reader)
	Read from file.

void	playVoiceAudio (ConversationActor actor, Sound sound)
	Play back a sound file as voice of a conversation actor.

void	removeAllBodyLookAt ()
	Remove all body look-at.

void	removeAllEyeLookAt ()
	Remove all eye look-at.

void	removeAllFacePoses ()
	Remove all face poses.

void	removeAllGestures ()
	Remove all gestues.

void	removeAllHeadLookAt ()
	Remove all head look-at.

void	removeAllWords ()
	Remove all words.

void	setActorID (StringID id)
	Set actor ID or null if not set.

void	setMinSpeechTime (float minSpeechTime)
	Set minimum time the actor is speaking.

void	setMissingPhonemeLength (float length)
	Set length to use for missing phoneme.

void	setPathSound (String path)
	Set path to the sound file or null to not play sound.

void	setTextBoxText (UnicodeString text)
	Set text box text or null to not set the text.

void	setTextBoxTextStyle (StringID styleID)
	Set text box text style.

void	setTextBoxTextTranslate (String name)
	Set translated text box text or null to use regular text box text.

void	setUseSpeechAnimation (bool useSpeechAnimation)
	Set if speech animation is used for this action.

Public Member Functions inherited from Dragengine.ConversationSystem.ConversationAction
float	getDelay ()
	Delay in seconds before processing this action.

bool	getWaitForActor ()
	Wait for actor.

String	getWaitForActorID ()
	ID of actor to wait for or null to wait for all actors.

bool	getWaitSpeakOnly ()
	Waiting considers only actor speaking not actor waiting.

void	setDelay (float delay)
	Set delay in seconds before processing this action.

void	setWaitForActor (bool wait)
	Set wait for actor.

void	setWaitForActorID (String id)
	Set ID of actor to wait for or null to wait for all actors.

void	setWaitSpeakOnly (bool speakOnly)
	Set waiting considers only actor speaking not actor waiting.

Public Attributes
StringID	pActorID

Array	pBodyLookAts

Array	pEyesLookAts

Array	pFacePoses

Array	pGestures

Array	pHeadLookAts

float	pMinSpeechTime

float	pMissingPhonemeLength

String	pPathSound

Sound	pSound

UnicodeString	pTextBoxText

StringID	pTextBoxTextStyle

String	pTextBoxTextTranslate

bool	pUseSpeechAnimation

Array	pWords

Public Attributes inherited from Dragengine.ConversationSystem.ConversationAction
float	pDelay

bool	pWaitForActor

String	pWaitForActorID

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.

◆ getBodyLookAtCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getBodyLookAtCount ( )

Count of body look-ats.

Version: 1.25

◆ getEyeLookAtCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getEyeLookAtCount ( )

Count of eye look-ats.

Version: 1.25

◆ getFacePoseCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getFacePoseCount ( )

Count of face poses.

Version: 1.25

◆ getGestureCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getGestureCount ( )

Count of gestures.

Version: 1.25

◆ getHeadLookAtCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getHeadLookAtCount ( )

Count of head look-ats.

Version: 1.25

◆ getMinSpeechTime()

float Dragengine.ConversationSystem.CActionActorSpeak.getMinSpeechTime ( )

Minimum time the actor is speaking.

◆ getMissingPhonemeLength()

float Dragengine.ConversationSystem.CActionActorSpeak.getMissingPhonemeLength ( )

Length to use for missing phoneme.

Version: 1.25

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

◆ getWordCount()

int Dragengine.ConversationSystem.CActionActorSpeak.getWordCount ( )

Count of words.

Version: 1.25

◆ 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

◆ removeAllBodyLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllBodyLookAt ( )

Remove all body look-at.

Version: 1.25

◆ removeAllEyeLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllEyeLookAt ( )

Remove all eye look-at.

Version: 1.25

◆ removeAllFacePoses()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllFacePoses ( )

Remove all face poses.

Version: 1.25

◆ removeAllGestures()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllGestures ( )

Remove all gestues.

Version: 1.25

◆ removeAllHeadLookAt()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllHeadLookAt ( )

Remove all head look-at.

Version: 1.25

◆ removeAllWords()

void Dragengine.ConversationSystem.CActionActorSpeak.removeAllWords ( )

Remove all words.

Version: 1.25

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

◆ setMissingPhonemeLength()

void Dragengine.ConversationSystem.CActionActorSpeak.setMissingPhonemeLength ( float length )

Set length to use for missing phoneme.

Version: 1.25

◆ 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

◆ pMissingPhonemeLength

float Dragengine.ConversationSystem.CActionActorSpeak.pMissingPhonemeLength

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

CActionActorSpeak.ds

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addBodyLookAt()

◆ addEyesLookAt()

◆ addFacePose()

◆ addGesture()

◆ addHeadLookAt()

◆ addWord()

◆ execute()

◆ executeGesture()

◆ executeSpeechAnimation()

◆ executeVoiceSound()

◆ forEachBodyLookAt()

◆ forEachEyesLookAt()

◆ forEachFacePose()

◆ forEachGesture()

◆ forEachHeadLookAt()

◆ forEachWord()

◆ getActorID()

◆ getBodyLookAtCount()

◆ getEyeLookAtCount()

◆ getFacePoseCount()

◆ getGestureCount()

◆ getHeadLookAtCount()

◆ getMinSpeechTime()

◆ getMissingPhonemeLength()

◆ getPathSound()

◆ getSound()

◆ getTextBoxText()

◆ getTextBoxTextStyle()

◆ getTextBoxTextTranslate()

◆ getUseSpeechAnimation()

◆ getWordCount()

◆ new() [1/2]

◆ new() [2/2]

◆ playVoiceAudio()

◆ readV0()

◆ removeAllBodyLookAt()

◆ removeAllEyeLookAt()

◆ removeAllFacePoses()

◆ removeAllGestures()

◆ removeAllHeadLookAt()

◆ removeAllWords()

◆ setActorID()

◆ setMinSpeechTime()

◆ setMissingPhonemeLength()

◆ setPathSound()

◆ setTextBoxText()

◆ setTextBoxTextStyle()

◆ setTextBoxTextTranslate()

◆ setUseSpeechAnimation()

Member Data Documentation

◆ pActorID

◆ pBodyLookAts

◆ pEyesLookAts

◆ pFacePoses

◆ pGestures

◆ pHeadLookAts

◆ pMinSpeechTime

◆ pMissingPhonemeLength

◆ pPathSound

◆ pSound

◆ pTextBoxText

◆ pTextBoxTextStyle

◆ pTextBoxTextTranslate

◆ pUseSpeechAnimation

◆ pWords