Component:EngineDebugDialog: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
mNo edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=EngineDebugDialogComponent.png
|Image=EngineDebugDialogComponent.png
|Name=Engine Debug Dialog
|Name=Engine Debug Dialog
}}
}}
{{stub}}
The '''EngineDebugDialog''' component is used in the debug screen of the dash to show debug information about the game at the current moment.
 
{{Template:Debug}}


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DisplayMode|'''[[#Mode|Mode]]'''|TypeAdv0=true|
|DisplayMode|'''[[#Mode|EngineDebugDialog.Mode]]'''|TypeAdv0=true| How to display the content.
|_contentRoot|Slot|
|_contentRoot|Slot| Content of the debug dialouge.
|_text|'''[[Component:Text|Text]]'''|TypeAdv2=true|
|_text|'''[[Component:Text|Text]]'''|TypeAdv2=true| The text displaying the engine debug info.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|SwitchToGatherJobs:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Gather Jobs one.
|SwitchToWorlds:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Worlds one.
|SwitchToLoadedAssets:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Loaded Assets one.
|SwitchToSpecial:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the  Special one.
|SwitchToFocusedWorld:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Focused World one.
|SwitchToPhysics:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the  Physics one.
|SwitchToBackgroundJobs:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Switches the dialog screen to the Background Jobs one.
|CapturePerformanceStats:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Copies the performance stats to the clipboard.
|UploadCC0Textures:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| DEVELOPER TEAM ONLY. DOES NOT DO ANYTHING ON PUBLIC BUILDS!
|CopyBackgroundWorkerSnapshot:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Copies a background worker snapshot to disk.
|StartRecordingPerfMetrics:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Records performance metrics to disk.
|ForceFullGC:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Forces the engine to garbage collect all ram data.
|SaveObjectPoolStats:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Saves object pool stats to disk.
|SwitchToNormalDash:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Closes the dialog.
}}
}}


== Behavior ==
== Mode ==
{{Table EnumFields
|GatherJobs|0| Show gather jobs that the user is gathering like assets.
|Worlds|1| Show worlds and their debug info.
|FocusedWorld|2| Show detailed info on the focused world.
|Physics|3| Show debug info on the physics engine thread.
|BackgroundJobs|4| Show debug info on background threads like asset importing and loading.
|LoadedAssets|5| Show debug info on loaded assets.
|Special|6| Show special debug info.
}}
 
== Usage ==
{{stub}}


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 21: Line 55:
[[Category:Components{{#translation:}}|Engine Debug Dialog]]
[[Category:Components{{#translation:}}|Engine Debug Dialog]]
[[Category:Components With Nested Enums{{#translation:}}|Engine Debug Dialog]]
[[Category:Components With Nested Enums{{#translation:}}|Engine Debug Dialog]]
[[Category:ComponentStubs]]

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