Drag[en]gine Script Module DragonScript  1.23
Dragengine.Animators.ADLink Class Reference

Definition of an animator link. More...

Inheritance diagram for Dragengine.Animators.ADLink:

Public Member Functions

void addToAnimator (Animator animator)
 Add link to animator using the stored definition. More...
 
void debug (Console console, int index)
 
String getBone ()
 Bone to use parameter of as input or empty string to not use. More...
 
float getBoneMaximum ()
 Maximum bone parameter value. More...
 
float getBoneMinimum ()
 Minimum bone parameter value. More...
 
AnimatorLinkBoneParameter getBoneParameter ()
 Bone parameter to use as input. More...
 
ADController getController ()
 Controller or null if not set. More...
 
CurveBezier getCurve ()
 Curve. More...
 
int getIndex ()
 Index of link in animator. More...
 
int getRepeat ()
 Repeat count along X axis. More...
 
String getVertexPositionSet ()
 Vertex position set to use as input or empty string to not use. More...
 
float getVertexPositionSetMaximum ()
 Maximum vertex position set value. More...
 
float getVertexPositionSetMinimum ()
 Minimum vertex position set value. More...
 
bool getWrapY ()
 Wrap Y value instead of clamping. More...
 
ADLink new ()
 Create link definition. More...
 
ADLink new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADLink link)
 Create copy of link definition. More...
 
void setBone (String bone)
 Set bone to use parameter of as input or empty string to not use. More...
 
void setBoneMaximum (float value)
 Set maximum bone parameter value. More...
 
void setBoneMinimum (float value)
 Set minimum bone parameter value. More...
 
void setBoneParameter (AnimatorLinkBoneParameter parameter)
 Set bone parameter to use as input. More...
 
void setController (ADController controller)
 Set controller or null if not set. More...
 
void setCurve (CurveBezier curve)
 Set curve. More...
 
void setRepeat (int repeat)
 Set repeat along X axis. More...
 
void setVertexPositionSet (String vertexPositionSet)
 Set vertex position set to use as input or empty string to not use. More...
 
void setVertexPositionSetMaximum (float value)
 Set maximum vertex position set value. More...
 
void setVertexPositionSetMinimum (float value)
 Set minimum vertex position set value. More...
 
void setWrapY (bool wrap)
 Set to wrap Y value instead of clamping. More...
 

Detailed Description

Definition of an animator link.

Once defined a link can be added to an animator using the stored definition.

Member Function Documentation

◆ addToAnimator()

void Dragengine.Animators.ADLink.addToAnimator ( Animator  animator)

Add link to animator using the stored definition.

◆ debug()

void Dragengine.Animators.ADLink.debug ( Console  console,
int  index 
)

◆ getBone()

String Dragengine.Animators.ADLink.getBone ( )

Bone to use parameter of as input or empty string to not use.

Version
1.6

◆ getBoneMaximum()

float Dragengine.Animators.ADLink.getBoneMaximum ( )

Maximum bone parameter value.

Version
1.6

◆ getBoneMinimum()

float Dragengine.Animators.ADLink.getBoneMinimum ( )

Minimum bone parameter value.

Version
1.6

◆ getBoneParameter()

AnimatorLinkBoneParameter Dragengine.Animators.ADLink.getBoneParameter ( )

Bone parameter to use as input.

Version
1.6

◆ getController()

ADController Dragengine.Animators.ADLink.getController ( )

Controller or null if not set.

◆ getCurve()

CurveBezier Dragengine.Animators.ADLink.getCurve ( )

Curve.

◆ getIndex()

int Dragengine.Animators.ADLink.getIndex ( )

Index of link in animator.

◆ getRepeat()

int Dragengine.Animators.ADLink.getRepeat ( )

Repeat count along X axis.

◆ getVertexPositionSet()

String Dragengine.Animators.ADLink.getVertexPositionSet ( )

Vertex position set to use as input or empty string to not use.

Version
1.17

◆ getVertexPositionSetMaximum()

float Dragengine.Animators.ADLink.getVertexPositionSetMaximum ( )

Maximum vertex position set value.

Version
1.17

◆ getVertexPositionSetMinimum()

float Dragengine.Animators.ADLink.getVertexPositionSetMinimum ( )

Minimum vertex position set value.

Version
1.17

◆ getWrapY()

bool Dragengine.Animators.ADLink.getWrapY ( )

Wrap Y value instead of clamping.

Version
1.9

◆ new() [1/2]

ADLink Dragengine.Animators.ADLink.new ( )

Create link definition.

◆ new() [2/2]

ADLink Dragengine.Animators.ADLink.new ( AnimatorDefinition  fromDef,
AnimatorDefinition  toDef,
ADLink  link 
)

Create copy of link definition.

Version
1.13

◆ setBone()

void Dragengine.Animators.ADLink.setBone ( String  bone)

Set bone to use parameter of as input or empty string to not use.

Version
1.6

◆ setBoneMaximum()

void Dragengine.Animators.ADLink.setBoneMaximum ( float  value)

Set maximum bone parameter value.

Version
1.6

◆ setBoneMinimum()

void Dragengine.Animators.ADLink.setBoneMinimum ( float  value)

Set minimum bone parameter value.

Version
1.6

◆ setBoneParameter()

void Dragengine.Animators.ADLink.setBoneParameter ( AnimatorLinkBoneParameter  parameter)

Set bone parameter to use as input.

Version
1.6

◆ setController()

void Dragengine.Animators.ADLink.setController ( ADController  controller)

Set controller or null if not set.

◆ setCurve()

void Dragengine.Animators.ADLink.setCurve ( CurveBezier  curve)

Set curve.

◆ setRepeat()

void Dragengine.Animators.ADLink.setRepeat ( int  repeat)

Set repeat along X axis.

◆ setVertexPositionSet()

void Dragengine.Animators.ADLink.setVertexPositionSet ( String  vertexPositionSet)

Set vertex position set to use as input or empty string to not use.

Version
1.17

◆ setVertexPositionSetMaximum()

void Dragengine.Animators.ADLink.setVertexPositionSetMaximum ( float  value)

Set maximum vertex position set value.

Version
1.17

◆ setVertexPositionSetMinimum()

void Dragengine.Animators.ADLink.setVertexPositionSetMinimum ( float  value)

Set minimum vertex position set value.

Version
1.17

◆ setWrapY()

void Dragengine.Animators.ADLink.setWrapY ( bool  wrap)

Set to wrap Y value instead of clamping.

Version
1.9

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