Component:DesktopControlDialog: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Automated: update SyncDelegates
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Desktop Control Dialog
|Name=Desktop Control Dialog
}}
}}
{{stub}}
The '''DesktopControlDialog''' is used to change the settings for what desktop to control and how to control it.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|InteractionRelay|'''[[Component:DesktopInteractionRelay|DesktopInteractionRelay]]'''|TypeAdv0=true|
|InteractionRelay|'''[[Component:DesktopInteractionRelay|DesktopInteractionRelay]]'''|TypeAdv0=true| The relay allowing desktop interaction.
|Index|Int|
|Index|Int| The display to show in a multi monitor settup.
|FollowCursor|Bool|
|FollowCursor|Bool| whether the desktop cursor should follow the Resonite dash cursor when not clicking.
|Brightness|Float|
|Brightness|Float| how bright the desktop display should be in the dash.
|Opacity|Float|
|Opacity|Float| how transparent the desktop display should be in the dash.
|LegacyInputMode|Bool|
|LegacyInputMode|Bool| Whether to use the legacy input system for desktop interaction.
}}
}}


== Behavior ==
== Sync Delegates ==
{{Table ComponentTriggers
|OnDisplayItemGenerated:[[Type:Action`2|Action`2]]<[[Type:Display|Display]], [[Type:Slot|Slot]]>|[[Type:Action`2|Action`2]]<[[Type:Display|Display]], [[Type:Slot|Slot]]>|true| Used to handle the creation of new displays and their UI from a [[Component:DesktopDisplayLayout|DesktopDisplayLayout]].
|OnSwitchDisplay:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Int|Int]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Int|Int]]>|true| handles switching the viewed desktop display for this component.
|OnOpenKeyboard:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles the opening of a keyboard and focusing it to the desktop.
|OnOpenStartMenu:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| handles opening a computer's start menu.
}}


== Examples ==
== Examples ==
Used in the user dash.


== See Also ==
== See Also ==
Line 23: Line 30:
[[Category:Components:Input:Desktop{{#translation:}}|Desktop Control Dialog]]
[[Category:Components:Input:Desktop{{#translation:}}|Desktop Control Dialog]]
[[Category:Components{{#translation:}}|Desktop Control Dialog]]
[[Category:Components{{#translation:}}|Desktop Control Dialog]]
[[Category:ComponentStubs]]

Latest revision as of 06:30, 17 March 2025

Component image 
Desktop Control Dialog component as seen in the Scene Inspector

The DesktopControlDialog is used to change the settings for what desktop to control and how to control it.

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.
InteractionRelay DesktopInteractionRelay The relay allowing desktop interaction.
Index Int The display to show in a multi monitor settup.
FollowCursor Bool whether the desktop cursor should follow the Resonite dash cursor when not clicking.
Brightness Float how bright the desktop display should be in the dash.
Opacity Float how transparent the desktop display should be in the dash.
LegacyInputMode Bool Whether to use the legacy input system for desktop interaction.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnDisplayItemGenerated:Action`2<Display, Slot> Action`2<Display, Slot> Used to handle the creation of new displays and their UI from a DesktopDisplayLayout.
OnSwitchDisplay:ButtonEventHandler`1<Int> ButtonEventHandler`1<Int> handles switching the viewed desktop display for this component.
OnOpenKeyboard:ButtonEventHandler ButtonEventHandler Handles the opening of a keyboard and focusing it to the desktop.
OnOpenStartMenu:ButtonEventHandler ButtonEventHandler handles opening a computer's start menu.

Examples

Used in the user dash.

See Also