Component:DesktopControlDialog: Difference between revisions

From Resonite Wiki
add Sync delegates
fix table
Line 18: Line 18:
{{Table ComponentTriggers  
{{Table ComponentTriggers  
|OnDisplayItemGenerated()|[[Component:DesktopDisplayLayout#DisplayItemHandler|DisplayItemHandler]]| Used to handle the creation of new displays and their UI from a [[Component:DesktopDisplayLayout|DesktopDisplayLayout]].
|OnDisplayItemGenerated()|[[Component:DesktopDisplayLayout#DisplayItemHandler|DisplayItemHandler]]| Used to handle the creation of new displays and their UI from a [[Component:DesktopDisplayLayout|DesktopDisplayLayout]].
|OnSwitchDisplay()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:Int|Int]] index>
|OnSwitchDisplay()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:Int|Int]] index>| handles switching the viewed desktop display for this component.
|OnOpenKeyboard()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Handles the opening of a keyboard and focusing it to the desktop.
|OnOpenKeyboard()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Handles the opening of a keyboard and focusing it to the desktop.
|OnOpenStartMenu()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| handles opening a computer's start menu.
|OnOpenStartMenu()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| handles opening a computer's start menu.

Revision as of 21:09, 15 January 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.

Usage

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() DisplayItemHandler X OnSwitchDisplay()
Delegate<IButton: button, ButtonEventData: eventData, Int index> handles switching the viewed desktop display for this component.

X Delegate<IButton: button, ButtonEventData: eventData>
Handles the opening of a keyboard and focusing it to the desktop.

OnOpenStartMenu() X handles opening a computer's start menu.

Examples

Used in the user dash.

See Also