Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECComposeAnimator.Playback Class Reference

Playback support for elements. More...

Inheritance diagram for Dragengine.Scenery.ECComposeAnimator.Playback:

Public Member Functions

void apply ()
 Apply animation. More...
 
AnimatorController getController ()
 Playback controller or null if not available. More...
 
AnimatorInstance getInstance ()
 Animator instance or null if not available. More...
 
bool getLooping ()
 Is looping. More...
 
bool getPlaying ()
 Is playing back. More...
 
float getPlaySpeed ()
 Playback speed. More...
 
float getTime ()
 Playback time. More...
 
bool isAtBegin ()
 Playback is at beginning. More...
 
bool isAtEnd ()
 Playback is at end. More...
 
Playback new (AnimatorInstance instance, String playbackController)
 Create playback. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read element from file. More...
 
void rewind ()
 Rewind. More...
 
void setControllerIndex (int index)
 Set playback controller from index if valid. More...
 
void setControllerNamed (String name)
 Set playback controller by name if valid. More...
 
void setLooping (bool looping)
 Set if looping. More...
 
void setPlaying (bool playing)
 Set if playing back. More...
 
void setPlaySpeed (float playSpeed)
 Set playback speed. More...
 
void setTime (float time)
 Set playback time. More...
 
void update (float elapsed)
 Update animator. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write element to file. More...
 

Public Attributes

AnimatorController pController
 
AnimatorInstance pInstance
 
bool pPlaying
 
float pPlaySpeed
 

Detailed Description

Playback support for elements.

Member Function Documentation

◆ apply()

void Dragengine.Scenery.ECComposeAnimator.Playback.apply ( )

Apply animation.

◆ getController()

AnimatorController Dragengine.Scenery.ECComposeAnimator.Playback.getController ( )

Playback controller or null if not available.

◆ getInstance()

AnimatorInstance Dragengine.Scenery.ECComposeAnimator.Playback.getInstance ( )

Animator instance or null if not available.

◆ getLooping()

bool Dragengine.Scenery.ECComposeAnimator.Playback.getLooping ( )

Is looping.

◆ getPlaying()

bool Dragengine.Scenery.ECComposeAnimator.Playback.getPlaying ( )

Is playing back.

◆ getPlaySpeed()

float Dragengine.Scenery.ECComposeAnimator.Playback.getPlaySpeed ( )

Playback speed.

◆ getTime()

float Dragengine.Scenery.ECComposeAnimator.Playback.getTime ( )

Playback time.

◆ isAtBegin()

bool Dragengine.Scenery.ECComposeAnimator.Playback.isAtBegin ( )

Playback is at beginning.

◆ isAtEnd()

bool Dragengine.Scenery.ECComposeAnimator.Playback.isAtEnd ( )

Playback is at end.

◆ new()

Playback Dragengine.Scenery.ECComposeAnimator.Playback.new ( AnimatorInstance  instance,
String  playbackController 
)

Create playback.

◆ readFromFile()

void Dragengine.Scenery.ECComposeAnimator.Playback.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read element from file.

◆ rewind()

void Dragengine.Scenery.ECComposeAnimator.Playback.rewind ( )

Rewind.

◆ setControllerIndex()

void Dragengine.Scenery.ECComposeAnimator.Playback.setControllerIndex ( int  index)

Set playback controller from index if valid.

◆ setControllerNamed()

void Dragengine.Scenery.ECComposeAnimator.Playback.setControllerNamed ( String  name)

Set playback controller by name if valid.

◆ setLooping()

void Dragengine.Scenery.ECComposeAnimator.Playback.setLooping ( bool  looping)

Set if looping.

◆ setPlaying()

void Dragengine.Scenery.ECComposeAnimator.Playback.setPlaying ( bool  playing)

Set if playing back.

◆ setPlaySpeed()

void Dragengine.Scenery.ECComposeAnimator.Playback.setPlaySpeed ( float  playSpeed)

Set playback speed.

◆ setTime()

void Dragengine.Scenery.ECComposeAnimator.Playback.setTime ( float  time)

Set playback time.

◆ update()

void Dragengine.Scenery.ECComposeAnimator.Playback.update ( float  elapsed)

Update animator.

Advances the controller by the elapsed time multiplied by the play speeed and calls AnimatorInstance.apply().

◆ writeToFile()

void Dragengine.Scenery.ECComposeAnimator.Playback.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write element to file.

Member Data Documentation

◆ pController

AnimatorController Dragengine.Scenery.ECComposeAnimator.Playback.pController

◆ pInstance

AnimatorInstance Dragengine.Scenery.ECComposeAnimator.Playback.pInstance

◆ pPlaying

bool Dragengine.Scenery.ECComposeAnimator.Playback.pPlaying

◆ pPlaySpeed

float Dragengine.Scenery.ECComposeAnimator.Playback.pPlaySpeed

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