Component:ReferenceMultiplexer

From Resonite Wiki
Revision as of 17:09, 10 July 2024 by TheAutopilot (talk | contribs) (Added details to match ValueMultiplexer (as far as similarities go))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Reference Multiplexer`1 component as seen in the Scene Inspector

ReferenceMultiplexers allow to curate a list of references and drive a target with one of them.

Unlike ValueMultiplexers they don't implement IValue and therefore can't be accessed directly within ProtoFlux.

Usage

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.
Target direct RefDrive`1<T> A SyncRef which is driven with the currently selected reference
Index Int 0-based index that determines which reference of References has been selected; values outside the range [0;length-1] are wrapped around internally.
References list of T A list of references which can also individually be driven or written to
AllowWriteBack Bool Setting this to true redirects writes from Target to the currently indexed list entry.

Behavior

The component behaves similar to a ReferenceCopy 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.

Examples

See Also