Component:BooleanMemberEditor: Difference between revisions

Latest revision as of 22:28, 24 December 2024

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

Component image

**Boolean Member Editor** component as seen in the Scene Inspector

The BooleanMemberEditor component is commonly used in Scene Inspectors to allow toggling of booleans even if they are a sub property of a type like a Bool3 Using _path. This can be utilized in Ref Hacking.

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. Some components stop their functionality when this field is disabled, but some don't.
`Continuous`	Bool	Whether editing of this field instantly updates the `_target`.
`_path`	String	The sub path under `_target`. This can be something like "x" to represent the first value of a Bool3 field.
`_target`	direct RelayRef`1<IField>	The bool field or a field with a toggleable bool subfield.
`_checkBox`	Checkbox	The Checkbox to toggle `_target`->`_path` with.
`_stateDrive`	field drive of Bool	The field to drive with the state of `_target`->`_path`
`_button`	Button	The button to toggle `_target`->`_path` with.

Usage

Used in Scene Inspectors

@@ Line 7: / Line 7: @@
 |Name=Boolean Member Editor
 }}
+The '''BooleanMemberEditor''' component is commonly used in [[Scene Inspector]]s to allow toggling of booleans even if they are a sub property of a type like a [[Type:Bool3|Bool3]] Using <code>_path</code>. This can be utilized in [[Ref Hacking]].
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|Continuous|Bool|
+|Continuous|Bool| Whether editing of this field instantly updates the <code>_target</code>.
-|_path|String|
+|_path|String| The sub path under <code>_target</code>. This can be something like "x" to represent the first value of a [[Type:Bool3|Bool3]] field.
-|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true|
+|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true| The bool field or a field with a toggleable bool subfield.
-|_checkBox|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv3=true|
+|_checkBox|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv3=true| The Checkbox to toggle <code>_target</code>-><code>_path</code> with.
-|_stateDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv4=true|
+|_stateDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv4=true| The field to drive with the state of <code>_target</code>-><code>_path</code>
-|_button|'''[[Component:Button|Button]]'''|TypeAdv5=true|
+|_button|'''[[Component:Button|Button]]'''|TypeAdv5=true| The button to toggle <code>_target</code>-><code>_path</code> with.
 }}
 <!--T:3-->
 == Usage ==
+Used in [[Scene Inspector]]s
-<!--T:4-->
-== Examples ==
 <!--T:5-->
-== Related Components ==
+== See Also ==
+* [[Ref Hacking]]
+* [[Scene Inspector]]
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Boolean Member Editor]]
 [[Category:Components:Uncategorized{{#translation:}}|Boolean Member Editor]]