Component:ReferenceGrabReceiver: Difference between revisions

From Resonite Wiki
add info
Added and updated descriptions. Fixed style.
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
Reference Grab Receiver is a component that can receive a reference dropped onto a UIX [[Component:Canvas|Canvas]] [[Component:Button|Button]] by a user. The reference dropped is then stored into the field specified by <code>Target Reference</code>
{{Infobox Component
{{Infobox Component
|Image=ReferenceGrabReceiverComponent.png
|Image=ReferenceGrabReceiverComponent.png
|Name=ReferenceGrabReceiver
|Name=ReferenceGrabReceiver
}}
}}
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>Target Reference</code> (an example would be to use the [[Component:ReferenceField|ReferenceField]]).


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|TargetReference|ISyncRef| the place to store the received value, ex: the <code>Reference</code> on a [[Component:ReferenceField|Reference Field Component]]
|TargetReference|ISyncRef| the place to store the received value, ex: the <code>Reference</code> on a [[Component:ReferenceField|Reference Field Component]]
Line 15: Line 15:


<!--T:4-->
<!--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.


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
This can be used to allow the user to put in slots, music, or even value fields in a uix canvas for installers/settings for different systems.
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-->
<!--T:6-->

Revision as of 11:35, 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 Target Reference (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.

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