Component:ReferenceOptionDescriptionDriver

Component image 

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.

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. Some components stop their functionality when this field is disabled, but some don't.
Reference	direct RelayRef`1<SyncRef`1<T>>	The reference field to compare against
ForceDeselected	Bool	Forces any context menu item source to change regardless if it is deselected.
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.

Option

Fields

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

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.