Difference between revisions of "BooleanSwitcher (Component)"

From Neos Wiki
Jump to navigation Jump to search
(Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=BooleanSwitcherComponent.png |Name=Boolean Switcher }} <!--T:2--> == Fields == {{Table Comp...")
 
(Wrote Article)
 
Line 7: Line 7:
 
|Name=Boolean Switcher
 
|Name=Boolean Switcher
 
}}
 
}}
 +
 +
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.
  
 
<!--T:2-->
 
<!--T:2-->
 
== Fields ==
 
== Fields ==
 
{{Table ComponentFields
 
{{Table ComponentFields
|AutoAddChildren|Bool|
+
|AutoAddChildren|Bool| If true, the Targets list will be automatically populated with the child slots of the slot that this component is on.
|Targets|SyncList`1|TypeString1=SyncList<FieldDrive<bool>>|
+
|Targets|SyncList`1|TypeString1=SyncList<FieldDrive<bool>>| The list of slots of which one will be enabled.
|ActiveIndex|Int|
+
|ActiveIndex|Int| The index of the currently active slot.
 
}}
 
}}
  
Line 25: Line 28:
  
 
<!--T:5-->
 
<!--T:5-->
 +
== Related Issues ==
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/301 <s>#301 - Request: Add Auto-Add Children to BooleanSwitcher</s>]
 +
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/451 <s>#451 - BooleanSwitcher applies to root on undo of deleted component from a deleted object</s>]
 +
 +
<!--T:6-->
 
== Related Components ==
 
== Related Components ==
 
</translate>
 
</translate>

Latest revision as of 10:08, 25 December 2021


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


Boolean Switcher component as seen in the Scene Inspector

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

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 SyncList<FieldDrive<bool>> The list of slots of which one will be enabled.
ActiveIndex Int The index of the currently active slot.

Usage

Examples

Related Issues

#301 - Request: Add Auto-Add Children to BooleanSwitcher

#451 - BooleanSwitcher applies to root on undo of deleted component from a deleted object

Related Components