Class: AnimationInputs
Defined in: animations/types/AnimationInputs.ts:64
Class to store and manage all animation inputs used in the animation controller
Constructors
Constructor
new AnimationInputs():
AnimationInputs
Defined in: animations/types/AnimationInputs.ts:82
Creates a new instance of AnimationInputs. Initializes empty arrays for text, number, and toggle inputs.
Returns
AnimationInputs
Properties
numberInputs
numberInputs:
AnimationInput<number>[]
Defined in: animations/types/AnimationInputs.ts:72
An array of number inputs (number) used in the animation controller
textInputs
textInputs:
AnimationInput<string>[]
Defined in: animations/types/AnimationInputs.ts:68
An array of text inputs (string) used in the animation controller
toggleInputs
toggleInputs:
AnimationInput<boolean>[]
Defined in: animations/types/AnimationInputs.ts:76
An array of toggle inputs (boolean) used in the animation controller
Methods
clearFrameEndInputs()
clearFrameEndInputs():
void
Defined in: animations/types/AnimationInputs.ts:224
Resets all inputs that are set to reset at the end of the animation frame to their default values.
Returns
void
getAllInputs()
getAllInputs():
AnimationInput<string|number|boolean>[]
Defined in: animations/types/AnimationInputs.ts:197
Gets all registered inputs.
Returns
AnimationInput<string | number | boolean>[]
An array of all registered inputs of all types
getInputByName()
getInputByName(
name):AnimationInput<string> |AnimationInput<number> |AnimationInput<boolean>
Defined in: animations/types/AnimationInputs.ts:206
Gets an input by name, regardless of its type.
Parameters
name
string
the name of the input
Returns
AnimationInput<string> | AnimationInput<number> | AnimationInput<boolean>
The input with the specified name
getNumber()
getNumber(
name):AnimationInput<number>
Defined in: animations/types/AnimationInputs.ts:154
Gets the value of a number input.
Parameters
name
string
the name of the input
Returns
AnimationInput<number>
The current value of the input
getText()
getText(
name):AnimationInput<string>
Defined in: animations/types/AnimationInputs.ts:189
Gets the value of a text input.
Parameters
name
string
the name of the input
Returns
AnimationInput<string>
The current value of the input
getToggle()
getToggle(
name):AnimationInput<boolean>
Defined in: animations/types/AnimationInputs.ts:119
Gets the value of a toggle input.
Parameters
name
string
the name of the input
Returns
AnimationInput<boolean>
The current value of the input
registerNumber()
registerNumber(
name,inputOptions?):void
Defined in: animations/types/AnimationInputs.ts:128
Registers a new number input.
Parameters
name
string
the name of the input
inputOptions?
Partial<AnimationInputOptions<number>>
the options for the input
Returns
void
registerText()
registerText(
name,inputOptions?):void
Defined in: animations/types/AnimationInputs.ts:163
Registers a new text input.
Parameters
name
string
the name of the input
inputOptions?
Partial<AnimationInputOptions<string>>
the options for the input
Returns
void
registerToggle()
registerToggle(
name,inputOptions?):void
Defined in: animations/types/AnimationInputs.ts:93
Registers a new toggle input.
Parameters
name
string
the name of the input
inputOptions?
Partial<AnimationInputOptions<boolean>>
the options for the input
Returns
void
setNumber()
setNumber(
name,value):void
Defined in: animations/types/AnimationInputs.ts:145
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:180
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:110
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