The '''Reference Option Description Driver''' component is used primarily to [[Drive|drive]] the parts that make up a [[Component:ContextMenuItemSource|Context Menu Item Source]]. This component along with ContextMenuItemSource is used in [[Context menu|context menus]] for toggles where the toggle controls a [[Reference Type|reference]] like a [[Slot|slot]] or object.
|Sprite|{{RootFieldType|RefDrive`1|[[Type:IAssetProvider`1|IAssetProvider`1]]<[[Type:Sprite|Sprite]]>}}|TypeAdv4=true| The Sprite to set to the chosen Sprite in the list of <code>Options</code>
|DefaultOption|{{RootFieldType|(nested)|[[#Option|Option]]<T>}}|TypeAdv5=true| The option to set <code>Label</code>, <code>Color</code>, and <code>Sprite</code> to when <code>Reference</code> doesn't match any <code>ReferenceTarget</code>s under the list of <code>Options</code>
|Options|{{RootFieldType|SyncList`1|[[#Option|Option]]<T>}}|TypeAdv6=true| The list to search for a <code>ReferenceTarget</code> that matches <code>Reference</code>. once a match is found, the option's <code>Label</code>, <code>Color</code>, and <code>Sprite</code> is used to drive this section's drive targets of <code>Label</code>, <code>Color</code>, and <code>Sprite</code>.
}}
== Option ==
{{Table TypeFields
|ReferenceTarget|[[Type:SyncRef`1|SyncRef`1]]<T>|TypeAdv0=true| The values below should be used if <code>Reference</code> is equal to this.
|Label|[[Type:String|String]]|TypeAdv1=true| The label to use if <code>ReferenceTarget</code> matches <code>Reference</code>
|Color|[[Type:ColorX|ColorX]]|TypeAdv2=true| The color to use if <code>ReferenceTarget</code> matches <code>Reference</code>
|Sprite|[[Type:IAssetProvider`1|IAssetProvider`1]]<[[Type:Sprite|Sprite]]>|TypeAdv3=true| The sprite to use if <code>ReferenceTarget</code> matches <code>Reference</code>
}}
}}
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
This component can be more efficient than using a bunch of [[Component:ReferenceEqualityDriver|Reference Equality Drivers]] and generating a number based on such, or using [[ProtoFlux]] for a context menu.
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
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.
Reference Option Description Driver`1 component as seen in the Scene Inspector
The Reference Option Description Driver component is used primarily to drive the parts that make up 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.
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.
The sprite to use if ReferenceTarget matches Reference
Usage
This component can be more efficient than using a bunch of Reference Equality Drivers and generating a number based on such, or using ProtoFlux for a context menu.
Examples
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.
