From Resonite Wiki
This page contains changes which are not marked for translation.
Component image 
Reference Option Description Driver`1 component as seen in the Scene Inspector

Reference Option Description Driver is a component that is used primarily to drive the description of a Context Menu Item Source. This component along with ContextMenuItemSource is used in context menus for toggles where the toggle controls a reference like a slot or object.


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.
Reference direct RelayRef`1<SyncRef`1<T>> The reference field to compare against
ForceDeselected Bool This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Label field drive of String The string to set to the chosen label in the list of Options
Color field drive of ColorX The color to set to the chosen color in the list of Options
Sprite direct RefDrive`1<IAssetProvider`1<Sprite>> The Sprite to set to the chosen Sprite in the list of Options
DefaultOption direct Option<T> The option to set Label, Color, and Sprite to when Reference doesn't match any ReferenceTargets under the list of Options
Options list of Option<T> The list to search for a ReferenceTarget that matches Reference. once a match is found, the option's Label, Color, and Sprite is used to drive this section's drive targets of Label, Color, and Sprite.


Name Type Description
ReferenceTarget SyncRef`1<T> The values below should be used if Reference is equal to this.
Label String The label to use if ReferenceTarget matches Reference
Color ColorX The color to use if ReferenceTarget matches Reference
Sprite IAssetProvider`1<Sprite> The sprite to use if ReferenceTarget matches Reference


this component can be more efficient than using a bunch of reference equality driver and generating a number based on such, or using flux for a context menu.


This is useful for managing toggles where you want to switch things like music and drive the description based on which music asset you chose in your context menu.

Related Components