Drag[en]gine Script Module DragonScript  1.21
Dragengine.ConversationSystem.ConversationGesturePlayback Class Reference

Conversation gesture playback. More...

Inheritance diagram for Dragengine.ConversationSystem.ConversationGesturePlayback:

Classes

class  Gesture
 Gesture. More...
 

Public Member Functions

void addGesture (StringID animatorID, bool hold, ConversationStrip strip)
 Add gesture. More...
 
void addGestureFromNow (StringID animatorID, bool hold, ConversationStrip strip)
 Add gesture at playback position replacing gestures after pause time. More...
 
void applyAnimation ()
 Apply animation. More...
 
AnimatorInstance getAnimatorInstance ()
 Animator instance. More...
 
AnimatorController getControllerFadeIn ()
 Fade in animator controllers. More...
 
AnimatorController getControllerFadeOut ()
 Fade out animator controllers. More...
 
AnimatorController getControllerPlayback ()
 Playback animator controllers. More...
 
AnimatorController getControllerProgress ()
 Progress animator controllers. More...
 
AnimatorController getControllerVariation ()
 Variation animator controllers. More...
 
float getElapsed ()
 Elapsed time. More...
 
Gesture getGestureAt (int position)
 Gesture by position. More...
 
int getGestureCount ()
 Number of gestures. More...
 
String getNameControllerFadeIn ()
 Fade in controller name. More...
 
String getNameControllerFadeOut ()
 Fade out controller name. More...
 
String getNameControllerPlayback ()
 Playback controller name. More...
 
String getNameControllerProgress ()
 Progress controller name. More...
 
String getNameControllerVariation ()
 Variation controller name. More...
 
int getPosition ()
 Playback position. More...
 
float getRemainingGestureTime ()
 Remaining playback time of current gesture. More...
 
bool getRunning ()
 Playback is running. More...
 
bool isLastGestureRunning ()
 Last gesture is playing back. More...
 
ConversationGesturePlayback new ()
 Create gesture playback. More...
 
void onFinished ()
 Finished playing back the gestures. Hook for subclasses. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read from file. More...
 
void removeAllGestures ()
 Remove all gestures. More...
 
void setNameControllerFadeIn (String name)
 Set fade in controller name. More...
 
void setNameControllerFadeOut (String name)
 Set fade out controller name. More...
 
void setNameControllerPlayback (String name)
 Set playback controller name. More...
 
void setNameControllerProgress (String name)
 Set progress controller name. More...
 
void setNameControllerVariation (String name)
 Set variation controller name. More...
 
void update (ConversationActor actor, AnimatorInstance poseAnimatorInstance, float elapsed)
 Update playback. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write to file. More...
 

Protected Member Functions

void findControllers (ConversationActor actor)
 Find animator controllers after animator changed. More...
 
void initControllers (ConversationActor actor, float startTime, float endTime)
 Initialize controllers after activating a new gesture. More...
 
void initNextGesture (ConversationActor actor)
 Init next gesture to play. More...
 
void updateControllers (ConversationActor actor, float elapsed, float endTime)
 Update controllers. More...
 

Detailed Description

Conversation gesture playback.

Member Function Documentation

◆ addGesture()

void Dragengine.ConversationSystem.ConversationGesturePlayback.addGesture ( StringID  animatorID,
bool  hold,
ConversationStrip  strip 
)

Add gesture.

◆ addGestureFromNow()

void Dragengine.ConversationSystem.ConversationGesturePlayback.addGestureFromNow ( StringID  animatorID,
bool  hold,
ConversationStrip  strip 
)

Add gesture at playback position replacing gestures after pause time.

◆ applyAnimation()

void Dragengine.ConversationSystem.ConversationGesturePlayback.applyAnimation ( )

Apply animation.

Called after update() to apply animation. Can do nothing if no change has been done.

◆ findControllers()

void Dragengine.ConversationSystem.ConversationGesturePlayback.findControllers ( ConversationActor  actor)
protected

Find animator controllers after animator changed.

Version
1.13

◆ getAnimatorInstance()

AnimatorInstance Dragengine.ConversationSystem.ConversationGesturePlayback.getAnimatorInstance ( )

Animator instance.

◆ getControllerFadeIn()

AnimatorController Dragengine.ConversationSystem.ConversationGesturePlayback.getControllerFadeIn ( )

Fade in animator controllers.

Version
1.13

◆ getControllerFadeOut()

AnimatorController Dragengine.ConversationSystem.ConversationGesturePlayback.getControllerFadeOut ( )

Fade out animator controllers.

Version
1.13

◆ getControllerPlayback()

AnimatorController Dragengine.ConversationSystem.ConversationGesturePlayback.getControllerPlayback ( )

Playback animator controllers.

◆ getControllerProgress()

AnimatorController Dragengine.ConversationSystem.ConversationGesturePlayback.getControllerProgress ( )

Progress animator controllers.

◆ getControllerVariation()

AnimatorController Dragengine.ConversationSystem.ConversationGesturePlayback.getControllerVariation ( )

Variation animator controllers.

◆ getElapsed()

float Dragengine.ConversationSystem.ConversationGesturePlayback.getElapsed ( )

Elapsed time.

◆ getGestureAt()

Gesture Dragengine.ConversationSystem.ConversationGesturePlayback.getGestureAt ( int  position)

Gesture by position.

◆ getGestureCount()

int Dragengine.ConversationSystem.ConversationGesturePlayback.getGestureCount ( )

Number of gestures.

◆ getNameControllerFadeIn()

String Dragengine.ConversationSystem.ConversationGesturePlayback.getNameControllerFadeIn ( )

Fade in controller name.

Version
1.13

◆ getNameControllerFadeOut()

String Dragengine.ConversationSystem.ConversationGesturePlayback.getNameControllerFadeOut ( )

Fade out controller name.

Version
1.13

◆ getNameControllerPlayback()

String Dragengine.ConversationSystem.ConversationGesturePlayback.getNameControllerPlayback ( )

Playback controller name.

◆ getNameControllerProgress()

String Dragengine.ConversationSystem.ConversationGesturePlayback.getNameControllerProgress ( )

Progress controller name.

◆ getNameControllerVariation()

String Dragengine.ConversationSystem.ConversationGesturePlayback.getNameControllerVariation ( )

Variation controller name.

◆ getPosition()

int Dragengine.ConversationSystem.ConversationGesturePlayback.getPosition ( )

Playback position.

◆ getRemainingGestureTime()

float Dragengine.ConversationSystem.ConversationGesturePlayback.getRemainingGestureTime ( )

Remaining playback time of current gesture.

Version
1.13

If playback is no running 0 is returned. Returned playback includes pause if not elapsed. If playing back gesture is held not elapsed pause time is returned (duration 0).

◆ getRunning()

bool Dragengine.ConversationSystem.ConversationGesturePlayback.getRunning ( )

Playback is running.

◆ initControllers()

void Dragengine.ConversationSystem.ConversationGesturePlayback.initControllers ( ConversationActor  actor,
float  startTime,
float  endTime 
)
protected

Initialize controllers after activating a new gesture.

Version
1.13

◆ initNextGesture()

void Dragengine.ConversationSystem.ConversationGesturePlayback.initNextGesture ( ConversationActor  actor)
protected

Init next gesture to play.

◆ isLastGestureRunning()

bool Dragengine.ConversationSystem.ConversationGesturePlayback.isLastGestureRunning ( )

Last gesture is playing back.

Version
1.13

Returns true if getRunning() is true and getPosition() is getGestureCount() - 1.

◆ new()

ConversationGesturePlayback Dragengine.ConversationSystem.ConversationGesturePlayback.new ( )

Create gesture playback.

◆ onFinished()

void Dragengine.ConversationSystem.ConversationGesturePlayback.onFinished ( )

Finished playing back the gestures. Hook for subclasses.

◆ readFromFile()

void Dragengine.ConversationSystem.ConversationGesturePlayback.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read from file.

◆ removeAllGestures()

void Dragengine.ConversationSystem.ConversationGesturePlayback.removeAllGestures ( )

Remove all gestures.

◆ setNameControllerFadeIn()

void Dragengine.ConversationSystem.ConversationGesturePlayback.setNameControllerFadeIn ( String  name)

Set fade in controller name.

Version
1.13

◆ setNameControllerFadeOut()

void Dragengine.ConversationSystem.ConversationGesturePlayback.setNameControllerFadeOut ( String  name)

Set fade out controller name.

Version
1.13

◆ setNameControllerPlayback()

void Dragengine.ConversationSystem.ConversationGesturePlayback.setNameControllerPlayback ( String  name)

Set playback controller name.

◆ setNameControllerProgress()

void Dragengine.ConversationSystem.ConversationGesturePlayback.setNameControllerProgress ( String  name)

Set progress controller name.

◆ setNameControllerVariation()

void Dragengine.ConversationSystem.ConversationGesturePlayback.setNameControllerVariation ( String  name)

Set variation controller name.

◆ update()

void Dragengine.ConversationSystem.ConversationGesturePlayback.update ( ConversationActor  actor,
AnimatorInstance  poseAnimatorInstance,
float  elapsed 
)

Update playback.

This updates the playback and updates animator instances if required. This does not apply the animation yet to allow proper use of state capturing.

◆ updateControllers()

void Dragengine.ConversationSystem.ConversationGesturePlayback.updateControllers ( ConversationActor  actor,
float  elapsed,
float  endTime 
)
protected

Update controllers.

Version
1.13

◆ writeToFile()

void Dragengine.ConversationSystem.ConversationGesturePlayback.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write to file.


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