Component:ValueProxySource: Difference between revisions

From Resonite Wiki
Added a description, added field descriptions, added usage description. Added see also section with links to similar components.
Added a danger note!
 
Line 5: Line 5:


The '''ValueProxySource''' component allows for the [[User|user]] to grab a [[Value Type|value]] off from a [[UIX]] element. This requires a [[Component:Button|Button]] component to work.
The '''ValueProxySource''' component allows for the [[User|user]] to grab a [[Value Type|value]] off from a [[UIX]] element. This requires a [[Component:Button|Button]] component to work.
{{Note|'''DO NOT''' use any other type than a [[Value Type]] when using this component! This component will crash a world with a [[Reference Type]]!|danger}}


{{Table ComponentFields
{{Table ComponentFields

Latest revision as of 10:09, 31 July 2024

Component image 
Value Proxy Source`1 component as seen in the Scene Inspector


The ValueProxySource component allows for the user to grab a value off from a UIX element. This requires a Button component to work.

DO NOT use any other type than a Value Type when using this component! This component will crash a world with a Reference Type!
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.
Value T The value itself.

Usage

This is used to carry values to other UIX elements that are looking for it. Using this component along with the ReferenceGrabReceiver and ValueField of a value type will allow the user to carry the value from source to receiver directly.

Examples

See Also