Component:Checkbox

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

CollapseComponent image 

Checkbox component as seen in the Scene Inspector

Intoduction

The Checkbox component is used with a Button component to provide a toggling state whenever the button is pressed.

Usage

Fields Collapse

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
State	Bool
TargetState	direct RelayRef`1<IField`1<Bool>>	The Bool field to drive with the state of the checkbox
CheckVisual	field drive of Bool	The Bool field controlling visibility of the visual to display when the checkbox is in the checked state

Examples

Typically you'd have a child of the checkbox's slot containing an Image component, and that slot's Active property is driven using the CheckVisual property of the checkbox. In addition, you can have a SpriteProvider driving the Image component.

See also ProbablePrime's tutorial on checkboxes.