Component:ValueReceiver: Difference between revisions

Latest revision as of 15:13, 3 August 2025

Component image

**Value Receiver`1** component as seen in the Scene Inspector

The ValueReceiver component is used in UIX elements to allow dropping a value property into a Component:Button or interactable UIX section to change a value field to the dropped value.

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.
`Field`	IField`1<T>	The field to drop the value into.
`Undoable`	Bool	Whether dropping the value is undo able.
`TryConvertValues`	Bool	Tries to change a dropped value which is possibly a string into the proper format by parsing.

Usage

Attach to a UIX element to allow an interactable to have droppable values into a target value field. Needs to be provided a target Field in order for it to work.

Examples

Used in inspectors, system installers, and value entries to allow the user to drop values into an installer UI.

@@ Line 3: / Line 3: @@
 |Name=Value Receiver`1
 }}
-{{stub}}
+The '''ValueReceiver''' component is used in [[UIX]] elements to allow dropping a value property into a [[Component:Button]] or interactable UIX section to change a value field to the dropped value.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Field|'''[[Type:IField`1|IField`1]]&lt;T&gt;'''|TypeAdv0=true|
+|Field|'''[[Type:IField`1|IField`1]]&lt;T&gt;'''|TypeAdv0=true| The field to drop the value into.
-|Undoable|Bool|
+|Undoable|Bool| Whether dropping the value is undo able.
-|TryConvertValues|Bool|
+|TryConvertValues|Bool| Tries to change a dropped value which is possibly a string into the proper format by parsing.
 }}
-== Behavior ==
+== Usage ==
+Attach to a [[UIX]] element to allow an interactable to have droppable values into a target value field. Needs to be provided a target <code>Field</code> in order for it to work.
 == Examples ==
+Used in inspectors, system installers, and value entries to allow the user to drop values into an installer UI.
 == See Also ==
+* [[Component:ReferenceReceiver]]
 [[Category:Components:UIX:Interaction{{#translation:}}|Value Receiver`1]]
 [[Category:Components{{#translation:}}|Value Receiver`1]]
 [[Category:Generic Components{{#translation:}}|Value Receiver`1]]
-[[Category:ComponentStubs]]