Component:BooleanSwitcher: Difference between revisions

Revision as of 18:50, 23 October 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.
`AutoAddChildren`	Bool	If true, the Targets list will be automatically populated with the child slots of the slot that this component is on.
`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`.
`AfterIndex`	1	Activates all items after `ActiveIndex`
`BeforeIndex`	2	Activates all items that are before `ActiveIndex`.
`AllButIndex`	3	Activates all items except the one at `ActiveIndex` which will be disabled.

@@ Line 17: / Line 17: @@
 |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.
 |ActiveIndex|Int| The index of the currently active slot.
-|ActivationMode|???|Allows for enabling items in <code>Target</code> based on <code>ActiveIndex</code> number. The options are "AtIndexOnly" which activates only item at <code>ActiveIndex</code>. There is "AfterIndex" which activates all items after <code>ActiveIndex</code>. "BeforeIndex" which activates all items that are before <code>ActiveIndex</code>. and "AllButIndex" which activates all items except the one at <code>ActiveIndex</code> which will be disabled.
+|ActivationMode|[[#Mode|Mode]]|TypeAdv3=true| Allows for enabling items in <code>Target</code> based on <code>ActiveIndex</code> number.
+}}
+== Mode ==
+{{Table EnumValues
+|AtIndexOnly|0| Activates only item at <code>ActiveIndex</code>.
+|AfterIndex|1| Activates all items after <code>ActiveIndex</code>
+|BeforeIndex|2| Activates all items that are before <code>ActiveIndex</code>.
+|AllButIndex|3| Activates all items except the one at <code>ActiveIndex</code> which will be disabled.
 }}
@@ Line 35: / Line 43: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Boolean Switcher]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Boolean Switcher]]