Component image
The ValueOptionDescriptionDriver 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 value.
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. |
Value
|
direct RelayRef`1<IField`1<T>> | The value 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 .
|
SpriteURL
|
field drive of Uri | The sprite url. |
SpriteTint
|
field drive of ColorX | The sprite tint. |
DefaultOption
|
direct Option<T> | The option to set Label , Color , and Sprite to when Reference doesn't match any ReferenceTarget s under the list of Options .
|
Options
|
list of Option<T> | The list to search for a ReferenceTarget that matches Value . 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 .
|
SpriteTintBase
|
ColorX | Tints the entire sprite with a ColorX. |
Option
Name | Type | Description |
---|---|---|
ReferenceValue
|
SyncRef`1<T> | The values below should be used if Value is equal to this.
|
Label
|
String | The label to use if ReferenceValue matches Value
|
Color
|
ColorX | The color to use if ReferenceValue matches Value
|
Sprite
|
IAssetProvider`1<Sprite> | The sprite to use if ReferenceValue matches Value
|
SpriteTint
|
ColorX | The tint color for this sprite. |
Usage
This component can be more efficient than using a bunch of Value Equality Drivers and generating a number based on such, or using ProtoFlux for a context menu.