HPL3/SOMA/Modding/Developer Debug Menu - Revision history

Crater: /* Debug Texts */ Merged sections into single table

2022-01-20T21:17:05Z

Debug Texts: Merged sections into single table

Crater: /* Graphics Debug */

2022-01-17T17:49:21Z

Graphics Debug

Crater: /* Graphics Debug */ Updated formatting and added a few missing options. Still need to fill in a few rendering options (portal debug + occluders)

2022-01-17T17:39:21Z

Graphics Debug: Updated formatting and added a few missing options. Still need to fill in a few rendering options (portal debug + occluders)

Crater: /* Misc */ Added section

2022-01-17T17:26:28Z

Misc: Added section

Crater: /* Stress Test */ Added section

2022-01-17T17:20:43Z

Stress Test: Added section

Crater: /* Input */ Added section

2022-01-17T17:15:00Z

Input: Added section

Crater: /* Game */ Added section

2022-01-17T16:43:44Z

Game: Added section

Crater: /* Map */ Updated formatting, fixed some incorrect info, and added missing option

2022-01-17T16:26:33Z

Map: Updated formatting, fixed some incorrect info, and added missing option

Crater: /* Texts Options */ updated entity/module info descriptions

2021-09-15T09:06:26Z

Texts Options: updated entity/module info descriptions

Crater: /* Light Complexity */ fixed duplicated text

2021-09-15T07:43:36Z

Light Complexity: fixed duplicated text

@@ Line 52: / Line 52: @@
 ==Debug Texts==
 This section is at the very top of the menu and consists of checkboxes which display different information about the game, map, physics, script, etc on in the form of text on the screen.
-===Texts Options===
 {| class="wikitable"
 |+
@@ Line 149: / Line 149: @@
 |Use Portal Culling
 |Enables the game to use portal culling in the map. It is recommended to always leave that on, unless you want to see the difference in performance. {{Todo|add reference link for portals}}
-|}
+|-
+|Brightness
-===Additional Options===
+|The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
+|-
-====Brightness====
+|Print Container Debug Info
-The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
+|This button prints container debug info to the screen.
 {{Bug|The button makes the game crash.}}
-----
+|-
-====Merge Lang Files====
+|Merge Lang Files
-Merges two language files between the main game language file and another.
+|Merges two language files between the main game language file and another.
 {{note|This feature doesn't seem to be useful in practice.}}
 ==Map==

@@ Line 387: / Line 387: @@
 |Creates a [https://en.wikipedia.org/wiki/Heat_map heat map] that shows how much translucent overdraw each pixel receives. Overdraw is how many times a pixel gets rendered to.{{clarify}}<br>'''The goal should be that no part of the screen is red'''. It does not matter that much if only a small part is, however.
-<br /> [[File:translucent_overdraw.png|alt=|left|650x650px|On the left you can see the scene rendered normally. The fog particles are barely visible here. On the right the pixel overdraw is rendered. The red areas show that more than 32 translucent planes are rendered, which is not good.|thumb]] {{clr}}
+<br /> [[File:translucent_overdraw.png|alt=|left|650x650px|On the left you can see the scene rendered normally. The fog particles are barely visible here. On the right the pixel overdraw is rendered. The red areas show that more than 32 translucent planes are rendered, which is not good.|thumb]]
 |}
 [[Category:Modding]]
 [[Category:English]]

@@ Line 351: / Line 351: @@
 Debugging the graphic performance of a level is vital to understand which parts are causing the bottleneck. It can also be used to find bugged/incorrect meshes or entities. With this section of the debug menu, you will be able to find which parts of the scene take up the most performance.
-===Show FPS Graph===
+{| class="wikitable"
-This option displays on the screen a graph that shows FPS peaks on a time scale. It's useful for finding areas in a map that reduce FPS the most.
+|+
-[[File:Hpl3-fps-graph.png|thumb|left|FPS graph.|500x500px]] {{clr}}
+!Option
+!Description
-===Large Light Test===
+|-
-Unknown option.
+|Show FPS Graph
+|This option displays on the screen a graph that shows FPS peaks on a time scale. It's useful for finding areas in a map that reduce FPS the most.
-===Previous Frame Occlusion===
+<br /> [[File:Hpl3-fps-graph.png|thumb|left|FPS graph.|500x500px]]
-This option pauses the occlusion culling and renders the scene with the occlusion culling from before the checkbox was ticked. This is used to see how effective the occlusion culling is in the specific scene. After activating this you can switch to to spectator camera mode and look at the scene from another angle to see where the culling fails. Activating this will disable rendering of translucent objects since they can be unstable.
+|-
+|Large Light Test
-[[File:Occlusion_preview.png|alt=|thumb|left|500x500px|On the left, you can see what the player sees. On the right, the camera has been moved back and it is now possible to see all the objects that get rendered this frame. There are a lot more than what it looks like in the left picture.]]{{clr}}
+|Unknown option.
+|-
-===GBuffer===
+|Previous Frame Occlusion
-Shows what the frame buffers look like. These are then used by the lights to shade the scene. It can be used to check if a model has incorrect textures or normals.
+|This option pauses the occlusion culling and renders the scene with the occlusion culling from before the checkbox was ticked. This is used to see how effective the occlusion culling is in the specific scene. After activating this you can switch to to spectator camera mode and look at the scene from another angle to see where the culling fails. Activating this will disable rendering of translucent objects since they can be unstable.
-[[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]{{clr}}
+<br /> [[File:Occlusion_preview.png|alt=|thumb|left|500x500px|On the left, you can see what the player sees. On the right, the camera has been moved back and it is now possible to see all the objects that get rendered this frame. There are a lot more than what it looks like in the left picture.]]
+<br /> {{bug|This option seems to be broken.}}
-===Light Complexity===
+|-
-Light complexity shows how expensive the lighting of a scene is. It creates a heat map on the screen to show how much power each light takes. Overdraw of light is not very expensive, it is about twice as expensive as a translucent object. When the light has a shadow map it becomes much more expensive. The complexity of a shadow casting light is based on how many draw calls and triangles are required to generate the shadow map.
+|Render Portal Debug
-[[File:Light_complexity.png|alt=|left|thumb|500x500px|The red areas on the right image are not good. There seem to be multiple large (in screen space) shadow casting lights in this scene.
+|Desc {{clarify}}
-]] {{Clr}}
+|-
+|Render Only Occluders
-{{tip|To test if most of the complexity comes from shadows or not, you can toggle the <code>Draw Shadows</code> checkbox in the menu. Here is what the scene complexity looks like without shadows: {{clr}} [[File:light_complexity_no_shadows.png|alt=|frame|left]] {{clr}} }}
+|Desc {{clarify}}
+|-
-===Overdraw===
+|Render GBuffer
-Creates a [https://en.wikipedia.org/wiki/Heat_map heat map] that shows how much translucent overdraw each pixel receives. Overdraw is how many times a pixel gets rendered to.{{clarify}}<br>'''The goal should be that no part of the screen is red'''. It does not matter that much if only a small part is, however.
+|Shows what the frame buffers look like. These are then used by the lights to shade the scene. It can be used to check if a model has incorrect textures or normals.
+<br /> [[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]
-[[File:translucent_overdraw.png|alt=|left|650x650px|On the left you can see the scene rendered normally. The fog particles are barely visible here. On the right the pixel overdraw is rendered. The red areas show that more than 32 translucent planes are rendered, which is not good.|thumb]] {{clr}}
+|-
 [[Category:Modding]]
 [[Category:English]]

@@ Line 329: / Line 329: @@
 ==Misc==
 The misc section include options which don't fit anywhere else.
-{{stub}}
 ==Graphics Debug==

@@ Line 308: / Line 308: @@
 ==Stress Test==
 This is a tool used to test the map under heavy performance conditions.
-{{stub}}
 ==Misc==

@@ Line 290: / Line 290: @@
 ==Input==
 The Input section of the menu includes tools and option for capturing and analyzing user input.
-{{stub}}
 ==Stress Test==

@@ Line 233: / Line 233: @@
 ==Game==
 The game section of the menu includes general-purposes option which affect how you play and move in the game. It also displays debug information such as scripting errors.
-{{stub}}
 ==Input==

@@ Line 167: / Line 167: @@
 The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
-===Auto Reload Resources===
+{| class="wikitable"
-This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
+|+
+!Option
-===Reload Script At Task Switch===
+!Description
-The script file for the map will be updated when a [https://www.hongkiat.com/blog/switch-tasks-windows-10/ task switch] has been performed. Meaning, as long as you do not go back to the game after changing the script, the new script won't be updated in the game.
+|-
+|Auto Reload Resource
-===Reload Script Constantly===
+|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
-The script file for the map will be updated constantly every time it is saved. It doesn't matter if the game task is focused or not.
+|-
+|Reload Script At Task Switch
-===Recompile Script and Lang===
+|The script file for the map will be updated when a [https://www.hongkiat.com/blog/switch-tasks-windows-10/ task switch] has been performed. Meaning, as long as you do not go back to the game after changing the script, the new script won't be updated in the game.
-Leftover feature from HPL2. The button does not work.
+|-
+|Reload Script Constantly
-===Reload from current pos===
+|The script file for the map will be updated constantly every time it is saved. It doesn't matter if the game task is focused or not.
-When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
+|-
+|Recompile Script and Lang
-===Fast Physics Load===
+|Leftover feature from HPL2. The button does not work.
-Unknown option. {{Clarify}}
+|-
+|Reload from current pos
-===Reload Game===
+|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
-Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
+|-
+|Fast Physics Load
-===Script Debug===
+|Unknown option. {{Clarify}}
-Script Debug enables further scripting features that won't work otherwise, such as [[HPL3/Scripting/Scripting Guide/The OnAction method|OnAction]]. It is also useful to make your map behave differently. In your map script file, you may want to change the behavior of your map depends if the script debug is enabled or not. For example: <syntaxhighlight lang="c++">
+|-
 // This script will enable the player's flashlight only if the script debug is on.
 void OnStart()
@@ Line 199: / Line 204: @@
+}
 </syntaxhighlight>
+|-
-===Teleport to Start Pos===
+|Load Map
-Teleports the player to a specific [[HPL3/Inputs_and_Outputs_Systems/PlayerStart_Area|PlayerStart Area]] that can be selected from the dropdown list. Useful for skipping areas in a map.
+|Select a map file to load in the game. HPL3 Map File (<code>.hpm</code>) and HPL2 Map File (<code>.map</code>) are accepted.
 {{warning|Some things are almost guranteed to not load correctly when loading HPL2 map files, mostly related to issues with static-objects. This is due to the internal structure of the .map files and how it handles assets information.}}
+|-
-===Test Change Map Save===
+|Test Change Map Save
-Unknown option. {{clarify}}
+|Unknown option. {{clarify}}
+|-
-===Preload Map===
+|Teleport to Start Pos
-Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
+|Teleports the player to a specific [[HPL3/Inputs_and_Outputs_Systems/PlayerStart_Area|PlayerStart Area]] that can be selected from the dropdown list. Useful for skipping areas in a map.
+|-
-===Start Preloaded Map===
+|Map Batch
-Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
+|Unknown option. {{clarify}}
+|-
-===Keep Previous Map Loaded===
+|Preload Map
-Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
+|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
+|-
-===Preload Priority===
+|Start Preloaded Map
-Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
+|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
 ==Game==

@@ Line 62: / Line 62: @@
 |-
 |Show module info
-|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. It does not seem to be useful however, as not enough information is displayed.
+|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
 |-
 |Show map info
@@ Line 68: / Line 68: @@
 |-
 |Show entity info
-|Does not work.
+|Shows information about different entities (such as agents) in the map. If an entity is using the pathfinder component, area nodes and the navmesh will be visible. Add custom debug outputs in the entities <code>DrawDebugOutput()</code> function.
 |-
 |Show sounds playing