TheAutopilot (talk | contribs) Removed stub as this component is almost fully described |
TheAutopilot (talk | contribs) added missing two words in Usage |
||
Line 9: | Line 9: | ||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv0=true|A field which is driven with the currently selected | |Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv0=true|A field which is driven with the currently selected list value | ||
|Index|Int|0-based index that determines which value of <code>Values</code> has been selected; values outside the range <code>[0;length-1]</code> are wrapped around internally. | |Index|Int|0-based index that determines which value of <code>Values</code> has been selected; values outside the range <code>[0;length-1]</code> are wrapped around internally. | ||
|Values|{{RootFieldType|SyncFieldList`1|T}}|TypeAdv2=true|A list of values which can also individually be driven or written to | |Values|{{RootFieldType|SyncFieldList`1|T}}|TypeAdv2=true|A list of values which can also individually be driven or written to |
Revision as of 16:55, 10 July 2024
Component image
ValueMultiplexers allow to curate a list of values and drive a target with one of them.
They implement IValue which means that a reference to them can be used to create a Source node representing the currently indexed value. This enables using them like arrays when combined with a Source
of the Index
field.
Usage
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. |
Target
|
field drive of T | A field which is driven with the currently selected list value |
Index
|
Int | 0-based index that determines which value of Values has been selected; values outside the range [0;length-1] are wrapped around internally.
|
Values
|
direct SyncFieldList`1<T> | A list of values which can also individually be driven or written to |
AllowWriteBack
|
Bool | Setting this to true redirects writes to Target or to a Source representing the selected value to the currently indexed list entry.
|
Behavior
The component behaves similar to a ValueCopy with the list entry indicated by Index
as its Source
.
Changes to Index
or the list entries will affect Target
whenever the drive is evaluated.
On the other hand the Source
of this component updates instantly.