Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Dragengine.ConversationSystem.SimpleConversationActor Class Reference

Simple conversation actor definition. More...

Inheritance diagram for Dragengine.ConversationSystem.SimpleConversationActor:

Public Member Functions

void addGesture (StringID gesture)
 Add gesture.
 
void forEachGesture (Block ablock)
 Visit gestures with block.
 
StringID getActorId ()
 Conversation actor identifier or alias.
 
StringID getCamera ()
 Identifier of camera to switch to.
 
float getDelay ()
 Delay in seconds before activating action.
 
StringID getFacePose ()
 Face pose or null.
 
StringID getGestureAt (int index)
 Gesture at index.
 
int getGestureCount ()
 Count of gestures.
 
StringID getId ()
 Identifier.
 
StringID getLookAt ()
 Look-at or null.
 
float getProlongLastGesture ()
 Amount of seconds to prolong last gesture beyond end of speech.
 
StringID getStyle ()
 Text box text style or null.
 
bool getUseSpeechAnimation ()
 Speech animation is used for this action.
 
SimpleConversationActor new (SimpleConversationActor actor)
 Create copy of simple conversation camera definition.
 
SimpleConversationActor new (StringID id)
 Create simple conversation camera definition.
 
void setActorId (StringID identifier)
 Set conversation actor identifier or alias.
 
void setCamera (StringID camera)
 Set identifier of camera to switch to.
 
void setDelay (float seconds)
 Set delay in seconds before activating action.
 
void setFacePose (StringID facePose)
 Set face pose or null.
 
void setLookAt (StringID lookAt)
 Set look-at or null.
 
void setProlongLastGesture (float seconds)
 Set amount of seconds to prolong last gesture beyond end of speech.
 
void setStyle (StringID style)
 Set text box text style or null.
 
void setUseSpeechAnimation (bool useSpeechAnimation)
 Set if speech animation is used for this action.
 

Public Attributes

StringID pActorId
 
StringID pCamera
 
float pDelay
 
StringID pFacePose
 
Array pGestures
 
StringID pId
 
StringID pStyle
 
bool pUseSpeechAnimation
 

Detailed Description

Simple conversation actor definition.

Version
1.25

Defines initial parameters to use when switching to an actor speaking.

Member Function Documentation

◆ addGesture()

void Dragengine.ConversationSystem.SimpleConversationActor.addGesture ( StringID  gesture)

Add gesture.

◆ forEachGesture()

void Dragengine.ConversationSystem.SimpleConversationActor.forEachGesture ( Block  ablock)

Visit gestures with block.

Block is required to have signature void(StringID gesture) or void(int index, StringID gesture).

◆ getActorId()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getActorId ( )

Conversation actor identifier or alias.

◆ getCamera()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getCamera ( )

Identifier of camera to switch to.

◆ getDelay()

float Dragengine.ConversationSystem.SimpleConversationActor.getDelay ( )

Delay in seconds before activating action.

Default value is 0.25.

◆ getFacePose()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getFacePose ( )

Face pose or null.

◆ getGestureAt()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getGestureAt ( int  index)

Gesture at index.

◆ getGestureCount()

int Dragengine.ConversationSystem.SimpleConversationActor.getGestureCount ( )

Count of gestures.

◆ getId()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getId ( )

Identifier.

◆ getLookAt()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getLookAt ( )

Look-at or null.

◆ getProlongLastGesture()

float Dragengine.ConversationSystem.SimpleConversationActor.getProlongLastGesture ( )

Amount of seconds to prolong last gesture beyond end of speech.

Default value is 0.25.

◆ getStyle()

StringID Dragengine.ConversationSystem.SimpleConversationActor.getStyle ( )

Text box text style or null.

◆ getUseSpeechAnimation()

bool Dragengine.ConversationSystem.SimpleConversationActor.getUseSpeechAnimation ( )

Speech animation is used for this action.

◆ new() [1/2]

SimpleConversationActor Dragengine.ConversationSystem.SimpleConversationActor.new ( SimpleConversationActor  actor)

Create copy of simple conversation camera definition.

◆ new() [2/2]

SimpleConversationActor Dragengine.ConversationSystem.SimpleConversationActor.new ( StringID  id)

Create simple conversation camera definition.

◆ setActorId()

void Dragengine.ConversationSystem.SimpleConversationActor.setActorId ( StringID  identifier)

Set conversation actor identifier or alias.

◆ setCamera()

void Dragengine.ConversationSystem.SimpleConversationActor.setCamera ( StringID  camera)

Set identifier of camera to switch to.

◆ setDelay()

void Dragengine.ConversationSystem.SimpleConversationActor.setDelay ( float  seconds)

Set delay in seconds before activating action.

◆ setFacePose()

void Dragengine.ConversationSystem.SimpleConversationActor.setFacePose ( StringID  facePose)

Set face pose or null.

◆ setLookAt()

void Dragengine.ConversationSystem.SimpleConversationActor.setLookAt ( StringID  lookAt)

Set look-at or null.

◆ setProlongLastGesture()

void Dragengine.ConversationSystem.SimpleConversationActor.setProlongLastGesture ( float  seconds)

Set amount of seconds to prolong last gesture beyond end of speech.

◆ setStyle()

void Dragengine.ConversationSystem.SimpleConversationActor.setStyle ( StringID  style)

Set text box text style or null.

◆ setUseSpeechAnimation()

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

Set if speech animation is used for this action.

Member Data Documentation

◆ pActorId

StringID Dragengine.ConversationSystem.SimpleConversationActor.pActorId

◆ pCamera

StringID Dragengine.ConversationSystem.SimpleConversationActor.pCamera

◆ pDelay

float Dragengine.ConversationSystem.SimpleConversationActor.pDelay

◆ pFacePose

StringID Dragengine.ConversationSystem.SimpleConversationActor.pFacePose

◆ pGestures

Array Dragengine.ConversationSystem.SimpleConversationActor.pGestures

◆ pId

StringID Dragengine.ConversationSystem.SimpleConversationActor.pId

◆ pStyle

StringID Dragengine.ConversationSystem.SimpleConversationActor.pStyle

◆ pUseSpeechAnimation

bool Dragengine.ConversationSystem.SimpleConversationActor.pUseSpeechAnimation

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