Component:ReferenceGrabReceiver: Difference between revisions

Latest revision as of 23:54, 27 July 2024

Component image

**ReferenceGrabReceiver** component as seen in the Scene Inspector

The ReferenceGrabReceiver component can receive a reference dropped onto a UIX element Button by a user. The reference dropped is then stored into the field specified by TargetReference (an example would be to use the ReferenceField).

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.
`TargetReference`	ISyncRef	the place to store the received value, ex: the `Reference` on a Reference Field Component

Usage

Letting go when the reference you want to send into the TargetReference field, is currently the way on how it can trigger.
Combining this with the ReferenceProxySource component is a powerful way of moving references around without the need to open a Scene Inspector. Having a ReferenceField of IWorldElement as the TargetReference is the most recommended way of successfully transferring a reference this way.

Examples

This can be used to allow the user to put in slots, music, or even value fields in a UIX canvas/panel for installers/settings for different systems.

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=ReferenceGrabReceiverComponent.png
@@ Line 8: / Line 7: @@
 }}
-<!--T:2-->
+The '''ReferenceGrabReceiver''' component can receive a reference dropped onto a [[UIX]] element [[Component:Button|Button]] by a [[User|user]]. The reference dropped is then stored into the field specified by <code>TargetReference</code> (an example would be to use the [[Component:ReferenceField|ReferenceField]]).
-== Intoduction ==
 <!--T:3-->
-== Usage ==
 {{Table ComponentFields
-|TargetReference|ISyncRef|
+|TargetReference|ISyncRef| the place to store the received value, ex: the <code>Reference</code> on a [[Component:ReferenceField|Reference Field Component]]
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
+* Letting go when the reference you want to send into the <code>TargetReference</code> field, is currently the way on how it can trigger.
+* Combining this with the [[Component:ReferenceProxySource|ReferenceProxySource]] component is a powerful way of moving references around without the need to open a [[Scene Inspector]]. Having a [[Component:ReferenceField|ReferenceField]] of [[Type:IWorldElement|IWorldElement]] as the <code>TargetReference</code> is the most recommended way of successfully transferring a reference this way.
 <!--T:5-->
 == Examples ==
+This can be used to allow the user to put in slots, music, or even value fields in a [[UIX]] canvas/panel for installers/settings for different systems.
 <!--T:6-->
 == Related Components ==
 </translate>
-[[Category:Components{{#translation:}}|ReferenceGrabReceiver (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Reference Grab Receiver]]
-[[Category:ComponentStubs]]
+[[Category:Components:UIX:Interaction{{#translation:}}|Reference Grab Receiver]]
-[[Category:Components:UIX:Interaction{{#translation:}}|ReferenceGrabReceiver (Component){{#translation:}}]]