Toggle

The Toggle Object is a 2D GUI Object that has two states: checked or unchecked. Its initial state and colors can be customized in the Attributes.

Attributes

The Object's Attributes can be used to fully customize the Object. Explained below, they are:

Transformation

The Transformation Attributes deal with placement, rotation, and size in XY space. More information can be found here.

Toggle

The Toggle Attributes provide crucial data for a Toggle Object.

  • Is checked can be enabled or disabled. Enabled toggles it on and disabled toggles it off.

  • Handle Color is the color of the Toggle's handle. It is the small circle which appears on the background of the Toggle.

  • Background Color Checked is the color of the background when Is checked is enabled.

  • Background Color Unchecked is the color of the background when Is checked is disabled.

Code

The Code Attributes allow for more customizability. This can override any stylesheet provided in the Project Settings or a Scene2D.

To address these in the Logic, please refer to the Object 2D Nodes.

  • Class names contain the CSS class names of the Object.

  • Stylesheet contains the CSS stylesheet of the Object.

Tag

This Attribute manages the tags for the Toggle. See more on tags here.

Last updated