Drag[en]gine Script Module DragonScript Script API  1.0
AnimatorTransition Class Reference

Animator transition parameters. More...

Inheritance diagram for AnimatorTransition:

Public Member Functions

StringID getAnimatorName ()
 Name of animator to use. More...
 
float getPlaytime ()
 Play time of animator until the pose is changed. More...
 
float getTimeOffset ()
 Offset in seconds in the animator to start the change pose animation. More...
 
AnimatorTransition new ()
 Create actor change pose. More...
 
AnimatorTransition new (StringID animatorName)
 Create actor change pose. More...
 
AnimatorTransition new (StringID animatorName, float playtime)
 Create actor change pose. More...
 
AnimatorTransition new (StringID animatorName, float playtime, float timeOffset)
 Create actor change pose. More...
 
AnimatorTransition new (AnimatorTransition copy)
 Create copy of actor change pose. More...
 
void setAnimatorName (StringID name)
 Set name of animator to use. More...
 
void setPlaytime (float playtime)
 Set play time of animator until the pose is changed. More...
 
void setTimeOffset (float offset)
 Set offset in seconds in the animator to start the change pose animation. More...
 

Static Public Member Functions

static AnimatorTransition newFromEClass (Dictionary map)
 Create actor change pose from element class property map value. More...
 

Detailed Description

Animator transition parameters.

Name of animator to use to transition from one animator to another animator. Typically used for example to equip objects or change from one actor pose to another. The playtime can be negative which can be used by the game script to denote playing the animator backwards. The time offset allows to fine tune the animator if supported by the game scripts.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Member Function Documentation

§ getAnimatorName()

StringID getAnimatorName ( )

Name of animator to use.

§ getPlaytime()

float getPlaytime ( )

Play time of animator until the pose is changed.

§ getTimeOffset()

float getTimeOffset ( )

Offset in seconds in the animator to start the change pose animation.

§ new() [1/5]

Create actor change pose.

§ new() [2/5]

AnimatorTransition new ( StringID  animatorName)

Create actor change pose.

§ new() [3/5]

AnimatorTransition new ( StringID  animatorName,
float  playtime 
)

Create actor change pose.

§ new() [4/5]

AnimatorTransition new ( StringID  animatorName,
float  playtime,
float  timeOffset 
)

Create actor change pose.

§ new() [5/5]

Create copy of actor change pose.

§ newFromEClass()

static AnimatorTransition newFromEClass ( Dictionary  map)
static

Create actor change pose from element class property map value.

§ setAnimatorName()

void setAnimatorName ( StringID  name)

Set name of animator to use.

§ setPlaytime()

void setPlaytime ( float  playtime)

Set play time of animator until the pose is changed.

§ setTimeOffset()

void setTimeOffset ( float  offset)

Set offset in seconds in the animator to start the change pose animation.


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