Component:ReferenceDriveReceiver: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Reference Drive Receiver`1
|Name=Reference Drive Receiver`1
}}
}}
{{stub}}
The '''ReferenceDriveReceiver''' component is used to allow dropping a reference proxy via the user's hand onto a UIX element to trigger the prompt for driving a reference field. This requires a UIX button to work.


== Usage ==
== Fields. ==
{{Table ComponentFields
{{Table ComponentFields
|Reference|'''[[Type:SyncRef`1|SyncRef`1]]<T>'''|TypeAdv0=true|
|Reference|'''[[Type:SyncRef`1|SyncRef`1]]<T>'''|TypeAdv0=true| The field this should allow an option to drive for when a reference is dropped onto the UIX element this is on.
}}
}}


== Behavior ==
== Usage ==
Attach to a slot as part of a [[Component:Canvas]] hierarchy with a [[Component:Button]] in the same slot. Provide a value for <code>Reference</code> for it to start working.


== Examples ==
== Examples ==
Used in [[Scene Inspector]]s to allow for driving reference fields by dragging and dropping references.


== See Also ==
== See Also ==
Line 19: Line 21:
[[Category:Components{{#translation:}}|Reference Drive Receiver`1]]
[[Category:Components{{#translation:}}|Reference Drive Receiver`1]]
[[Category:Generic Components{{#translation:}}|Reference Drive Receiver`1]]
[[Category:Generic Components{{#translation:}}|Reference Drive Receiver`1]]
[[Category:ComponentStubs]]

Latest revision as of 03:13, 1 August 2025

Component image 
Reference Drive Receiver`1 component as seen in the Scene Inspector

The ReferenceDriveReceiver component is used to allow dropping a reference proxy via the user's hand onto a UIX element to trigger the prompt for driving a reference field. This requires a UIX button to work.

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.
Reference SyncRef`1<T> The field this should allow an option to drive for when a reference is dropped onto the UIX element this is on.

Usage

Attach to a slot as part of a Component:Canvas hierarchy with a Component:Button in the same slot. Provide a value for Reference for it to start working.

Examples

Used in Scene Inspectors to allow for driving reference fields by dragging and dropping references.

See Also