Checkbox Behavior
SmartUI Checkbox Behavior operation and ACEs.
Last updated
SmartUI Checkbox Behavior operation and ACEs.
Last updated
Checkboxes are a handy approach to represent boolean values and toggle it according to user inputs. This component inherits ACEs directly from the Buttons behavior except for the clicking capabilities.
Checkboxes have twice as many animations as the button, although in general terms we talk about the same states. This is due to a checkbox must represent two animations at minimum: check and unchecked.
Checkbox behavior handles the following animations for the Unchecked state:
Normal , Focused , Hover , Pressed , and Disabled .
Checkbox behavior handles the following animations for the Checked state:
Normal , Focused , Hover , Pressed , and Disabled .
Smart UI Checkbox behavior. Controls the object like a checkbox, with values: check, and unchecked. It handles ten different sprite animations to match all the states of the object, and can be animated with several built-in animations and easings.
Set Enabled
Disable/Enable the checkbox
Set Name
Sets the name of the radio button.
Set Index
Sets the sequence index to influence the selection of components.
Set Invisible Component
Turns the component opacity to 0 while rendering it to allow invisible interactions.
Set Focusable
Disable/Enable the checkbox
Set Focus
Sets the focus on the component, removing the focus from all the components within the same container.
Toggle Check
Toggles the value of the checkbox.
Set Check
Toggles the value of the checkbox.
Simulate Hover
Trigger the hover event of the plugin, simulating the interaction of the user.
Stop Hover
Stops simulating the hover state.
Set Checked Hover Animation
Sets the animation when hovering the checkbox
Set Unchecked Hover Animation
Sets the animation when hovering the checkbox
Set Hover Time
Sets the animation duration when hovering the checkbox
Set Hover Change Factor
Sets the animation when hovering the checkbox
Set Hover Function
Sets the animation when hovering the checkbox
Set Checked Press Animation
Sets the animation when pressing the checkbox
Set Unchecked Press Animation
Sets the animation when pressing the checkbox
Set Press Time
Sets the animation duration when pressing the checkbox
Set Press Change Factor
Sets the animation when pressing the checkbox
Set Press Function
Sets the animation when pressing the checkbox
Set Unchecked Animation
Sets the animation when restoring the checkbox to its normal unchecked state
Set Checked Animation
Sets the animation when restoring the checkbox to its normal checked state
Set Restore Time
Sets the animation duration when restore the checkbox to its original state
Set Restore Function
Sets the animation when restoring the checkbox
Set Check Disabled Animation
Sets the animation when disabling the checkbox
Set Uncheck Disabled Animation
Sets the animation when disabling the checkbox
Set Checked Focus Animation
Sets the animation when focusing the checkbox. Focus animation overrides the normal animation if the checkbox has the focus.
Set Unchecked Focus Animation
Sets the animation when focusing the checkbox. Focus animation overrides the normal animation if the checkbox has the focus.
Set Focus Time
Sets the animation duration when focusing the checkbox
Set Focus Change Factor
Sets the animation when focusing the checkbox
Set Focus Function
Sets the animation when focusing the checkbox
Is Enabled
Returns true if the checkbox is enabled
Compare Name
Returns true if the checkbox component's name equals the parameter
Is Checked
Returns true if the checkbox is checked
Is Invisible Component
Returns true if the checkbox is configured as an invisible component.
Is Focused
Returns true if the checkbox has the focus
Is Hovered
Returns true if the checkbox is hovering
Is Pressed
Returns true if the checkbox is being pressed
On Focus
Triggered when the checkbox gets the focus
On Focus Lost
Triggered when the checkbox loses focus
On Changed
Triggered when the checkbox is value changes. Use it together with Is-Checked condition to react to changes.
On Hover
Triggered when the checkbox starts hovering
On Hover Lost
Triggered when the checkbox ends hovering
On Pressed
Triggered when the checkbox started pressing.
On Released
Triggered when the checkbox is released.
Name
Component name
(c) Pixel Perfect Studio 2024
Parameter
Description
Enabled
Enabled/Disabled
Parameter
Description
Name
Name of the component
Parameter
Description
Index
Sequence index value. E.g. Indexes values of 0 are processed before indexes values of 1 and 2.
Parameter
Description
Invisible Component
Set if the component processed even if it's invisible: True/False
Parameter
Description
Focusable
Flag to allow the component to be focused.
Parameter
Description
Value
Set the value of the checkbox
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Duration
Animation duration in seconds
Parameter
Description
Change Factor
Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.
Parameter
Description
Animation Function
Establishes the animation function when hovering.
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Duration
Animation duration in seconds
Parameter
Description
Change Factor
Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.
Parameter
Description
Animation Function
Establishes the animation function when pressing.
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Duration
Animation duration in seconds
Parameter
Description
Animation Function
Establishes the animation function when restoring the checkbox to its original state.
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Animation name
Animation name. Only applicable for Sprite objects
Parameter
Description
Duration
Animation duration in seconds
Parameter
Description
Change Factor
Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.
Parameter
Description
Animation Function
Establishes the animation function when focusing.
Parameter
Description
Name
Name to compare with the component picked.
Property
Description
Enabled
Enables or Disables the checkbox.
Index
Index of the element within a container. Used for focusing the elements in the sequence order.
Invisible Component
Turns the component opacity to 0 while rendering it to allow invisible interactions.
Focusable
Marks if the component can have the focus.
Automatic-Color
Enables the component to darken a bit when its state is Disabled or when it's focused. Auto-Color is meant to provide a quick identification of the component state. For more specialized customizations, use the component events and disable this check.
Name
Unique name string for identifying the checkbox
On Hover
Animations when hovering
Hover Time
Timelapse to complete the animation in seconds.
Hover Change Factor
Percentage to alter the object properties
On Press
Animations when pressing
Press Time
Timelapse to complete the animation in seconds.
Checked Value
Boolean value of the checkbox. It can be either checked or unchecked.
Unchecked Normal Animation
Unchecked Normal animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Checked Normal Animation
Checked Normal animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Unchecked Disabled Animation
Unchecked Disabled animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Checked Disabled Animation
Checked Disabled animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Unchecked Press Animation
Unchecked Press animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Checked Press Animation
Checked Press animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Unchecked Hover Animation
Unchecked Hover animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Checked Hover Animation
Checked Hover animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Unchecked Focus Animation
Unchecked Focus animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Checked Focus Animation
Checked Focus animation Name. Case sensitive, must match the exact name of the animation. [Sprites only]
Press Change Factor
Percentage to alter the object properties
On Restore
Animations when restoring the checkbox properties
Restore Time
Timelapse to complete the animation in seconds.
On Focus
Animations when focusing the checkbox
Focus Time
Timelapse to complete the animation in seconds.
Focus Change Factor
Percentage to alter the object properties