Automated: create new component page |
Added a description and field descriptions. |
||
| Line 3: | Line 3: | ||
|Name=Hover Dynamic Value Set`1 | |Name=Hover Dynamic Value Set`1 | ||
}} | }} | ||
The '''HoverDynamicValueSet''' component listens for a [[User|user]]'s hover event on a [[UIX]] element and sets a value. | |||
{{Table ComponentFields | {{Table ComponentFields | ||
|VariableName|String| | |VariableName|String|The dynamic variable name to find these values. | ||
|ValueOnBeginHover|'''T'''|TypeAdv1=true| | |ValueOnBeginHover|'''T'''|TypeAdv1=true|The value to set when a hover event is detected. | ||
|ValueOnEndHover|'''T'''|TypeAdv2=true| | |ValueOnEndHover|'''T'''|TypeAdv2=true|The value to set when a hover event has ended. | ||
|SetValueOnBeginHover|Bool| | |SetValueOnBeginHover|Bool|Sets the value when a hover event is detected. | ||
|SetValueOnEndHover|Bool| | |SetValueOnEndHover|Bool|Sets the value when a hover event has ended. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
| Line 23: | Line 23: | ||
[[Category:Components{{#translation:}}|Hover Dynamic Value Set`1]] | [[Category:Components{{#translation:}}|Hover Dynamic Value Set`1]] | ||
[[Category:Generic Components{{#translation:}}|Hover Dynamic Value Set`1]] | [[Category:Generic Components{{#translation:}}|Hover Dynamic Value Set`1]] | ||
Latest revision as of 09:52, 27 July 2024
Component image 
Hover Dynamic Value Set`1 component as seen in the Scene Inspector
The HoverDynamicValueSet component listens for a user's hover event on a UIX element and sets 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. |
VariableName
|
String | The dynamic variable name to find these values. |
ValueOnBeginHover
|
T | The value to set when a hover event is detected. |
ValueOnEndHover
|
T | The value to set when a hover event has ended. |
SetValueOnBeginHover
|
Bool | Sets the value when a hover event is detected. |
SetValueOnEndHover
|
Bool | Sets the value when a hover event has ended. |