Smart UI for Construct 3
Pixel Perfect Studio
  • Smart UI for Construct 3
  • Getting Started
    • Smart UI Framework
      • Framework Initialization
      • Document Flow
      • Using Smart UI Components
      • Release Notes
        • Build v1.4ed2c828
        • Build v1.3710335f
        • Build v1.595dac53
        • Build v1.143edbbc
      • Basic Setup Tutorials
      • GitHub Repository
      • Dev Discord Server
      • Gamepad Demo
      • Guandows Demo
  • FRAMEWORK ADDONS
    • Smart UI Plugin
    • Container Behavior
    • Button Behavior
    • Checkbox Behavior
    • Radio Buttons
    • Progress Bar
    • Discrete Progress
    • Scroll Bar
    • Dialogs
    • Scroll View
      • Basic Examples
    • Grid Layout
      • Basic Examples
    • Data Listener
  • MISCELLANEOUS ADDONS
    • Legends of Learning Plugin
      • Getting Started
      • Local Testing
      • Using the Test Harness
    • Newgrounds.IO Plugin
      • Getting Started
      • Login Tutorial
    • Parabolic Tween
      • Getting Started
      • Live Demo 1
      • Live Demo 2
    • Finite State Machine Plugin and Behavior
    • Antisuspend Plugin
      • Live Demo
    • Google Analytics 4
      • Getting Started
Powered by GitBook
On this page
  • Properties
  • Smart UI Checkbox ACEs
  • Actions
  • Set Check
  • Set Checked Animation
  • Set Check Disabled Animation
  • Set Checked Focus Animation
  • Set Checked Hover Animation
  • Set Checked Press Animation
  • Set Enabled
  • Set Focus
  • Set Focus Change Factor
  • Set Focus Function
  • Set Focus Time
  • Set Focusable
  • Set Hover Change Factor
  • Set Hover Function
  • Set Hover Time
  • Set Invisible Component
  • Set Name
  • Set Press Change Factor
  • Set Press Function
  • Set Press Time
  • Set Restore Function
  • Set Restore Time
  • Set Index
  • Set Unchecked Animation
  • Set Uncheck Disabled Animation
  • Set Unchecked Focus Animation
  • Set Unchecked Hover Animation
  • Set Unchecked Press Animation
  • Simulate Hover
  • Stop Hover
  • Toggle Check
  • Conditions
  • Is Checked
  • Compare Name
  • Is Enabled
  • Is Focused
  • Is Hovered
  • Is Invisible Component
  • Is Pressed
  • On Changed
  • On Focus
  • On Focus Lost
  • On Hover
  • On Hover Lost
  • On Pressed
  • On Released
  • Expressions
  • Name

Was this helpful?

  1. FRAMEWORK ADDONS

Checkbox Behavior

SmartUI Checkbox Behavior operation and ACEs.

PreviousButton BehaviorNextRadio Buttons

Last updated 3 months ago

Was this helpful?

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 .

Download

Properties

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

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.

Actions


Set Check

Toggles the value of the checkbox.

Parameter

Description

Value

Set the value of the checkbox

Set Checked Animation

Sets the animation when restoring the checkbox to its normal checked state

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Check Disabled Animation

Sets the animation when disabling the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Checked Focus Animation

Sets the animation when focusing the checkbox. Focus animation overrides the normal animation if the checkbox has the focus.

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Checked Hover Animation

Sets the animation when hovering the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Checked Press Animation

Sets the animation when pressing the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Enabled

Disable/Enable the checkbox

Parameter

Description

Enabled

Enabled/Disabled

Set Focus

Sets the focus on the component, removing the focus from all the components within the same container.

Set Focus Change Factor

Sets the animation when focusing the checkbox

Parameter

Description

Change Factor

Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.

Set Focus Function

Sets the animation when focusing the checkbox

Parameter

Description

Animation Function

Establishes the animation function when focusing.

Set Focus Time

Sets the animation duration when focusing the checkbox

Parameter

Description

Duration

Animation duration in seconds

Set Focusable

Disable/Enable the checkbox

Parameter

Description

Focusable

Flag to allow the component to be focused.

Set Hover Change Factor

Sets the animation when hovering the checkbox

Parameter

Description

Change Factor

Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.

Set Hover Function

Sets the animation when hovering the checkbox

Parameter

Description

Animation Function

Establishes the animation function when hovering.

Set Hover Time

Sets the animation duration when hovering the checkbox

Parameter

Description

Duration

Animation duration in seconds

Set Invisible Component

Turns the component opacity to 0 while rendering it to allow invisible interactions.

Parameter

Description

Invisible Component

Set if the component processed even if it's invisible: True/False

Set Name

Sets the name of the radio button.

Parameter

Description

Name

Name of the component

Set Press Change Factor

Sets the animation when pressing the checkbox

Parameter

Description

Change Factor

Percentage to alter the object properties. Eg. 0.5 is 50%, 0.1 is 10%.

Set Press Function

Sets the animation when pressing the checkbox

Parameter

Description

Animation Function

Establishes the animation function when pressing.

Set Press Time

Sets the animation duration when pressing the checkbox

Parameter

Description

Duration

Animation duration in seconds

Set Restore Function

Sets the animation when restoring the checkbox

Parameter

Description

Animation Function

Establishes the animation function when restoring the checkbox to its original state.

Set Restore Time

Sets the animation duration when restore the checkbox to its original state

Parameter

Description

Duration

Animation duration in seconds

Set Index

Sets the sequence index to influence the selection of components.

Parameter

Description

Index

Sequence index value. E.g. Indexes values of 0 are processed before indexes values of 1 and 2.

Set Unchecked Animation

Sets the animation when restoring the checkbox to its normal unchecked state

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Uncheck Disabled Animation

Sets the animation when disabling the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Unchecked Focus Animation

Sets the animation when focusing the checkbox. Focus animation overrides the normal animation if the checkbox has the focus.

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Unchecked Hover Animation

Sets the animation when hovering the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Set Unchecked Press Animation

Sets the animation when pressing the checkbox

Parameter

Description

Animation name

Animation name. Only applicable for Sprite objects

Simulate Hover

Trigger the hover event of the plugin, simulating the interaction of the user.

Stop Hover

Stops simulating the hover state.

Toggle Check

Toggles the value of the checkbox.

Conditions


Is Checked

Returns true if the checkbox is checked

Compare Name

Returns true if the checkbox component's name equals the parameter

Parameter

Description

Name

Name to compare with the component picked.

Is Enabled

Returns true if the checkbox is enabled

Is Focused

Returns true if the checkbox has the focus

Is Hovered

Returns true if the checkbox is hovering

Is Invisible Component

Returns true if the checkbox is configured as an invisible component.

Is Pressed

Returns true if the checkbox is being pressed

On Changed

Triggered when the checkbox is value changes. Use it together with Is-Checked condition to react to changes.

On Focus

Triggered when the checkbox gets the focus

On Focus Lost

Triggered when the checkbox loses focus

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.

Expressions


Name

Component name

(c) Pixel Perfect Studio 2024

Smart UI Checkbox ACEs

https://store.pixelperfectstudio.mx/product/smart-ui-ncbeta/