Component:BooleanSwitcher: Difference between revisions

Revision as of 16:41, 17 December 2024

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

Component image

The BooleanSwitcher component can be used to enable a specified slot from a list of slots. It does so by driving the Active field of the slots.

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.
`AutoAddChildren`	Bool	If true, the Targets list will be automatically populated with the child slots of the slot that this component is on.
`AutoAddIgnoreTags`	direct SyncFieldList`1<String>
`Targets`	list of FieldDrive`1<Bool>	The list of slots of which one will be enabled.
`ActiveIndex`	Int	The index of the currently active slot.
`ActivationMode`	Mode	Allows for enabling items in `Target` based on `ActiveIndex` number.

Values
Name	Value	Description
`AtIndexOnly`	0	Activates only item at `ActiveIndex`.
`AllButIndex`	1	Activates all items except the one at `ActiveIndex` which will be disabled.
`IndexAndBefore`	2	Activates all items that are before and at `ActiveIndex`.
`IndexAndAfter`	3	Activates all items at and after `ActiveIndex`

@@ Line 15: / Line 15: @@
 {{Table ComponentFields
 |AutoAddChildren|Bool| If true, the Targets list will be automatically populated with the child slots of the slot that this component is on.
-|Targets|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]&lt;[[Type:Bool|Bool]]&gt;}}|TypeAdv1=true| The list of slots of which one will be enabled.
+|AutoAddIgnoreTags|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true|
+|Targets|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]&lt;[[Type:Bool|Bool]]&gt;}}|TypeAdv2=true| The list of slots of which one will be enabled.
 |ActiveIndex|Int| The index of the currently active slot.
-|ActivationMode|[[#Mode|Mode]]|TypeAdv3=true| Allows for enabling items in <code>Target</code> based on <code>ActiveIndex</code> number.
+|ActivationMode|'''[[#Mode|Mode]]'''|TypeAdv4=true| Allows for enabling items in <code>Target</code> based on <code>ActiveIndex</code> number.
 }}
@@ Line 44: / Line 45: @@
 </translate>
 [[Category:Components{{#translation:}}|Boolean Switcher]]
+[[Category:Components With Nested Enums{{#translation:}}|Boolean Switcher]]
+[[Category:ComponentStub]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Boolean Switcher]]