Class: AnimationInputs
Defined in: animations/types/AnimationInputs.ts:21
Class to store and manage all animation inputs used in the animation controller
Implements
Constructors
Constructor
new AnimationInputs():
AnimationInputs
Defined in: animations/types/AnimationInputs.ts:51
Creates a new instance of AnimationInputs. Initializes empty maps for text, number, toggle, and trigger inputs.
Returns
AnimationInputs
Properties
animationClipPlaybackPercentage
animationClipPlaybackPercentage:
number=0
Defined in: animations/types/AnimationInputs.ts:45
The current playback percentage of the animation clip (0 to 1)
numberInputs
numberInputs:
Map<string,AnimationInput<number>>
Defined in: animations/types/AnimationInputs.ts:30
A map of number inputs (number) used in the animation controller
textInputs
textInputs:
Map<string,AnimationInput<string>>
Defined in: animations/types/AnimationInputs.ts:25
A map of text inputs (string) used in the animation controller
toggleInputs
toggleInputs:
Map<string,AnimationInput<boolean>>
Defined in: animations/types/AnimationInputs.ts:35
A map of toggle inputs (boolean) used in the animation controller
triggerInputs
triggerInputs:
Map<string,AnimationInput<boolean>>
Defined in: animations/types/AnimationInputs.ts:40
A map of trigger inputs (boolean) used in the animation controller
Methods
getNumber()
getNumber(
name):null|AnimationInput<number>
Defined in: animations/types/AnimationInputs.ts:157
Gets the value of a number input.
Parameters
name
string
the name of the input
Returns
null | AnimationInput<number>
The current value of the input
getText()
getText(
name):null|AnimationInput<string>
Defined in: animations/types/AnimationInputs.ts:190
Gets the value of a text input.
Parameters
name
string
the name of the input
Returns
null | AnimationInput<string>
The current value of the input
getToggle()
getToggle(
name):null|AnimationInput<boolean>
Defined in: animations/types/AnimationInputs.ts:93
Gets the value of a toggle input.
Parameters
name
string
the name of the input
Returns
null | AnimationInput<boolean>
The current value of the input
getTrigger()
getTrigger(
name):null|AnimationInput<boolean>
Defined in: animations/types/AnimationInputs.ts:124
Gets the value of a trigger input.
Parameters
name
string
the name of the input
Returns
null | AnimationInput<boolean>
The current value of the input
registerNumber()
registerNumber(
name,startingValue):void
Defined in: animations/types/AnimationInputs.ts:133
Registers a new number input.
Parameters
name
string
the name of the input
startingValue
number = 0
the starting value for the input. Default is 0.
Returns
void
registerText()
registerText(
name,startingValue):void
Defined in: animations/types/AnimationInputs.ts:166
Registers a new text input.
Parameters
name
string
the name of the input
startingValue
string = ''
the starting value for the input. Default is an empty string.
Returns
void
registerToggle()
registerToggle(
name,startingValue):void
Defined in: animations/types/AnimationInputs.ts:69
Registers a new toggle input.
Parameters
name
string
the name of the input
startingValue
boolean = false
the starting value for the input. Default is false.
Returns
void
registerTrigger()
registerTrigger(
name):void
Defined in: animations/types/AnimationInputs.ts:101
Registers a new trigger input.
Parameters
name
string
the name of the input
Returns
void
setNumber()
setNumber(
name,value):void
Defined in: animations/types/AnimationInputs.ts:142
Sets the value of a number input.
Parameters
name
string
the name of the input
value
number
the new value for the input
Returns
void
setText()
setText(
name,value):void
Defined in: animations/types/AnimationInputs.ts:175
Sets the value of a text input.
Parameters
name
string
the name of the input
value
string
the new value for the input
Returns
void
setToggle()
setToggle(
name,value):void
Defined in: animations/types/AnimationInputs.ts:78
Sets the value of a toggle input.
Parameters
name
string
the name of the input
value
boolean
the new value for the input
Returns
void
setTrigger()
setTrigger(
name):void
Defined in: animations/types/AnimationInputs.ts:109
Sets the value of a trigger input to true.
Parameters
name
string
the name of the input
Returns
void
update()
update():
void
Defined in: animations/types/AnimationInputs.ts:58
Updates the object with the given time.
Returns
void