Component:ReferenceReceiver

From Resonite Wiki
This page contains changes which are not marked for translation.
Component image 
Reference Receiver component as seen in the Scene Inspector

The ReferenceReceiver 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).

This component has a non generic version of the same name. That component uses a "ISyncRef" instead of "ISyncRef<T>" for TargetReference.
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.
TargetReference ISyncRef
Undoable Bool Whether dropping elements onto this UIX interactable is undoable.

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.

See Also