Class: AnimationToggleCondition
Defined in: animations/types/AnimationCondition.ts:194
Class for toggle (boolean)-based animation conditions.
Extends
AnimationConditionBase<boolean>
Constructors
Constructor
new AnimationToggleCondition(
inputName,invertCondition?):AnimationToggleCondition
Defined in: animations/types/AnimationCondition.ts:49
Creates an instance of AnimationConditionBase.
Parameters
inputName
string
The name of the input used in the condition.
invertCondition?
boolean
Whether to invert the condition result.
Returns
AnimationToggleCondition
Inherited from
AnimationConditionBase<boolean>.constructor
Properties
inputName
inputName:
string
Defined in: animations/types/AnimationCondition.ts:38
The name of the input used in the condition.
Inherited from
AnimationConditionBase.inputName
invertCondition
invertCondition:
boolean
Defined in: animations/types/AnimationCondition.ts:42
Whether to invert the condition result.
Inherited from
AnimationConditionBase.invertCondition
Methods
checkCondition()
protectedcheckCondition(inputValue):boolean
Defined in: animations/types/AnimationCondition.ts:213
Method to check the condition based on the input value.
Parameters
inputValue
boolean
the value of the input to validate the condition against
Returns
boolean
Whether the condition is met based on the input value.
Overrides
AnimationConditionBase.checkCondition
validateCondition()
protectedvalidateCondition(inputValue):boolean
Defined in: animations/types/AnimationCondition.ts:68
Validates the condition based on the input value and whether to invert the condition.
Parameters
inputValue
boolean
the value of the input to validate the condition against
Returns
boolean
Whether the condition is met based on the input value.
Inherited from
AnimationConditionBase.validateCondition
validateConditionFromInputs()
validateConditionFromInputs(
animationInputs):boolean
Defined in: animations/types/AnimationCondition.ts:200
Method to validate the condition based on all of the animation inputs.
Parameters
animationInputs
The animation inputs to validate the condition against.
Returns
boolean
Whether the condition is met based on the animation inputs.
Overrides
AnimationConditionBase.validateConditionFromInputs