Component:EngineDebugDialog: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update SyncDelegates
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=EngineDebugDialogComponent.png
|Image=EngineDebugDialogComponent.png
Line 9: Line 10:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DisplayMode|'''[[#Mode|Mode]]'''|TypeAdv0=true| How to display the content.
|DisplayMode|'''[[#Mode|EngineDebugDialog.Mode]]'''|TypeAdv0=true| How to display the content.
|_contentRoot|Slot| Content of the debug dialouge.
|_contentRoot|Slot| Content of the debug dialouge.
|_text|'''[[Component:Text|Text]]'''|TypeAdv2=true| The text displaying the engine debug info.
|_text|'''[[Component:Text|Text]]'''|TypeAdv2=true| The text displaying the engine debug info.
Line 16: Line 17:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SwitchToGatherJobs(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToGatherJobs:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Gather Jobs one.
|SwitchToWorlds(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToWorlds:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Worlds one.
|SwitchToLoadedAssets(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToLoadedAssets:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Loaded Assets one.
|SwitchToSpecial(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToSpecial:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the  Special one.
|SwitchToFocusedWorld(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToFocusedWorld:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Focused World one.
|SwitchToPhysics(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToPhysics:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the  Physics one.
|SwitchToBackgroundJobs(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToBackgroundJobs:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Background Jobs one.
|CapturePerformanceStats(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|CapturePerformanceStats:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Copies the performance stats to the clipboard.
|UploadCC0Textures(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|UploadCC0Textures:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| DEVELOPER TEAM ONLY. DOES NOT DO ANYTHING ON PUBLIC BUILDS!
|CopyBackgroundWorkerSnapshot(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|CopyBackgroundWorkerSnapshot:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Copies a background worker snapshot to disk.
|StartRecordingPerfMetrics(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|StartRecordingPerfMetrics:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Records performance metrics to disk.
|ForceFullGC(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|ForceFullGC:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Forces the engine to garbage collect all ram data.
|SaveObjectPoolStats(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SaveObjectPoolStats:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Saves object pool stats to disk.
|SwitchToNormalDash(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SwitchToNormalDash:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Closes the dialog.
}}
}}


Latest revision as of 18:24, 3 April 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.
Component image 
File:EngineDebugDialogComponent.png
Engine Debug Dialog component as seen in the Scene Inspector

The EngineDebugDialog component is used in the debug screen of the dash to show debug information about the game at the current moment.

This game element is a debug item. Elements like this may be removed at any time without warning, and creations should not rely on 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.
DisplayMode EngineDebugDialog.Mode How to display the content.
_contentRoot Slot Content of the debug dialouge.
_text Text The text displaying the engine debug info.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
SwitchToGatherJobs:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Gather Jobs one.
SwitchToWorlds:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Worlds one.
SwitchToLoadedAssets:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Loaded Assets one.
SwitchToSpecial:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Special one.
SwitchToFocusedWorld:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Focused World one.
SwitchToPhysics:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Physics one.
SwitchToBackgroundJobs:ButtonEventHandler ButtonEventHandler ✓ Switches the dialog screen to the Background Jobs one.
CapturePerformanceStats:ButtonEventHandler ButtonEventHandler ✓ Copies the performance stats to the clipboard.
UploadCC0Textures:ButtonEventHandler ButtonEventHandler ✓ DEVELOPER TEAM ONLY. DOES NOT DO ANYTHING ON PUBLIC BUILDS!
CopyBackgroundWorkerSnapshot:ButtonEventHandler ButtonEventHandler ✓ Copies a background worker snapshot to disk.
StartRecordingPerfMetrics:ButtonEventHandler ButtonEventHandler ✓ Records performance metrics to disk.
ForceFullGC:ButtonEventHandler ButtonEventHandler ✓ Forces the engine to garbage collect all ram data.
SaveObjectPoolStats:ButtonEventHandler ButtonEventHandler ✓ Saves object pool stats to disk.
SwitchToNormalDash:ButtonEventHandler ButtonEventHandler ✓ Closes the dialog.

Mode

Template:Table EnumFields

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:EngineDebugDialog&oldid=98813"