Frictional Wiki - User contributions [en]

Hpl3:Community:hpl3 legacy editors

2024-09-29T00:33:06Z

Crater:

{{cleanup|This page needs to be updated and moved to the new wiki namespace. Is the Legacy section still needed?}}

= HPL3 - SOMA =

The SOMA editors should be included with the Steam version of the game, but are missing from other sources such as the Epic Games Store.

If your copy is missing the editors, download the .zip linked below and extract the files to the root of your install folder.

https://drive.google.com/file/d/1YEo3kMHYF55T9QLEsCLx4L9Mh-BVKEz0/view?usp=sharing

= HPL3 - Legacy Editors =

== Introduction ==

This section of the wiki will be dedicated to hosting older versions of editors compatible with the HPL3 engine. These editors are here for archiving and compatibility purposes. It is unlikely you will require any of these, however, they will be made available here should an issue occur.

'''The newest HPL3 editors should be included with the game in the same folder as the game executable file (.exe).'''

If there is an issue with any of your editors, it is highly recommended to repair your installation. Steam users may do so by verifying their game cache. See [https://www.frictionalgames.com/forum/thread-30585.html Problem K in the Troubleshooting Guide] on the forums for further instructions to do this. GOG users may do so by performing a repair on their installation. These procedures will verify your current editors are up-to-date and working, as well as repair any corrupted files within the SOMA subdirectory.

For any contributions, while you are permitted to upload your copy of the editor, please include both a SHA and a VirusTotal results link in your post. Both of these are generated by uploading a file to VirusTotal.

{{todo|Fix this link}}
{| class="wikitable sortable" border=1
| '''Editor''' || '''Upload Date''' || '''SHA''' || '''VirusTotal'''
|-
| [https://puu.sh/yO8KN/c4308fd901.zip Level Editor.zip] || 27 December 2017 || ''10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905'' || [https://www.virustotal.com/#/file/10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905/detection Link]
|-
|}

Hpl3:Community:hpl3 legacy editors

2024-09-29T00:32:43Z

Crater:

{{cleanup|This page needs to be updated and moved to the new wiki namespace. Is the Legacy section still needed?}}

= HPL3 - SOMA =

The SOMA editors should be included with the Steam version of the game, but are missing from other sources such as the Epic Games Store.

If your copy is missing the editors, download the .zip linked below and extract them to the root of your install folder.

https://drive.google.com/file/d/1YEo3kMHYF55T9QLEsCLx4L9Mh-BVKEz0/view?usp=sharing

= HPL3 - Legacy Editors =

== Introduction ==

This section of the wiki will be dedicated to hosting older versions of editors compatible with the HPL3 engine. These editors are here for archiving and compatibility purposes. It is unlikely you will require any of these, however, they will be made available here should an issue occur.

'''The newest HPL3 editors should be included with the game in the same folder as the game executable file (.exe).'''

If there is an issue with any of your editors, it is highly recommended to repair your installation. Steam users may do so by verifying their game cache. See [https://www.frictionalgames.com/forum/thread-30585.html Problem K in the Troubleshooting Guide] on the forums for further instructions to do this. GOG users may do so by performing a repair on their installation. These procedures will verify your current editors are up-to-date and working, as well as repair any corrupted files within the SOMA subdirectory.

For any contributions, while you are permitted to upload your copy of the editor, please include both a SHA and a VirusTotal results link in your post. Both of these are generated by uploading a file to VirusTotal.

{{todo|Fix this link}}
{| class="wikitable sortable" border=1
| '''Editor''' || '''Upload Date''' || '''SHA''' || '''VirusTotal'''
|-
| [https://puu.sh/yO8KN/c4308fd901.zip Level Editor.zip] || 27 December 2017 || ''10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905'' || [https://www.virustotal.com/#/file/10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905/detection Link]
|-
|}

Hpl3:Community:hpl3 legacy editors

2024-09-29T00:31:36Z

Crater: Removed Steam version specific files from Editors zip (ie the workshop uploader)

{{cleanup|This page needs to be updated and moved to the new wiki namespace. Is the Legacy section still needed?}}

= HPL3 - SOMA =

The SOMA editors should be included with the Steam version of the game, but are missing from other sources such as the Epic Games Store.

Download the .zip linked below and extract them to the root of your install folder.

https://drive.google.com/file/d/1YEo3kMHYF55T9QLEsCLx4L9Mh-BVKEz0/view?usp=sharing

= HPL3 - Legacy Editors =

== Introduction ==

This section of the wiki will be dedicated to hosting older versions of editors compatible with the HPL3 engine. These editors are here for archiving and compatibility purposes. It is unlikely you will require any of these, however, they will be made available here should an issue occur.

'''The newest HPL3 editors should be included with the game in the same folder as the game executable file (.exe).'''

If there is an issue with any of your editors, it is highly recommended to repair your installation. Steam users may do so by verifying their game cache. See [https://www.frictionalgames.com/forum/thread-30585.html Problem K in the Troubleshooting Guide] on the forums for further instructions to do this. GOG users may do so by performing a repair on their installation. These procedures will verify your current editors are up-to-date and working, as well as repair any corrupted files within the SOMA subdirectory.

For any contributions, while you are permitted to upload your copy of the editor, please include both a SHA and a VirusTotal results link in your post. Both of these are generated by uploading a file to VirusTotal.

{{todo|Fix this link}}
{| class="wikitable sortable" border=1
| '''Editor''' || '''Upload Date''' || '''SHA''' || '''VirusTotal'''
|-
| [https://puu.sh/yO8KN/c4308fd901.zip Level Editor.zip] || 27 December 2017 || ''10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905'' || [https://www.virustotal.com/#/file/10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905/detection Link]
|-
|}

Hpl3:Community:hpl3 legacy editors

2024-09-29T00:17:43Z

Crater: Added link to current SOMA editors, for versions of the game that do not include them.

{{cleanup|This page needs to be updated and moved to the new wiki namespace. Is the Legacy section still needed?}}

= HPL3 - SOMA =

The SOMA editors should be included with the Steam version of the game, but are missing from other sources such as the Epic Games Store.

Download the .zip linked below and extract them to the root of your install folder.

https://drive.google.com/file/d/1NeQcbqGXE2cmqoNrvv8fnPNAvMGpyRK8/view?usp=sharing

= HPL3 - Legacy Editors =

== Introduction ==

This section of the wiki will be dedicated to hosting older versions of editors compatible with the HPL3 engine. These editors are here for archiving and compatibility purposes. It is unlikely you will require any of these, however, they will be made available here should an issue occur.

'''The newest HPL3 editors should be included with the game in the same folder as the game executable file (.exe).'''

If there is an issue with any of your editors, it is highly recommended to repair your installation. Steam users may do so by verifying their game cache. See [https://www.frictionalgames.com/forum/thread-30585.html Problem K in the Troubleshooting Guide] on the forums for further instructions to do this. GOG users may do so by performing a repair on their installation. These procedures will verify your current editors are up-to-date and working, as well as repair any corrupted files within the SOMA subdirectory.

For any contributions, while you are permitted to upload your copy of the editor, please include both a SHA and a VirusTotal results link in your post. Both of these are generated by uploading a file to VirusTotal.

{{todo|Fix this link}}
{| class="wikitable sortable" border=1
| '''Editor''' || '''Upload Date''' || '''SHA''' || '''VirusTotal'''
|-
| [https://puu.sh/yO8KN/c4308fd901.zip Level Editor.zip] || 27 December 2017 || ''10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905'' || [https://www.virustotal.com/#/file/10f761ff5bd69e43b57130f919e3b82bc1881a28b702b39404c9d332d551e905/detection Link]
|-
|}

HPL3/Amnesia: Rebirth/Entities/Physics Body Properties

2024-05-14T05:07:28Z

Crater: Create redirect page

#REDIRECT [[HPL3/Entities/Physics Body Properties]]

HPL3/SOMA/Entities/Physics Body Properties

2024-05-14T05:06:47Z

Crater: Create redirect page

#REDIRECT [[HPL3/Entities/Physics Body Properties]]

HPL3/Entities/Physics Body Properties

2024-05-14T05:04:22Z

Crater: Creation of Body Properties Page - ported from old wiki

=== General Parameters ===

* '''Name''': Name of the body.
* '''Position''': 3D Vector storing the position in world of the center of the body.
* '''Rotation''': 3D Vector storing the body rotation.
* '''Scale''': 3D Vector storing the scale of the body.

==== '''Body Specific''' ====

* '''Body Material''': Physics material for the body.
* '''Mass''': Mass for the body. The higher the value, the heavier the body will be. A zero value means infinite.
* '''Angular Damping:''' “Air Friction” applied to the rotational speed of the body. Takes a float value between 0 (no damping) and 1 (max damping).
* '''Linear Damping:''' “Air Friction” applied to the linear speed of the body. Takes a float value between 0 (no damping) and 1 (max damping).
* '''Max Angular Speed''': Maximum speed that the body can rotate with.
* '''Max Linear Speed''': Maximum speed that the body can translate with.
* '''Buoyancy Density Mul''': Multiplies the buoyancy effect on the body when inside a liquid body. A zero value means it will not be affected by liquid at all.
* '''Blocks Sound''': Sets if the body blocks sounds.
* '''Blocks Light''': Sets if the body blocks lights.
* '''Continuous Collision''': If the body should use continuous collison detection or not. This is good for small bodies (or larger bodies that has one or many small colliders) that would easily stick or tunnel other bodies. It is also good for high speed bodies.
* '''Can attach character''': If a character standing on the body will be attached. For example if you have a moving platform and want the character to move with it as it moves.
* '''Pushed by character gravity''': If the body will be affected when a characters stands on top.
* '''Collide character''': Sets whether the body should collide with the player or not.
* '''Collide non character''': Sets whether the body should collide with non-player bodies or not.
* '''Volatile:''' If a body might disappear or for some reason leave the way open for AI. Used for bodies of mass 0.
* '''Use surface effects:''' If the body should use the material settings for effects (described in materials.cfg ) or not. If this is false there will not be sounds or particle effects created by impacts, scraping etc.
* '''Has gravity''': Sets whether gravity affects the body or not.

==== Attachments Tab ====
This tab presents the attachment tool, its workings are explained next: There are several buttons that represent each object type that can be attached to a body. The ones that are pressed indicate that the type they represent will be selectable when activating the attachment tool. The 'Attach' button will start the tool, moving around the mouse while it is active will highlight objects that belong to the selectable types. Clicking on them will add them to the entities to be attached. If already attached, the object will be detached. Clicking the mouse on no object or pressing the 'Attach' button again (now 'Done') will stop the attachment tool, and all objects that are displayed as attached before doing so will become really attached to the body. The 'Clear attachments' button is self explanatory. It will just clear any attachments made.

HPL3/SOMA/Modding/Setup Modding Environment

2024-05-08T16:54:34Z

Crater: Removed the asset/ prefix in the example lookupdirs.cfg file as its STUPID. also added missing DetailMeshes asset category

{{shortPageTitle}}
In order to have a smooth modding development experience, SOMA is needed to be configured into proper development environment.
{{note|Each section described in this article can either be configured manually (creating or editing the files yourself) or to be configured automatically, using the SOMA Mod Manager application.}}

==Setting up the Editors==
Your mod might have custom assets. In order to make the editors (Level Editor, Model Editor, etc) to load your mod's assets, it needs to be configured into a special mode called "WIP Mod".
{{tip|Even if your mod doesn't have any custom assets, it's a good practice to configure the Level Editor anyway, just so you won't have to deal with it in the future should you decide to add custom assets.}}

===WIP Mod - Manual Configuration===

#Navigate to <code>My Documents/HPL3</code>. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
#Inside that folder, create a file called <code>WIPMod.cfg</code>.
#Paste the following into the file, and save:
<syntaxhighlight lang="xml">
<WIPmod Path="Full_Path_To_Mod/entry.hpc" />
</syntaxhighlight>
(Of course, you will have to change the path in order to suit your own location of the mod).

===WIP Mod - Automatic Configuration===
You can use the [[HPL3/Third Party Tools/HPL3 Mod Manager|HPL3 Mod Manager]] in order to perform an automatic sync of the editors to your mod, which pretty much does the manual step for you.

===Final Step===

If your mod indeed has custom assets, you need to make sure the editors can add them to their look up list.

#In your mod's folder, create a new folder and name it <code>editor</code>.
#Inside that folder, create a file called <code>lookupdirs.cfg</code>.
#Create a new <code><Directories></code> xml tag inside the file.
#Add a list of directories which include your custom assets. The directory has to be associated with a category. The allowed categories are:
#*<code>StaticObjects</code>
#*<code>Entities</code>
#*<code>Billboards</code>
#*<code>Particles</code>
#*<code>Sounds</code>
#*<code>DetailMeshes</code>

Example file:
<syntaxhighlight lang="xml">
<Directories>
<Dir Category="StaticObjects" Path="static_objects/" />
<Dir Category="Entities" Path="entities/" />
<Dir Category="Billboards" Path="billboards/" />
<Dir Category="Particles" Path="particles/" />
<Dir Category="Sounds" Path="sounds/" />
</Directories>
</syntaxhighlight>

If all the above is done correctly, a <code>(Working on mod)</code> text should appear on the title bar of HPL3 editors when run.

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Setup Modding Environment

2024-05-08T15:21:32Z

Crater: add DetailMeshes lookupdir category - leveleditor.log lists this as a valid category but this needs to be verified

{{shortPageTitle}}
In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment. {{Tip|It is recommended to use the [https://wiki.frictionalgames.com/page/HPL3/Third_Party_Tools/HPL3_Mod_Manager HPL3 Mod Manager] to configure everything that is listed on this page.}} 
==Setting up Custom Story Dev Mode==
During development, it is extremely helpful to have access to the development options and [[HPL3/Amnesia:_Rebirth/Modding/Developer_Debug_Menu|debug mode]] of the game. To achieve that, you need to start the game with a few extra arguments. It is suggested that you set up a script file for your mod so you can more quickly launch it in development mode.

#In the main folder of the game, create a script file with a recognizable name for your mod development. For example: <code>myMod_dev.bat</code> (.sh for Mac/Linux)
#Paste the following text into the file and save, changing <code>MyModName</code> so it fits your mod folder name.
<pre>AmnesiaRebirth.exe -user Dev -cfg config/main_init_dev.cfg -mod local:MyModName</pre>
'''Non-Windows users''': Substitute <code>AmnesiaRebirth.exe</code> with your platform's executable, for example: <code>./Amnesia2.bin.x86_64</code>

You can now launch the script file throughout the development of your mod.

==Setting up the Editors==
Your mod might have custom assets. In order to make the editors (Level Editor, Model Editor, etc) to load your mod's assets, it needs to be configured into a special mode called "WIP Mod".
{{tip|Even if your mod doesn't have any custom assets, it's a good practice to configure the Level Editor anyway, just so you won't have to deal with it in the future should you decide to add custom assets.}}

===WIP Mod - Manual Configuration===

#Navigate to <code>My Documents/HPL3</code>. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
#Inside that folder, create a file called <code>WIPMod.cfg</code>.
#Paste the following into the file, and save:
<syntaxhighlight lang="xml">
<WIPmod Path="Full_Path_To_Mod/entry.hpc" />
</syntaxhighlight>
(Of course, you will have to change the path in order to suit your own location of the mod).

===Final Step===

If your mod indeed has custom assets, you need to make sure the editors can add them to their look up list.

#In your mod's folder, create a new folder and name it <code>editor</code>.
#Inside that folder, create a file called <code>lookupdirs.cfg</code>.
#Create a new <code><Directories></code> xml tag inside the file.
#Add a list of directories which include your custom assets. The directory has to be associated with a category. The allowed categories are:
#*<code>StaticObjects</code>
#*<code>Entities</code>
#*<code>Billboards</code>
#*<code>Particles</code>
#*<code>Sounds</code>
#*<code>DetailMeshes</code>

Example file:
<syntaxhighlight lang="xml">
<Directories>
<Dir Category="StaticObjects" Path="static_objects/" />
<Dir Category="Entities" Path="entities/" />
<Dir Category="Billboards" Path="billboards/" />
<Dir Category="Particles" Path="particles/" />
<Dir Category="Sounds" Path="sounds/" />
</Directories>
</syntaxhighlight>

If all the above is done correctly, a <code>(Working on mod)</code> text should appear on the title bar of HPL3 editors when run.

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Setup Modding Environment

2024-05-08T15:19:51Z

Crater: removed asset prefix from example lookupdirs.cfg as the Bunker editors don't seem to correctly find the directories.

{{shortPageTitle}}
In order to have a smooth modding development experience, Amnesia: Rebirth should be configured to run in a proper development environment. {{Tip|It is recommended to use the [https://wiki.frictionalgames.com/page/HPL3/Third_Party_Tools/HPL3_Mod_Manager HPL3 Mod Manager] to configure everything that is listed on this page.}} 
==Setting up Custom Story Dev Mode==
During development, it is extremely helpful to have access to the development options and [[HPL3/Amnesia:_Rebirth/Modding/Developer_Debug_Menu|debug mode]] of the game. To achieve that, you need to start the game with a few extra arguments. It is suggested that you set up a script file for your mod so you can more quickly launch it in development mode.

#In the main folder of the game, create a script file with a recognizable name for your mod development. For example: <code>myMod_dev.bat</code> (.sh for Mac/Linux)
#Paste the following text into the file and save, changing <code>MyModName</code> so it fits your mod folder name.
<pre>AmnesiaRebirth.exe -user Dev -cfg config/main_init_dev.cfg -mod local:MyModName</pre>
'''Non-Windows users''': Substitute <code>AmnesiaRebirth.exe</code> with your platform's executable, for example: <code>./Amnesia2.bin.x86_64</code>

You can now launch the script file throughout the development of your mod.

==Setting up the Editors==
Your mod might have custom assets. In order to make the editors (Level Editor, Model Editor, etc) to load your mod's assets, it needs to be configured into a special mode called "WIP Mod".
{{tip|Even if your mod doesn't have any custom assets, it's a good practice to configure the Level Editor anyway, just so you won't have to deal with it in the future should you decide to add custom assets.}}

===WIP Mod - Manual Configuration===

#Navigate to <code>My Documents/HPL3</code>. You need to open one of the editors at least once in order to see the HPL3 folder inside your document folder.
#Inside that folder, create a file called <code>WIPMod.cfg</code>.
#Paste the following into the file, and save:
<syntaxhighlight lang="xml">
<WIPmod Path="Full_Path_To_Mod/entry.hpc" />
</syntaxhighlight>
(Of course, you will have to change the path in order to suit your own location of the mod).

===Final Step===

If your mod indeed has custom assets, you need to make sure the editors can add them to their look up list.

#In your mod's folder, create a new folder and name it <code>editor</code>.
#Inside that folder, create a file called <code>lookupdirs.cfg</code>.
#Create a new <code><Directories></code> xml tag inside the file.
#Add a list of directories which include your custom assets. The directory has to be associated with a category. The allowed categories are:
#*<code>StaticObjects</code>
#*<code>Entities</code>
#*<code>Billboards</code>
#*<code>Particles</code>
#*<code>Sounds</code>

Example file:
<syntaxhighlight lang="xml">
<Directories>
<Dir Category="StaticObjects" Path="static_objects/" />
<Dir Category="Entities" Path="entities/" />
<Dir Category="Billboards" Path="billboards/" />
<Dir Category="Particles" Path="particles/" />
<Dir Category="Sounds" Path="sounds/" />
</Directories>
</syntaxhighlight>

If all the above is done correctly, a <code>(Working on mod)</code> text should appear on the title bar of HPL3 editors when run.

[[Category:Modding]]
[[Category:English]]

HPL3/Launch Configuration

2023-07-15T18:31:02Z

Crater: Added new Amnesia: The Bunker StartMap syntax

{{shortPageTitle}}
When a mod is launched, some initialization occurs and the game is configured before the mod shows up. This article explains how to configure the startup of a mod.

==Launch Configuration File==
In order to make the mod launch, we need to list some configurations and settings that affect the initialization of the mod. All of the configurations are listed inside a single XML file, called <code>main_init.cfg</code>. The file should be located inside the <code>config</code> folder of the mod. When launching a mod, either via debug mode or via the game, the mod will first read the data from this file.

===Minimal Configuration===
These are the minimal settings that should be inside a <code>main_init.cfg</code> file:

<syntaxhighlight lang="xml">
<Directories
MainSaveFolder = "Save Folder Name"
GameLanguageFolder = "config/lang/"
/>

<Variables
GameName = "Mod Name"
/>

<StartMap
File = "map_name.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
</syntaxhighlight>

{{Note|'''Note:''' Amnesia: The Bunker has different syntax for the StartMap key.
<syntaxhighlight lang="xml">
<StartMap
File = "Main:intro_map.hpm, PostIntro:main_map.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
</syntaxhighlight>}}

===Extended Configuration===
These are the full settings that can be inside a <code>main_init.cfg</code> file in order to apply further customization:

<syntaxhighlight lang="xml">
<ConfigFiles
Resources = "resources.cfg"
Materials = "materials.cfg"
SoundData = "sounddata.cfg"

DefaultBaseLanguage = "base_english.lang"
DefaultGameLanguage = "english.lang"

Modules = "config/Modules.cfg"
EntityTypes = "config/EntityTypes.cfg"
Effects = "config/Effects.cfg"
PlayerStates = "config/PlayerStates.cfg"
/>

<Directories
MainSaveFolder = "Main"

BaseLanguageFolder = "config/"
GameLanguageFolder = "config/lang_main/"
/>

<Variables
GameName = "Mod Name"
/>

<MainMenu
File="main_menu.hpm"
Folder="maps/"
Pos=""
/>

<StartMap
File = "map_name.hpm"
Folder = "maps/"
Pos = "PlayerStartArea_1"
/>
</syntaxhighlight>

{{Note|it is recommended to not change most of the settings, and only edit things that should really be customized for your mod, such as mod name, save folder name, etc.}}

===Attributes===
----
====ConfigFiles====
{| class="wikitable"
!Attribute!!Description
|-
|Resources
|Points to the [[HPL3/Resources Configuration|resources configuration]] file.
|-
|Materials
|Points to the material configuration file.
|-
|SoundData
|Points to the sound data configuration file.
|-
|DefaultBaseLanguage
|Points to the default base [[HPL3/Language Configuration|language file]].
|-
|DefaultGameLanguage
|Points to the default game [[HPL3/Language Configuration|language file]].
|-
|Modules
|Points to the [[HPL3/Modules Configuration|modules file]].
|-
|EntityTypes
|Points to [[HPL3/Entities/Entity Types|entity types]] configuration file.
|-
|Effects
|Points to the effects configuration file.
|-
|PlayerStates
|Points to the player states configuration file.
|}

====Directories====
{| class="wikitable"
!Attribute!!Description
|-
|MainSaveFolder
|The name of the folder which the save files will be placed into.
|-
|BaseLanguageFolder
|The name of the folder where [[HPL3/Language Configuration|base_english.lang]] is located at.
|-
|GameLanguageFolder
|The name of the folder where [[HPL3/Language Configuration|english.lang]] is located at.
|}

====Variables====
{| class="wikitable"
!Attribute!!Description
|-
|GameName
|The name of the mod. Will appear at the title of the game and at the task bar.
|}

====StartMap====
{| class="wikitable"
!Attribute!!Description
|-
|File
|The name of the map file + file extension (<code>.hpm</code>).
|-
|Folder
|The name of the map folder.
|-
|Pos
|The [[HPL3/Areas/PlayerStart Area|primary start position]] of the map.
|}

[[Category:Modding]]
[[Category:English]]

HPL3/Color Grading

2023-03-31T08:54:06Z

Crater: /* Creation Guide */ added note about the modern nvidia texture tool

{{shortPageTitle}}
[[File:Grading.jpg|thumb|Color Grading example]]
Color grading is a way to map the color of a pixel to another color. This can be used to change the brightness, contrast, hue, saturation, … of a whole image. 
It is possible to smoothly fade between two different grading templates. 
It uses a small 3D texture with a color as input and another color as output.

== Creation Guide ==

===Requirements===

* Photoshop (CS5 or later recommended)
* [https://developer.nvidia.com/gameworksdownload#?dn=texture-tools-for-adobe-photoshop-8-55 NVIDIA Texture Tools for Adobe Photoshop v8.55] - Download the correct version for your system (probably 64-bit)
** The modern Nvidia Texture Tool should also work using equivalent settings.{{confirm}}

===Setup===

# Take a screenshot of the game with color grading disabled
# Open the screenshot in Photoshop
# Drag and drop the default grading texture on the canvas (found at '''/core/textures/grading_default.dds''')
# Place the color strip anywhere in the image
# Flatten the image to merge all the layers
# Select "'''Image > Mode > 8 Bits/Channel'''" in the top menu
''Note: FG documentation originally listed 16 Bits/Channel, however this seemed to result in incorrect color grading results.''

===Adjustments===

* Use any of the options in "'''Image > Adjustments'''"
* These can be used to change the brightness, saturation, contrast and so on
* Any changes you see on the image in Photoshop will carry over to the game

[[File:adjustments.jpg]]

===Layers===

It is also possible to use the any of the layer blend modes. 
There are two kinds of layers allowed:

* Solid color
* Dupilcate of the first layer

It is possible to duplicate the first layer and make adjustments to it and then blend it. 
The use of Layer Masks is allowed as long as they are generated from the image and not hand painted.

[[File:layers.jpg]]

===Saving===
[[File:crop.jpg|thumb|Example crop]]
# Crop the color strip from the canvas, make sure the resulting image is 256×16 px
# Select "'''Save a Copy...'''" and set the format as "'''D3D/DDS (*.DDS)''''" and save it in the folder "'''/textures/colorgrading/'''"
# In the DDS format settings select "'''8.8.8.8 ARGB 32 bit | unsigned'''", "'''Volume Texture'''", "'''No MIP maps'''"
[[File:DDS Format Fixed.png]]

== Level Usage ==

You can apply your color grading texture either in the [[HPL3/SOMA/Level_Design/Level_Settings#ColorGrading|Level Settings]] or via the level script.
{{constructionNotice|TODO: Link to/explain color grading scripts.|width=25%}}

HPL2/Tools

2022-06-27T10:15:47Z

Crater:

[[Category:Entry pages]]
{| class="wikitable" style="margin:auto"
! colspan="2" scope="row" |Editors
|-
|'''[[HPL2/Tools/Level Editor|Level Editor]]'''||Everything that you do in the other editors comes to use here.
|-
|'''[[HPL2/Tools/Model Editor|Model Editor]]'''||Makes your 3D models come to life with ingame functions.
|-
|'''[[HPL2/Tools/Particle Editor|Particle Editor]]'''||Create fire, smoke and other particles to spice up levels and models.
|-
|'''[[HPL2/Tools/Material Editor|Material Editor]]'''||Should a texture come with normal, specular or illumination maps? Should the material be transparent or sound like metal?
|-
|[[HPL2/Tools/HplLangTool|'''HPL Language Tool''']]||Helper tool to build,edit, and translate language files
|-
! colspan="2" scope="row" |Viewers
|-
|'''[[HPL2/Tools/Map Viewer|Map Viewer]]'''||Gives extra information about the level and allows viewing without running the game. A useful tool for optimization.
|-
|'''[[HPL2/Tools/Model Viewer|Model Viewer]]'''||See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
|}
==Installation Instructions==
Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).

Make sure to click the download links as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.

===Windows===

Download the Windows HPL Editor Suite for Amnesia (click the link, it won't work if you copy it into a tab):

*[https://fricpub.s3.amazonaws.com/tools/hpl2/amnesia_tdd_1.3_editor_suite.zip Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite.zip Version 1.2 and earlier].

This file must be unpacked into the folder where you find Amnesia.exe, all .dll files and folders with game data. This may be one of two locations depending on which version of the game you have.

* '''For Steam users''': This will be your game installation directory, usually <code>C:\Program Files\Steam\steamapps\common\Amnesia - The Dark Descent\</code>
* '''For retail/other users''': This will be inside the "redist" folder inside your installation directory, for example <code>C:\Program Files\Amnesia - The Dark Descent\redist\</code>

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code><Documents>\HPL2\</code> folder.

===Linux===

Download the Linux HPL Editor Suite for Amnesia:

*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2_editor_suite-linux-2015-03-04.zip Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite_linux.zip Version 1.2.1 and earlier]

'''Updated 2011-02-19''' Updated to fix crashes when selecting enemies.

Extract the zip and run the installer (<code>hpl_editor_suite.sh</code>).

The installer should automatically find your currently installed copy of Amnesia if you installed it in one of the common installation locations. If not, simply select the Amnesia folder where you installed the game.

'''Note:''' No menu items are created by the installer, it simply installs the editor data files and executables for your platform.

'''Note:''' The HplLangTool.exe is included in the Linux HPL editor suite, it is a .NET application that does run under wine/mono.

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/.frictionalgames/HPL2</code> folder.

===Mac OS X===

Download the Mac OS X HPL Editor Suite:

*[https://fricpub.s3.amazonaws.com/tools/hpl2/HPL2-EditorSuite-OSX-2015-03-04.dmg Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite.dmg Version 1.2.1 and earlier]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite-manual.dmg Manual Install for version 1.2.1 and earlier]. (Use the Manual Install only if you have issues with the automated installer, and be ''SURE'' to read the directions)

Extract the zip and run the installer (''HPL2 Editor Suite Installer''). The installer should automatically find your currently installed copy of Amnesia no matter where you purchased it (including Steam). After installing the tools, simply run Amnesia and select the "Editor Suite" tab in the launcher to run the tools.

Notes:

*This{{clarify}} currently is not for the Mac [http://www.proleadsoft.com/mobile-app-development/| App Store] release, as updates to Amnesia will completely remove the Editor suite. Please read [http://support.frictionalgames.com/entry/103/ this] for more information.
*'''Update 2011-02-19''' Includes fixes for crashes and "hangs"
*'''Update 2011-03-19''' Includes fixes for a crash that occurs when selecting entities to add to a level
*You must install the [http://support.frictionalgames.com/entry/100/ Amnesia 1.0.1.2 Mac OS X Patch] (this is a Mac-only patch). Steam users will get the update directly from the Steam client.

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder.

== Community tools ==

After the HPL2 games went open-source, the community managed to compile newer editors with a few quality-of-life improvements. They are '''available for Windows and Linux.'''

===Features===
The new features include:
* A much more comfortable color picker
* Dark theme (installed by default, but the original one can be reinstated)
* Keyboard shortcuts for common utilities (e.g. grid snapping)
* Ability to load MFP maps and assets without errors
* Other small improvements

===Installation===
#Install the original editors first (not all files and editors are included in the community version).
#Go to [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page] to download the latest version of the community tools.
#Download the archive in the format of your choice (.7z is smaller than .zip but requires [https://www.7-zip.org/ 7zip] or Winrar to open).
#Extract the contents into the main directory of Amnesia.
#Merge and overwrite all when asked.

HPL2/Tools

2022-06-27T10:10:32Z

Crater: /* Installation Instructions */ added note to try another browser if the download keeps failing.

[[Category:Entry pages]]
{| class="wikitable" style="margin:auto"
! colspan="2" scope="row" |Editors
|-
|'''[[HPL2/Tools/Level Editor|Level Editor]]'''||Everything that you do in the other editors comes to use here.
|-
|'''[[HPL2/Tools/Model Editor|Model Editor]]'''||Makes your 3D models come to life with ingame functions.
|-
|'''[[HPL2/Tools/Particle Editor|Particle Editor]]'''||Create fire, smoke and other particles to spice up levels and models.
|-
|'''[[HPL2/Tools/Material Editor|Material Editor]]'''||Should a texture come with normal, specular or illumination maps? Should the material be transparent or sound like metal?
|-
|[[HPL2/Tools/HplLangTool|'''HPL Language Tool''']]||Helper tool to build,edit, and translate language files
|-
! colspan="2" scope="row" |Viewers
|-
|'''[[HPL2/Tools/Map Viewer|Map Viewer]]'''||Gives extra information about the level and allows viewing without running the game. A useful tool for optimization.
|-
|'''[[HPL2/Tools/Model Viewer|Model Viewer]]'''||See how your model will look ingame without having to start the game or make game specific files. Useful for porting assets.
|}
==Installation Instructions==
Keep in mind that these tools, while having been used to produce actual content and a lot of effort has been put on making them as stable as possible, are a constant work in progress, so bugs and the like may arise anytime. Make sure to back up your work often, and it is highly recommended to use a versioning system (e.g. [https://git-scm.com/ Git]).

Make sure to click the download links before, as copying the link will result in an error. If clicking the link also results in an error, try downloading in another browser.

===Windows===

Download the Windows HPL Editor Suite for Amnesia (click the link, it won't work if you copy it into a tab):

*[https://fricpub.s3.amazonaws.com/tools/hpl2/amnesia_tdd_1.3_editor_suite.zip Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite.zip Version 1.2 and earlier].

This file must be unpacked into the folder where you find Amnesia.exe, all .dll files and folders with game data. This may be one of two locations depending on which version of the game you have.

* '''For Steam users''': This will be your game installation directory, usually <code>C:\Program Files\Steam\steamapps\common\Amnesia - The Dark Descent\</code>
* '''For retail/other users''': This will be inside the "redist" folder inside your installation directory, for example <code>C:\Program Files\Amnesia - The Dark Descent\redist\</code>

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code><Documents>\HPL2\</code> folder.

===Linux===

Download the Linux HPL Editor Suite for Amnesia:

*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2_editor_suite-linux-2015-03-04.zip Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl_editor_suite_linux.zip Version 1.2.1 and earlier]

'''Updated 2011-02-19''' Updated to fix crashes when selecting enemies.

Extract the zip and run the installer (<code>hpl_editor_suite.sh</code>).

The installer should automatically find your currently installed copy of Amnesia if you installed it in one of the common installation locations. If not, simply select the Amnesia folder where you installed the game.

'''Note:''' No menu items are created by the installer, it simply installs the editor data files and executables for your platform.

'''Note:''' The HplLangTool.exe is included in the Linux HPL editor suite, it is a .NET application that does run under wine/mono.

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/.frictionalgames/HPL2</code> folder.

===Mac OS X===

Download the Mac OS X HPL Editor Suite:

*[https://fricpub.s3.amazonaws.com/tools/hpl2/HPL2-EditorSuite-OSX-2015-03-04.dmg Version 1.3 and later]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite.dmg Version 1.2.1 and earlier]
*[https://fricpub.s3.amazonaws.com/tools/hpl2/hpl2editorsuite-manual.dmg Manual Install for version 1.2.1 and earlier]. (Use the Manual Install only if you have issues with the automated installer, and be ''SURE'' to read the directions)

Extract the zip and run the installer (''HPL2 Editor Suite Installer''). The installer should automatically find your currently installed copy of Amnesia no matter where you purchased it (including Steam). After installing the tools, simply run Amnesia and select the "Editor Suite" tab in the launcher to run the tools.

Notes:

*This{{clarify}} currently is not for the Mac [http://www.proleadsoft.com/mobile-app-development/| App Store] release, as updates to Amnesia will completely remove the Editor suite. Please read [http://support.frictionalgames.com/entry/103/ this] for more information.
*'''Update 2011-02-19''' Includes fixes for crashes and "hangs"
*'''Update 2011-03-19''' Includes fixes for a crash that occurs when selecting entities to add to a level
*You must install the [http://support.frictionalgames.com/entry/100/ Amnesia 1.0.1.2 Mac OS X Patch] (this is a Mac-only patch). Steam users will get the update directly from the Steam client.

When reporting crashes and bugs, always include a description of the problem and any log output from the editors themselves. Logs are located in your <code>~/Library/Application Support/Frictional Games/HPL2</code> folder.

== Community tools ==

After the HPL2 games went open-source, the community managed to compile newer editors with a few quality-of-life improvements. They are '''available for Windows and Linux.'''

===Features===
The new features include:
* A much more comfortable color picker
* Dark theme (installed by default, but the original one can be reinstated)
* Keyboard shortcuts for common utilities (e.g. grid snapping)
* Ability to load MFP maps and assets without errors
* Other small improvements

===Installation===
#Install the original editors first (not all files and editors are included in the community version).
#Go to [https://github.com/TiManGames/AmnesiaTheDarkDescent/releases this Github page] to download the latest version of the community tools.
#Download the archive in the format of your choice (.7z is smaller than .zip but requires [https://www.7-zip.org/ 7zip] or Winrar to open).
#Extract the contents into the main directory of Amnesia.
#Merge and overwrite all when asked.

HPL3/Color Grading

2022-03-17T18:57:27Z

Crater:

{{shortPageTitle}}
[[File:Grading.jpg|thumb|Color Grading example]]
Color grading is a way to map the color of a pixel to another color. This can be used to change the brightness, contrast, hue, saturation, … of a whole image. 
It is possible to smoothly fade between two different grading templates. 
It uses a small 3D texture with a color as input and another color as output.

== Creation Guide ==

===Requirements===

* Photoshop (CS5 or later recommended)
* [https://developer.nvidia.com/gameworksdownload#?dn=texture-tools-for-adobe-photoshop-8-55 NVIDIA Texture Tools for Adobe Photoshop v8.55] - Download the correct version for your system (probably 64-bit)

===Setup===

# Take a screenshot of the game with color grading disabled
# Open the screenshot in Photoshop
# Drag and drop the default grading texture on the canvas (found at '''/core/textures/grading_default.dds''')
# Place the color strip anywhere in the image
# Flatten the image to merge all the layers
# Select "'''Image > Mode > 8 Bits/Channel'''" in the top menu
''Note: FG documentation originally listed 16 Bits/Channel, however this seemed to result in incorrect color grading results.''

===Adjustments===

* Use any of the options in "'''Image > Adjustments'''"
* These can be used to change the brightness, saturation, contrast and so on
* Any changes you see on the image in Photoshop will carry over to the game

[[File:adjustments.jpg]]

===Layers===

It is also possible to use the any of the layer blend modes. 
There are two kinds of layers allowed:

* Solid color
* Dupilcate of the first layer

It is possible to duplicate the first layer and make adjustments to it and then blend it. 
The use of Layer Masks is allowed as long as they are generated from the image and not hand painted.

[[File:layers.jpg]]

===Saving===
[[File:crop.jpg|thumb|Example crop]]
# Crop the color strip from the canvas, make sure the resulting image is 256×16 px
# Select "'''Save a Copy...'''" and set the format as "'''D3D/DDS (*.DDS)''''" and save it in the folder "'''/textures/colorgrading/'''"
# In the DDS format settings select "'''8.8.8.8 ARGB 32 bit | unsigned'''", "'''Volume Texture'''", "'''No MIP maps'''"
[[File:DDS Format Fixed.png]]

== Level Usage ==

You can apply your color grading texture either in the [[HPL3/SOMA/Level_Design/Level_Settings#ColorGrading|Level Settings]] or via the level script.
{{constructionNotice|TODO: Link to/explain color grading scripts.|width=25%}}

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-20T21:17:05Z

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

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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
|The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Print Container Debug Info
|This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
|-
|Merge Lang Files
|Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}
|}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.

{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Unlimited Random Map Batch
|Unknown option. {{clarify}}
|}

==Misc==
The misc section include options which don't fit anywhere else.

{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.
|-
|Play Voice Subject
|Allows you to manually play a global or map specific voice subject. Use the selection box below this option to select the voice subject to play.
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch. {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

==Graphics Debug==
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.

{| class="wikitable"
|+
!Option
!Description
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|left|FPS graph.|500x500px]]
|-
|Large Light Test
|Unknown option.
|-
|Previous Frame Occlusion
|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: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.]]
 {{bug|This option seems to be broken.}}
|-
|Render Portal Debug
|Desc {{clarify}}
|-
|Render Only Occluders
|Desc {{clarify}}
|-
|Render GBuffer
|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.
 [[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]
|-
|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.
 [[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.]] {{clr}}
{{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:
[[File:light_complexity_no_shadows.png|alt=|frame|left]] {{clr}} }}
|-
|Overdraw
|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}} '''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.

 [[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]]
 {{bug|This option seems to be broken.}}
|}
[[Category:Modding]]
[[Category:English]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T17:49:21Z

Crater: /* Graphics Debug */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.

{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Unlimited Random Map Batch
|Unknown option. {{clarify}}
|}

==Misc==
The misc section include options which don't fit anywhere else.

{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.
|-
|Play Voice Subject
|Allows you to manually play a global or map specific voice subject. Use the selection box below this option to select the voice subject to play.
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch. {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

==Graphics Debug==
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.

{| class="wikitable"
|+
!Option
!Description
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|left|FPS graph.|500x500px]]
|-
|Large Light Test
|Unknown option.
|-
|Previous Frame Occlusion
|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: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.]]
 {{bug|This option seems to be broken.}}
|-
|Render Portal Debug
|Desc {{clarify}}
|-
|Render Only Occluders
|Desc {{clarify}}
|-
|Render GBuffer
|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.
 [[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]
|-
|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.
 [[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.]] {{clr}}
{{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:
[[File:light_complexity_no_shadows.png|alt=|frame|left]] {{clr}} }}
|-
|Overdraw
|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}} '''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.

 [[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]]
 {{bug|This option seems to be broken.}}
|}
[[Category:Modding]]
[[Category:English]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T17:39:21Z

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

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.

{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Unlimited Random Map Batch
|Unknown option. {{clarify}}
|}

==Misc==
The misc section include options which don't fit anywhere else.

{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.
|-
|Play Voice Subject
|Allows you to manually play a global or map specific voice subject. Use the selection box below this option to select the voice subject to play.
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch. {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

==Graphics Debug==
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.

{| class="wikitable"
|+
!Option
!Description
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|left|FPS graph.|500x500px]]
|-
|Large Light Test
|Unknown option.
|-
|Previous Frame Occlusion
|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: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.]]
 {{bug|This option seems to be broken.}}
|-
|Render Portal Debug
|Desc {{clarify}}
|-
|Render Only Occluders
|Desc {{clarify}}
|-
|Render GBuffer
|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.
 [[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]
|-
|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.
 [[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.]] {{clr}}
{{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:
[[File:light_complexity_no_shadows.png|alt=|frame|left]] {{clr}} }}
|-
|Overdraw
|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}} '''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.

 [[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]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2022-01-17T17:28:31Z

Crater: /* Graphics Debug */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within <code>FearHandler.hps</code>. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Allows you to reduce the area that the debug outputs display in.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|left]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are not in the view of the player).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T17:26:28Z

Crater: /* Misc */ Added section

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.

{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Unlimited Random Map Batch
|Unknown option. {{clarify}}
|}

==Misc==
The misc section include options which don't fit anywhere else.

{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.
|-
|Play Voice Subject
|Allows you to manually play a global or map specific voice subject. Use the selection box below this option to select the voice subject to play.
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch. {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

==Graphics Debug==
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===
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}}

===Large Light Test===
Unknown option.

===Previous Frame Occlusion===
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: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}}

===GBuffer===
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.
[[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]{{clr}}

===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.
[[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.
]] {{Clr}}

{{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}} }}

===Overdraw===
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}} '''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.

[[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]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T17:20:43Z

Crater: /* Stress Test */ Added section

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.

{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Unlimited Random Map Batch
|Unknown option. {{clarify}}
|}

==Misc==
The misc section include options which don't fit anywhere else.
{{stub}}

==Graphics Debug==
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===
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}}

===Large Light Test===
Unknown option.

===Previous Frame Occlusion===
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: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}}

===GBuffer===
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.
[[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]{{clr}}

===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.
[[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.
]] {{Clr}}

{{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}} }}

===Overdraw===
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}} '''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.

[[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]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T17:15:00Z

Crater: /* Input */ Added section

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.

{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|If only input from the gamepad should be allowed to move the player. Useful for playing back an input recording and being allowed to control the spec camera with the mouse and keyboard.
|-
|Record Input
|Starts / Stops input recording and saves to file. {{Bug|It is unknown if this feature works. {{confirm}} }}
|-
|Playback Recorded Input
|Play selected input recording.
|}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.
{{stub}}

==Misc==
The misc section include options which don't fit anywhere else.
{{stub}}

==Graphics Debug==
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===
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}}

===Large Light Test===
Unknown option.

===Previous Frame Occlusion===
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: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}}

===GBuffer===
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.
[[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]{{clr}}

===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.
[[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.
]] {{Clr}}

{{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}} }}

===Overdraw===
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}} '''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.

[[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]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T16:43:44Z

Crater: /* Game */ Added section

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

{{bug|Using F5 (or the debug menu 'Reload Game' option) while using mod content that overrides a base game asset will result in the game reverting to the original unmodified asset until the game is restarted. Reload the map using the 'Load Map' debug menu option to prevent this!}}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.
{{expandBox|[[File:Hpl3-soma-debug-menu.png|alt=|left|902x902px]]}}{{clr}}

==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"
|+
!Option
!Description
|-
|Show FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|Show module info
|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
|Shows the amount of entities in the map and their state.
|-
|Show entity info
|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
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds additional information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound ai event
|Shows a message when an Ai agent has heard a sound.
|-
|Show debug messages
|Shows dev messages which are specified in the map script file.
|-
|Show event/voice messages
|Does not work.
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Draw physics debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay physics debug
|Displays physics debug + normal game meshes.
|-
|Draw Gui debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Show TV Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|-
|Show Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Show Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Show Debug Info Window
|Displays a window with debug information. {{Clarify}}
|-
|Hide Sleeping Entities
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|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}}
|}

===Additional Options===

====Brightness====
The brightness slide increases / decreases the brightness of the game. Not to be confused with gamma.
----
====Print Container Debug Info====
This button prints container debug info to the screen.
{{Bug|The button makes the game crash.}}
----
====Merge Lang Files====
Merges two language files between the main game language file and another.
{{note|This feature doesn't seem to be useful in practice.}}

==Map==
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.

{| class="wikitable"
|+
!Option
!Description
|-
|Auto Reload Resource
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Reload Script At Task Switch
|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.
|-
|Reload Script Constantly
|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.
|-
|Recompile Script and Lang
|Leftover feature from HPL2. The button does not work.
|-
|Reload from current pos
|When reloading a map, the player will retain the current position instead of starting at the beginning of the map.
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|-
|Reload Game
|Reloads the map. This also resets the state of the player and all the other scripts which run in the background.
|-
|Script Debug
|Script Debug enables further scripting features and is 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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>
|-
|Load 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
|Unknown option. {{clarify}}
|-
|Teleport to Start Pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>paused</code> to <code>very high</code>
|}

==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.

{| class="wikitable"
|+
!Option
!Description
|-
|Show HPL Log
|Opens a window showing the current contents of the log file.
|-
|Show Error List
|Shows a window listing the logged errors only.
|-
|Show Debug Messages
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Game Paused (F2)
|Pauses the game.
|-
|Pause at window open/close
|Toggles if opening (or closing) the debug menu should pause/resume the game.
|-
|Fast Forward (F3)
|Makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow Down (F3)
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Spectator Cam (F7)
|Enables / Disables spectator camera mode (noclip).
|-
|Teleport player to camera
|Teleports the player to the spectator camera.
|-
|Teleport camera to player
|Teleports the spectator camera to the player
|-
|CamSpeed
|Sets the spectator camera movement speed.
|-
|Show player collider
|Toggles visibility of the player collider (usually only visible when spectator camera is enabled).
|-
|Always teleport player to camera
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Show Event Messages
|Unknown option {{clarify}}
|-
|Show Event Facts
|Unknown option {{clarify}}
|-
|Disable Flashbacks
|Leftover from HPL2. Does nothing.
|}

==Input==
The Input section of the menu includes tools and option for capturing and analyzing user input.
{{stub}}

==Stress Test==
This is a tool used to test the map under heavy performance conditions.
{{stub}}

==Misc==
The misc section include options which don't fit anywhere else.
{{stub}}

==Graphics Debug==
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===
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}}

===Large Light Test===
Unknown option.

===Previous Frame Occlusion===
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: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}}

===GBuffer===
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.
[[File:G_buffer.png|alt=|thumb|left|500x500px|A scene in a g-buffer mode. Notice the different graphic modes.]]{{clr}}

===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.
[[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.
]] {{Clr}}

{{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}} }}

===Overdraw===
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}} '''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.

[[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]]

HPL3/SOMA/Modding/Developer Debug Menu

2022-01-17T16:26:33Z

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

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T10:23:35Z

Crater: /* Graphics Debug */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within <code>FearHandler.hps</code>. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Allows you to reduce the area that the debug outputs display in.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are not in the view of the player).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T10:10:48Z

Crater: /* Map & Scene */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within <code>FearHandler.hps</code>. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Allows you to reduce the area that the debug outputs display in.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T10:07:32Z

Crater:

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Allows you to reduce the area that the debug outputs display in.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:59:06Z

Crater: /* Debug */ clarified display safe area slider

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Allows you to reduce the area that the debug outputs display in.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:55:24Z

Crater: /* Platform & Language */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 
[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:54:56Z

Crater: /* Platform & Language */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:54:41Z

Crater: /* Platform & Language */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Set custom platform suffix {{Clarify}}
|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:54:04Z

Crater: /* Graphics Debug */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash. {{confirm}} }}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:53:38Z

Crater: /* Graphics Debug */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}} {{confirm}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:52:47Z

Crater: /* Debug UI Settings */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4. {{bug|Setting this value too low or too high can crash the game. Only set it to sane values.}}
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:51:32Z

Crater: /* Debug UI Settings */ Added descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Changes the max number of lines that can be printed to the in game debug log (bottom left messages).
|-
|Pause game when open
|Toggles pausing the game when opening the debug menu (defaults to on)
|-
|Set Fast Forward Mul
|Allows you to change the speed of the Fast Forward option (F3). Defaults to 4.
|}

===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:48:00Z

Crater: /* Profile */ Added descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Enables the CPU Profiler.
|-
|Show GPU Profiler
|Enables the GPU Profiler.
|-
|Pause Profiling
|Pauses profile updates.
|-
|Profile Longest Frame
|Only profile longest frame.
|-
|Profile Filter
|Enter profile layers. Separate with a space. Valid options are: <code>EngineLoop</code> <code>GameLoop</code> <code>RenderAll</code> <code>Variable</code> <code>Message_PostUpdate</code> <code>HPL_Scene_PostUpdate</code> <code>Physics</code>
|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:44:05Z

Crater: /* Stress Test */ Added missing descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Analyzes and prints potential map issues to the HPL log (temp materials, invalid materials, objects placed outside of the clip range, etc).
|-
|Analyze Entities
|Analyzes and prints entity info to the HPL log (instances, triangles, etc).
|-
|Analyze Materials
|Analyzes and prints material info to the HPL log (instances, VRAM usage, etc).
|-
|Analyze Active Entities
|Analyzes and prints active entities to the HPL log.
|-
|Print Resource Usage
|Enter the name of a resource and press button. {{Clarify}}
|-
|Random Input
|Spams random mouse and keyboard inputs. Can result in stuck keys when released.
|-
|Random Physics Forces
|Applies random physic forces to all entities in the map.
|-
|Stress test map batch
|Unknown Option. {{Clarify}}
|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:36:44Z

Crater: /* Input */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|}

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:36:31Z

Crater: /* Input */ added descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Disables mouse and keyboard inputs (can still be used on the debug menu)
|-
|Record Input
|Starts / Stops input recording and saves to file.
|-
|Playback Recorded Input
|Play selected input recording.
|} 

===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:33:57Z

Crater: /* Events */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Unknown Option. {{Clarify}}
|-
|Show Event Facts
|Unknown Option. {{Clarify}}
|-
|Disable Flashbacks
|Unknown if this option works {{confirm}}
|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:29:38Z

Crater: /* Voices */ Added missing descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. {{confirm}}
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Allows you to manually play a voice subject (Seems to list only global voices {{confirm}})
|-
|Reload Voice Data on Taskswitch
|Reloads .voice files on task switch {{confirm}} (see 'Reload Script at Task Switch' for more info)
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:26:47Z

Crater: /* Music */ added descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Allows you to manually play an .ogg music track.
|-
|Stop All Music
|Stops all currently playing music tracks.

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:25:44Z

Crater: /* Resources */ filled in missing descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Allows loading of assets found in _temp folders. This is off by default.
|-
|Find Duplicate File Names
|Prints duplicate files to the debug log.

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:23:31Z

Crater: /* Graphics Debug */ Filled in some missing descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''

State Changes - {{Clarify}}
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc {{Clarify}}
|-
|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}}
|-
|Draw Skeletons
|Enables visibility of entity skeletons.
|-
|Offset Skeletons
|Offsets skeletons a few meters in front of the entity.
|-
|Wireframe Mode
|Enables wireframe rendering.
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
{{bug|This option seems to be broken.}}
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|The gamma slider increases / decreases the gamma. Note the gamma also affects the debug menu itself so be careful not to set it too dark.
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|The contrast slider increases / decreases the contrast of the game. Be careful not to set it too low or the entire game, debug menu included, will be solid grey.
|-
|Disable Textures
|Unknown Option. {{Clarify}}
|-
|Disable Post-Effects
|Disables all post effects. {{Clarify}}
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Toggles shadow visibility. {{bug|Shadows don't always show up after re-enabling this option. If this occurs, toggle "Render Portal Debug" on/off to fix.}}
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:08:43Z

Crater: /* Graphics Debug */ formatting, removed duplicated table

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc
|-
|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}}
|-
|Draw Skeletons
|Desc
|-
|Offset Skeletons
|Desc
|-
|Wireframe Mode
|Desc
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|Desc
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|Desc
|-
|Disable Textures
|Desc
|-
|Disable Post-Effects
|Desc
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Desc
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T09:08:18Z

Crater: /* Debug */ Added many missing descriptions and clarified/fixed some incorrect ones.

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|Shows information about different [[HPL3/Scripting/User Modules Overview|user modules]]. Add custom debug outputs in the modules <code>DrawDebugOutput()</code> function.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|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.
|-
|Light Level Info
|Displays information about lights in the map.
|-
|Messages
|Toggles debug message visibility, including debug messages added with <code>cLux_AddDebugMessage()</code>.
|-
|Notes
|Toggles visibility of notes placed on objects in the map editor.
|-
|Pause on assert
|Unknown option. {{Clarify}}
|-
|Debug Info
|Toggles the Debug Info window. {{Clarify}}
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Enables inspection mode, which displays information about assets used in the map, such as texture files, location on disk, size, etc.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Hides the player crosshair. This includes crosshair and interaction icons.
|-
|Hide hints
|Hides hints from showing up. They'll still trigger but won't be visible.
|-
|Hide popup icons
|Unknown option. {{Clarify}}
|-
|Hide tentacles
|Hides the fear tentacle effect that occurs when you have high fear. Useful for screenshots.
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Toggles visibility of the player collider (only visible when spectator camera is enabled).
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Displays the light grid. {{Clarify}}
|-
|Deep Shadow
|While Light Level Grid is enabled, only display points that are in shadow.
|}

===Graphics Debug===
{| class="wikitable"
|+
|}
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc
|-
|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}}
|-
|Draw Skeletons
|Desc
|-
|Offset Skeletons
|Desc
|-
|Wireframe Mode
|Desc
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|Desc
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|Desc
|-
|Disable Textures
|Desc
|-
|Disable Post-Effects
|Desc
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Desc
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/SOMA/Modding/Developer Debug Menu

2021-09-15T09:06:26Z

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

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T08:51:35Z

Crater: /* Logging */ added ai/debug log descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Opens a window showing AI debug messages (created via script with the <code>cLux_AddAIDebugMessage()</code> function)
|-
|Debug Log
|Opens a window showing the debug log, listing all previous debug messages.
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|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.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|Desc
|-
|Light Level Info
|Desc
|-
|Messages
|Shows dev messages which are specified in the map script file.
|-
|Notes
|Desc
|-
|Pause on assert
|Desc
|-
|Debug Info
|Desc
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Desc
|-
|Hide hints
|Desc
|-
|Hide popup icons
|Desc
|-
|Hide tentacles
|Desc
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Desc
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Desc
|-
|Deep Shadow
|Desc
|}

===Graphics Debug===
{| class="wikitable"
|+
|}
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc
|-
|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}}
|-
|Draw Skeletons
|Desc
|-
|Offset Skeletons
|Desc
|-
|Wireframe Mode
|Desc
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|Desc
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|Desc
|-
|Disable Textures
|Desc
|-
|Disable Post-Effects
|Desc
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Desc
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T08:49:02Z

Crater: /* Game & Script */ Added some missing descriptions

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster (by default). It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Teleports the spectator camera to the player {{bug|The spectator camera will teleport back to its last position unless you toggle it off and back on after teleporting.}}
|-
|Player->Cam
|Teleports the player to the spectator camera.
|-
|Player-SpecCam auto-teleport
|Enabling this will cause the player to always teleport to the spectator camera after toggling the camera off.
|-
|Recompile Script and Lang
|Desc{{Clarify}}
|-
|Merge Lang Files
|Desc{{Clarify}}
|-
|Reload script at task switch
|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.
|-
|Reload script constantly
|The script file for the map will be updated every frame. Meaning any changes made to the script will immediately be loaded in game. Usually you can just use the task switch option instead.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Unknown option. {{Clarify}}
|-
|Fast Physics Load
|Unknown option. {{Clarify}}
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Desc
|-
|Debug Log
|Desc
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|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.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|Desc
|-
|Light Level Info
|Desc
|-
|Messages
|Shows dev messages which are specified in the map script file.
|-
|Notes
|Desc
|-
|Pause on assert
|Desc
|-
|Debug Info
|Desc
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Desc
|-
|Hide hints
|Desc
|-
|Hide popup icons
|Desc
|-
|Hide tentacles
|Desc
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Desc
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Desc
|-
|Deep Shadow
|Desc
|}

===Graphics Debug===
{| class="wikitable"
|+
|}
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc
|-
|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}}
|-
|Draw Skeletons
|Desc
|-
|Offset Skeletons
|Desc
|-
|Wireframe Mode
|Desc
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|Desc
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|Desc
|-
|Disable Textures
|Desc
|-
|Disable Post-Effects
|Desc
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Desc
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]

HPL3/Amnesia: Rebirth/Modding/Developer Debug Menu

2021-09-15T08:42:30Z

Crater: /* Map & Scene */

{{shortPageTitle}}
{{TocRight}}
When developing your mod, it is important to be able to have a fast feedback loop and have extensive set of tools which can help to test our mod. Exactly for that reason, we have the Developer Menu. This article goes in detail over the menu and all of its features.

==Keyboard Shortcuts==
The following keyboard shortcuts are enabled during dev mode:
{| class="wikitable"
|+
!Shortcut Key
!Action
|-
|F1
|Brings up the developer debug menu. This needs to be done in order to have full access to the developer features when running a game in debug mode.
|-
|F2
|Pauses / Resumes the game world processes, basically makes the game freeze. Note that you can still noclip in this state.
|-
|F3
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|F4
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|F5
|Reloads the current map.
|-
|F7
|Enables / Disables spectator camera mode (noclip).
|-
|F8
|Takes a screenshot of the game and saves it inside the main game folder.
|-
|F9
|Quick-saves the game.
|-
|F10
|Quick-loads the last save.
|-
|Insert
|Starts / Stops quick input recording and saves to the file QuickRecord.sav.
|-
|Home
|Starts playing back the last quick input recorded file.
|}

==Debug Menu==
The debug menu is where most of the work happens. There, you can find a list of useful actions which will help you in your mod development.

You will find the actions and option grouped in the following categories:

===CMD Debug===
Commands can be entered after pressing F1. Type the command and press Enter.
{| class="wikitable"
|+
!Command
!Action
|-
|help
|Prints usable commands to the Debug Log
|-
|ailog
|Opens the AI Log
|-
|dlog, debuglog
|Opens the Debug Log
|-
|einfo, entinfo, entityinfo
|Toggles the Entity Info debug option
|-
|fps
|Toggles FPS counter
|-
|fpsg, fpsgraph
|Toggles the FPS Graph
|-
|god
|Toggles God Mode
|-
|hpllog
|Opens the HPL Log
|-
|light, lightlvl, lightlevel
|Toggles the Light Level Info debug option
|-
|minfo, mapinfo
|Toggles the Map Info debug option
|-
|mem, memory
|Toggles the Memory Usage graphics debug option
|-
|mess, messages
|Toggles debug messages
|-
|module, modout, moduleout
|Toggles the Module Output debug option
|-
|notes
|Toggles the Notes debug option
|-
|pdebug, physicsdebug, physics
|Toggles Physics Debug
|-
|poverlay, physicsoverlay
|Toggles the Physics Overlay (if physics debug is enabled)
|-
|coll, pcoll, pcollider, collider
|Toggles visibility of the player collider
|-
|profile, profiler
|Toggles the Profiler
|-
|rinfo, rend, rendering
|Toggles the Rendering Info graphics debug option
|-
|sdebug, scriptdebug, debugscript
|Toggles Script Debug
|-
|hide, show, output, debugoutput, hidedebugoutput
|Toggles the Hide Debug Output debug option
|}

===Game & Script===
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.
{| class="wikitable"
|+
!Option
!Description
|-
|Reload
|Reloads the current map.

If the option 'Reload from current pos' is checked, the player will retain the current position instead of starting at the beginning of the map.
|-
|Pause
|Pauses the game
|-
|Reload
|Reloads the game
|-
|Fast
|This makes the game run 4 times faster. It is good if you want to skip specific sections in the map.
|-
|Slow
|This makes the game run 4 times slower. It is good if you want to want to focus on something that happens very fast in the map.
|-
|Script Debug
|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()
{
if (cScript_ScriptDebugOn()) // Checks if Script Debug option is turned on or not
{
Player_SetFlashlightDisabled(false);
}
}
</syntaxhighlight>

|-
|God Mode
|Makes the player invincible and prevents from getting chased by enemies.
|-
|Spectator Cam
|Enables / Disables spectator camera mode (noclip).
|-
|Slo-mo
|Toggles slow motion camera movement
|-
|Speed
|Sets the spectator camera movement speed
|-
|SM Move
|Sets the spectator camera slo-mo movement speed
|-
|SM Look
|Sets the spectator camera slo-mo turning speed
|-
|Cam->Player
|Desc
|-
|Player->Cam
|Desc
|-
|Player-SpecCam auto-teleport
|Desc
|-
|Recompile Script and Lang
|Desc
|-
|Merge Lang Files
|Desc
|-
|Reload script at task switch
|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.
|-
|Show Garbage Collection
|Shows a graph of garbage collection. {{Clarify}}
|-
|Skip AI Rebuild On Reload
|Desc
|-
|Fast Physics Load
|Desc
|-
|Name
|Desc
|}

===Map & Scene===
The map section of the menu includes settings and actions which are related to maps in general, as well as the currently-loaded map.
{| class="wikitable"
|+
!Option
!Description
|-
|Load 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. Fast Physics Load can be enabled here before loading the map.{{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
|Unknown option. {{clarify}}
|-
|Teleport to start pos
|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.
|-
|Map Batch
|Unknown option. {{clarify}}
|-
|Preload Map
|Loads another map in the background so it can be loaded later much faster. ''Main article: [[HPL3/Scripting/Level_Streaming|Level Streaming]]''
|-
|Start Preloaded Map
|Loads the pre-loaded map. If no map has been pre-loaded, the button will do nothing.
|-
|Preload Map Batch
|Unknown option. {{clarify}}
|-
|Preload Priority
|Sets the priority of the map preload process. Ranges from <code>Paused</code> to <code>Very High</code>
|-
|Preload Time
|Lists the time in seconds it took to load to preload the map.
|-
|Keep Previous Map Loaded
|Keeps the previous map loaded. This is useful if you want to go quickly switch between two maps.
|-
|Export Map to Mesh
|Exports the map geometry to an .obj file. Allows inputting a distance from the camera to export meshes from.
|-
|Trigger Permafail
|This calls the <code>_Global_TriggerPermaFail()</code> function found within FearHandler.hps. Normally used to trigger a permafail (effectively a death) for testing, however the function can be edited to allow for custom functionality.
|}

===Logging===
{| class="wikitable"
|+
!Option
!Description
|-
|HPL Log
|Opens a window showing the current contents of the log file
|-
|Show Error List
|Shows a window listing the logged errors only
|-
|AI Log
|Desc
|-
|Debug Log
|Desc
|-
|Resource Logging
|Logs game resources. {{Clarify}}
|-
|Show non-preloaded resources
|Lists resources which are not preloaded by the game. {{Clarify}}
|}

===Debug===
{| class="wikitable"
|+
!Option
!Description
|-
|Hide Debug Output
|Check to disable debug output being printed to screen.
|-
|Module Output
|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.
|-
|Map Info
|Shows the amount of entities in the map and their state.
|-
|Entity Info
|Desc
|-
|Light Level Info
|Desc
|-
|Messages
|Shows dev messages which are specified in the map script file.
|-
|Notes
|Desc
|-
|Pause on assert
|Desc
|-
|Debug Info
|Desc
|-
|Hide Sleeping
|Makes sleeping entities invisible in the map. {{Todo|Link to source about sleeping entities}}
|-
|Inspection Mode
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|GUI Debug
|Displays pink overlay which represents intractable GUI elements.
|-
|Hide crosshair
|Desc
|-
|Hide hints
|Desc
|-
|Hide popup icons
|Desc
|-
|Hide tentacles
|Desc
|-
|Display Safe Area
|Shows the [[wikipedia:Safe_area_(television)|safe area]] of a TV, surrounded by red borders.
|-
|Player Collider
|Desc
|-
|Physics Debug
|Displays physics bodies (pink) of static objects and entities in the map.
|-
|Overlay
|Displays physics debug + normal game meshes.
|-
|Light Level Grid
|Desc
|-
|Deep Shadow
|Desc
|}

===Graphics Debug===
{| class="wikitable"
|+
|}
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.
{| class="wikitable"
!Option
!Description
|-
|FPS
|Shows the game [[wikipedia:Frame_rate|FPS]].
|-
|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.
 [[File:Hpl3-fps-graph.png|thumb|500x500px|alt=|center]]
|-
|Memory Usage
|Shows information about the game memory usage:

Memory Usage''':''' '''The amount of VRAM used by the renderer. This contains frame buffers, shadows, terrain and post-effects. It is greatly affected by the resolution of the window.'''

Texture Memory Usage''':''' '''The texture memory used by the level. This contains all the textures used for the materials of the objects. Texture memory is reduced by a lot with just a few changes in the config file.'''

Vertex Memory Usage''':''' '''The amount of VRAM used by meshes and decals. The imporant difference between Vertex and Texture memory is that Vertex memory can't be reduced by changing a setting. It takes up as much space on a good and a bad computer.'''

Total Memory Usage''':''' '''The sum of the above memory usage.'''
|-
|Rendering Info
|Shows information about the game rendering:

Draw Calls - '''The number of objects rendered in the current scene.'''

Rendered Triangles / Vertices - '''The total number of triangles and vertices rendered per frame.'''

Queries - '''A special draw call used to check if an object is occluded. It is more expensive than a draw call.'''
|-
|Print Container Debug Info
|This button prints container debug info to the screen.{{Bug|The button makes the game crash.}}
|-
|Render Portal Debug
|Desc
|-
|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}}
|-
|Draw Skeletons
|Desc
|-
|Offset Skeletons
|Desc
|-
|Wireframe Mode
|Desc
|-
|Previous Frame Occlusion
|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:Occlusion_preview.png|alt=|thumb|left|500x500px]]
|-
|Debug Mode
|Offers a set of display modes to help catch rendering issues
|-
|Gamma
|Desc
|-
|Brightness
|The brightness slider increases / decreases the brightness of the game. Not to be confused with gamma.
|-
|Contrast
|Desc
|-
|Disable Textures
|Desc
|-
|Disable Post-Effects
|Desc
|-
|Occlusion Culling
|Enables occlusion culling (Skips rendering polygons that are no in the view of the player ).
|-
|Draw Shadows
|Desc
|}

===Resources===
{| class="wikitable"
|+
!Option
!Description
|-
|Auto reload resources
|This makes the map reload resources (mostly game assets) automatically, should you change or add something to the mod.
|-
|Load files in _temp folders
|Desc
|-
|Find Duplicate File Names
|Desc

|}

===Sound===
{| class="wikitable"
|+
!Option
!Description
|-
|Show sounds playing
|Shows a list of all the sounds that currently play in the map, and information about them.
|-
|Show sound params
|Adds further information to the sounds playing list (distance from player)
|-
|Show sound categories
|Shows a list of all the different sound level categories.
|-
|Show sound AI events
|Shows a message when an Ai agent has heard a sound.

|}

===Music===
{| class="wikitable"
|+
!Option
!Description
|-
|Play Music
|Desc
|-
|Stop All Music
|Desc

|}

===Voices===
{| class="wikitable"
|+
!Option
!Description
|-
|Show event/voice messages
|Does not work. (VERIFY)
|-
|Show Missing Voice Error
|Lists voice subjects which have missing voice files.
|-
|Play Voice Subject
|Desc
|-
|Reload Voice Data on Taskswitch
|Desc
|}

===Events===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Event Messages
|Desc
|-
|Show Event Facts
|Desc
|-
|Disable Flashbacks
|Desc
|-
|Name
|Desc

|}

===Input===
The Input section of the menu includes tools and option for capturing and analyzing user input.
{| class="wikitable"
|+
!Option
!Description
|-
|Gamepad Input Only
|Desc
|-
|Record Input
|Desc
|-
|Playback Recorded Input
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Stress Test===
This is a tool used to test the map under heavy performance conditions.
{| class="wikitable"
|+
!Option
!Description
|-
|Analyze Map
|Desc
|-
|Analyze Entities
|Desc
|-
|Analyze Materials
|Desc
|-
|Analyze Active Entities
|Desc
|-
|Print Resource Usage
|Desc
|-
|Random Input
|Desc
|-
|Random Physics Forces
|Desc
|-

|}

===Profile===
{| class="wikitable"
|+
!Option
!Description
|-
|Show Profiler
|Desc
|-
|Show GPU Profiler
|Desc
|-
|Pause Profiling
|Desc
|-
|Profile Longest Frame
|Desc
|-
|Label
|Desc
|-

|}

===Debug UI Settings===
{| class="wikitable"
|+
!Option
!Description
|-
|Debug Lines
|Desc
|-
|Pause game when open
|Desc
|-
|Name
|Desc
|-
|Name
|Desc

|} 
===Platform & Language===
{| class="wikitable"
|+
!Option
!Description
|-
|Set Suffix
|Desc
|-
|Name
|Desc

|}

 

[[Category:Modding]]
[[Category:English]]