Component:DesktopInteractionRelay: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Desktop Interaction Relay
|Name=Desktop Interaction Relay
}}
}}
{{stub}}
The '''DesktopInteractionRelay''' component only works in user space. When part of a UIX, it sends events from user inputs (the position is determined by the [[Component:RectTransform|RectTransform]]) to the desktop display at <code>DisplayIndex</code>


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DisplayIndex|Int|
|DisplayIndex|Int| The display to send Interactions to.
|UseLegacyTextInput|Bool|
|UseLegacyTextInput|Bool| Whether to use the legacy text input system.
}}
}}
== Behavior ==
== Examples ==


== See Also ==
== See Also ==
Line 19: Line 15:
[[Category:Components:Input:Desktop{{#translation:}}|Desktop Interaction Relay]]
[[Category:Components:Input:Desktop{{#translation:}}|Desktop Interaction Relay]]
[[Category:Components{{#translation:}}|Desktop Interaction Relay]]
[[Category:Components{{#translation:}}|Desktop Interaction Relay]]
[[Category:ComponentStubs]]

Latest revision as of 21:13, 15 January 2025

Component image 
Desktop Interaction Relay component as seen in the Scene Inspector

The DesktopInteractionRelay component only works in user space. When part of a UIX, it sends events from user inputs (the position is determined by the RectTransform) to the desktop display at DisplayIndex

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.
DisplayIndex Int The display to send Interactions to.
UseLegacyTextInput Bool Whether to use the legacy text input system.

See Also