Component:ButtonToggle: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ButtonToggle (Component) to Component:ButtonToggle: Creating component Namespace
Automated: update component fields
Line 13: Line 13:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetValue|IField`1|TypeString0=IField<bool>| The boolean to invert whenever the button is pressed.
|TargetValue|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv0=true| The boolean to invert whenever the button is pressed.
}}
}}



Revision as of 10:39, 1 March 2024


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


Component image 
Button Toggle component as seen in the Scene Inspector


The ButtonValueToggle component can be used to make a button that switches a boolean value between true and false every time the button is pressed.

Fields

Fields
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.
TargetValue IField`1<Bool> The boolean to invert whenever the button is pressed.

Usage

To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ButtonToggle, making it toggle its TargetValue from true to false or the other way round.

Examples

Related Components