Checkbox (for Shape Painter)

Checkbox that can be toggled by a left-click or touch.

Authors and contributors to this experimental extension: VictrisGames, D8H.

Users can click on the checkbox to add and remove the checkmark.

How to use:

Add this extension to a shape painter object
Use condition "Is checked" to find out the state of the checkbox

Tips:

Checkbox state can also be changed by an action.
Checkbox can be disabled so that users cannot interact with it
To remove halo, Set "halo hover" and "halo pressed" opacity to 0

Tip

Learn how to install new extensions by following a step-by-step guide.

Checkbox

Checkbox that can be toggled by a left-click or touch.

Behavior properties

**Border thickness (px) This border is only visible when the checkbox is unchecked. ** (🔢 Number). Default value is 2.
Checked (🔘 Boolean). Default value is false.
Enable interactions (🔘 Boolean). Default value is true.
Halo opacity (pressed) (🔢 Number). Default value is 128.
Halo opacity (hover) (🔢 Number). Default value is 64.
Halo size (hover). If blank, this is set to "SideLength". (🔢 Number). Default value is 2.02468e-320.
Halo size (pressed). If blank, this is set to "HaloRadiusHover * 1.1" (🔢 Number). Default value is 2.
Line width of checkmark (px) (Min: 1, Max: 1/4 * SideLength) (🔢 Number). Default value is 5.
Primary color of checkbox. (Example: 24;119;211) Fill color when box is checked. (🎨 Color). Default value is 24;119;211.
Secondary color of checkbox. (Example: 255;255;255) Color of checkmark when box is checked. (🎨 Color). Default value is 255;255;255.
Length of each side (px) Minimum: 10 (🔢 Number). Default value is 24.

See internal technical details

**Border thickness (px) This border is only visible when the checkbox is unchecked. ** is stored as BorderThickness (Number). Default value is 2.
Checked is stored as Checked (Boolean). Default value is false.
Enable interactions is stored as Enabled (Boolean). Default value is true.
Halo opacity (pressed) is stored as HaloOpacityClick (Number). Default value is 128.
Halo opacity (hover) is stored as HaloOpacityHover (Number). Default value is 64.
Halo size (hover). If blank, this is set to "SideLength". is stored as HaloRadiusHover (Number). Default value is 2.02468e-320.
Halo size (pressed). If blank, this is set to "HaloRadiusHover * 1.1" is stored as HaloRadiusPressed (Number). Default value is 2.
Line width of checkmark (px) (Min: 1, Max: 1/4 * SideLength) is stored as LineWidth (Number). Default value is 5.
Primary color of checkbox. (Example: 24;119;211) Fill color when box is checked. is stored as PrimaryColor (Color). Default value is 24;119;211.
Secondary color of checkbox. (Example: 255;255;255) Color of checkmark when box is checked. is stored as SecondaryColor (Color). Default value is 255;255;255.
Length of each side (px) Minimum: 10 is stored as SideLength (Number). Default value is 24.

Behavior actions

Border thickness of checkbox
Change the border thickness of checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Track thickness

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetBorderThickness.

Check (or uncheck) the checkbox
Check (or uncheck) the checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (❓ Yes or No): Check the checkbox?

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetChecked.

Enable interactions with checkbox
Enable or disable interactions with the checkbox. Users cannot interact while it is disabled.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (❓ Yes or No): Enable

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetEnabled.

Halo opacity when hovered
Change the halo opacity when hovered.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Halo opacity

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetHaloOpacityHover.

Halo opacity when pressed
Change the halo opacity when pressed.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Halo opacity

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetHaloOpacityPressed.

Halo radius when hovered
Change the halo radius when hovered. This size is also used to detect interaction with the checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Halo radius

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetHaloRadiusHover.

Halo radius when pressed
Change the halo radius when pressed.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Halo radius

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetHaloRadiusPressed.

Line width of checkmark
Change the line width of checkmark.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Line width (px)

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetLineWidth.

Primary color of checkbox
Change the primary color of checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🎨 Color): Primary color

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetPrimaryColor.

Secondary color of checkbox
Change the secondary color of checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🎨 Color): Secondary color

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetSecondaryColor.

Side length of checkbox
Change the side length of checkbox.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior
Parameter 2 (🔢 Number): Track width (px)

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::SetSideLength.

Toggle checkmark
If checked, change to unchecked. If unchecked, change to checked.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior

Technical note: parameter 2 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Checkbox::Checkbox::ToggleChecked.

Behavior conditions

Checkbox is being pressed
Check if the checkbox is being pressed by mouse or touch.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior

Technical note: parameter 2 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Checkbox::Checkbox::IsBeingPressed.

Is checked
Check if the checkbox is checked.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior

Technical note: parameter 2 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Checkbox::Checkbox::IsChecked.

Interactions enabled
Check if the checkbox interations are enabled.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🧩 Behavior

Technical note: parameter 2 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Checkbox::Checkbox::IsEnabled.

Behavior expressions

Expression	Description
`Object.Checkbox::BorderThickness()`	Return the border thickness of checkbox (pixels).
`Object.Checkbox::HaloOpacityHover()`	Return the opacity of the halo when the mouse is hovering near the checkbox.
`Object.Checkbox::HaloOpacityPressed()`	Return the opacity of the halo while the checkbox is touched or clicked.
`Object.Checkbox::HaloRadiusHover()`	Return the radius of the halo when the mouse is hovering near the checkbox.
`Object.Checkbox::HaloRadiusPressed()`	Return the radius of the halo while the checkbox is touched or clicked.
`Object.Checkbox::LineWidth()`	Return the line width of checkmark (pixels).
`Object.Checkbox::PrimaryColor()`	Return the color used to draw the outline of the checkbox (when unchecked) and the fill color (when checked).
`Object.Checkbox::SecondaryColor()`	Return the color used to fill the checkbox (when unchecked) and to draw the checkmark (when checked).
`Object.Checkbox::SideLength()`	Return the side length of checkbox (pixels).

This page is an auto-generated reference page about the Checkbox (for Shape Painter) extension for GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop extensions here.