add info |
Added more usage notes. |
||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{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>TargetReference</code> (an example would be to use the [[Component:ReferenceField|ReferenceField]]). | |||
<!--T:3--> | <!--T:3--> | ||
{{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--> | ||
== | == 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--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
This can be used to allow the user to put in slots, music, or even value fields in a | 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--> |
Latest revision as of 23:54, 27 July 2024
Component image
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).
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.