Frictional Wiki - User contributions [en]

HPL1/Content Creation

2023-04-17T19:15:19Z

Iamrealife:

=HPL-Engine© Content Creation=

==Table of Contents==

==1. Introduction==

===1.1 Some forewords===
Welcome dear content creator to the HPL-Engine.

In some parts of the doc naming conventions are described. This are described something like this: '''_thing_[name]_[stuff]'''

This means that “[name]” and “[stuff]” are variables and are to be replaced with other text. The above example could be translated to: '''_thing_thomas_lighter'''

Or something else depending on what the variables should describe.
 
===1.2 Setup===
Below are just some general rules and settings.

'''Units:''' The game will use SI-units for measurements. This means that 1 length unit equals 1 meter, 1 time unit equals 1 second, 1 mass unit equals 1 kg and so on.

'''National Settings''' All the tools for the engine uses a dot “.” as a decimal separator. If you are Swedish or something this might not be how your computer is set up. Open the ''control panel->national settings'' and check so that this is correct! Also don’t forget to write decimals with dot and '''not comma.'''

{| class="wikitable sortable" border="1"
|Good:||1.00||1.23||234.3
|-
|Bad:||1,00||1,23||234,3
|-
|}
 

===1.3 Exporter used===
Collada is used to export models and maps. The exporter can be used for most major 3d packages, however HPL cannot load all of the files created from the different exporters. Currently Maya is the most supported package.

More information is found at: http://collada.org/public_forum/ Maya specific information is found at: http://colladamaya.sourceforge.net/ 
Exporters known to work properly with current HPL release can be found in [[HPL1/Getting started]]. 

==2. Creating Models==
[[HPL1/Content Creation Chapter 2|2. Creating Models]]

==3. Creating maps==
[[HPL1/Content Creation Chapter 3|3. Creating maps]]

==4. Creating Materials==
[[HPL1/Content Creation Chapter 4|4. Creating Materials]]

==5. HPL Helper==
[[HPL1/Content Creation Chapter 5|5. HPL Helper]]

==6. Entity files==
[[HPL1/Content Creation Chapter 6|6. Entity files]]

==7. Configuration files==
[[HPL1/Content Creation Chapter 7|7. Configuration files]]

==8. Naming and structure==
[[HPL1/Content Creation Chapter 8|8. Naming and structure]]

==9. Heads-Up Display files==
[[HPL1/Content Creation Chapter 9|9. HUD files]]

==10. Graphical User Interface files==
[[HPL1/Content Creation Chapter 10|10. GUI files]]

HPL1/Content Creation Chapter 10

2023-04-17T19:07:17Z

Iamrealife: /* 10.1 Intro */

{{constructionNotice|This page is undergoing major editing, as information is still being gathered and researched. More pages and information will gradually be added.}}

== 10 Graphical User Interface files ==

=== 10.1 Intro ===
'''NOTE:''' Before you begin, make sure you've familiarized yourself with the Extensible Markup Language (XML) before beginning to edit these files. Currently you may only change and replace existing GUI files as they are referenced elsewhere in order for the game to be able to initialize and use them.

Graphical User Interface files are ordinary XML files albeit slightly more advanced than your usual Entity (*.ent) or Heads-Up Display (*.hud) file, GUI files are mostly used to display interfaces on the screen when the player interacts with a certain object (such as a computer or bombs). The most common use however is for the Computer Terminals found throughout Black Plague.

Overture cannot load nor display Graphical User Interface files.

Prior to editing Graphical User Interface (*.gui) files make sure that the language is set to XML in Notepad++.

The following values are used, note that all types have "" around the value:
{| class="wikitable sortable" border=1
| '''String''' || A string of letters. "MyName" or "My_Name"
|-
| '''Integer''' || A number without decimals "-15"
|-
| '''Vector2''' || Two numbers in a row separated by space: "1 1".
|-
| '''Vector3''' || Three numbers in a row separated by space: "1 1 1".
|-
| '''Vector4''' || Four numbers in a row separated by space: "1 1 1 1".
|-
| '''Boolean''' || A data type using "true" or "false" values.
|-
|}

=== 10.2 Script Functions ===
Here are all the valid Scripting Functions available for associating your Graphical User Interface files with. Most of the functions are defined here, think of GUI files as a setting file.

Use these as a reference and look at existing AngelScript files used by the various GUI files.

<syntaxhighlight lang="C++">
void ClickMyFunction(string asName, string asMessage, int alVal)
</syntaxhighlight>
This is the standard syntax used to define various windows and playing back sound.

<syntaxhighlight lang="C++">
void CloseScreenGui();
</syntaxhighlight>
This will kick the player out of the terminal.

<syntaxhighlight lang="C++">
void SetWidgetBool(string asName, string asString, bool abActive);
</syntaxhighlight>
Displays or hides a window.
 
asName name of the window 
asString what string value to change (enabled or visible) 
abActive whether to change the value to true or false 

<syntaxhighlight lang="C++">
void SetAttentionWidget(string asName);
</syntaxhighlight>
Makes the current window active. (Think folder directories or an error message)

<syntaxhighlight lang="C++">
CreateGuiPopUpTrans("string asCat1","string asEntry1",
"string asCat2","string asEntry2",
"string asCat3","string asEntry3",
"","",
"string asFunction");
</syntaxhighlight>
Display a simple text window. 
asCat1 Text Category for the toolbar text 
asEntry1 Text Entry for the toolbar text 
asCat2 Text Category for the window text 
asEntry2 Text Entry for the window text 
asCat3 Text Category for the window button 
asEntry3 Text Entry for the window button 
asFunction Must be a valid int xButton function name 

<syntaxhighlight lang="C++">
void MyFunction(int xButton)
</syntaxhighlight>
Defines what sound should be played when pressing a button in the interface.

Valid syntax: "PlayGuiSound(string asName, float afVol)"

<syntaxhighlight lang="C++">
void CreateGuiTextView( "string asCat1", "string asEntry1",
"string asCat2", "string asEntry2","string, asFunction");
</syntaxhighlight>
Creates a text window.

asCat1 Text Category for the toolbar 
asEntry1 Text Entry for the toolbar 
asCat2 Text Category for the actual text 
asEntry2 Text Name for the actual text 
asFunction Must be a valid int xButton function name

<syntaxhighlight lang="C++">
void ViewImage("string asName", "string asCat", "string asEntry");
</syntaxhighlight>
Creates an image window.

asName Name of the image to display. Must match name in the GUI images tag. 
asCat Category for the image window name 
asEntry Entry for the image window name

<syntaxhighlight lang="C++">
void SetWidgetCallback("string asName", "string asButton", "string asFunction");
</syntaxhighlight>
Add a callback that is called when the player interacts with the interface

asName Name of the Widget in the GUI file 
asButton Type of interaction (ButtonPressed, MouseDoubleClick)
=== 10.3 Graphical User Interface reference file ===
Below is a sample that will help you define a GUI file, this file has some of the more basic stuff to creating a computer terminal interface, you can add more advanced stuff as you go through the various existing ones and this documentation.

Due to the nature and structuring of GUI files it is recommended that you only use this as a reference when editing existing GUI files rather than making your own as it can become quite cumbersome.

"ScriptName" Implies what you'd call the function in order to be referenced with the accompanying script file. (I.E VacationPic) 
"FontsTag" Must match the name used in the Fonts tag. (I.E FileTextWhite) 
"ImageTag" Must match the name used in the Images tag. (I.E DeskTop.jpg or Folder.bmp) 
<syntaxhighlight lang="XML">
<GUI>
<Main SkinFile="String, name of skin (*.skin) file" ScriptFile="String, name of accompanying script (*.hps) file" IsFullScreen="Boolean" />

<Images>
<Image Name="String, ImageTag" File="String, name of a valid bitmap (*.bmp) file" Offset="0 0" ActiveSize="-1 -1" Color="Vector4, Red, Green, Blue, Alpha values" />

<Texture Name="String, ScriptName" File="String, name of image (*.jpg) file" Offset="0 0" ActiveSize="-1 -1" Color="Vector4, Red, Green, Blue, Alpha values"/>
</Images>

<Fonts>





</Fonts>

<Widgets>
<Image Position="Vector3, position of image" Image="String, ImageTag" Size="Vector2, size of image" >

<Button Name="CloseTerminal" Position="775 5 1" Size="20 20" Text="X"/>



<Image Name="String, ScriptName" Position="Vector3, icon position" Image="String, ImageTag" Size="Vector2, size of the icon">
<Label Name = "String, ScriptName" Position="Vector3, position of label text" TextCat="String, TextCategory" TextEntry="String, TextEntry" Font="String, must match font name in fonts tag" TextAlign="String, valid alignments are Left, Right and Center" WordWrap="Boolean" Size="Vector2, size of text, in width and height, default"/>
</Image>



<Window Name="String, ScriptName" Position="Vector3, icon position" Size="Vector2, size of the icon" TextCat="String, TextCategory" TextEntry="String, TextEntry" Visible="Boolean, whether or not the frame should be drawn" Enabled="Boolean, whether or not the window should be enabled">
<Frame Position="Vector3, position of folder window" Size="Vector2, size of folder window" BackgroundColor="Vector4, Red, Gree, Blue, Alpha values" DrawBackground="Boolean, doesn't do anything" DrawFrame="Boolean, does nothing" >
<Image Name="String, ScriptName" Position="Vector3, position of icon" Image="String, ImageTag" Size="Vector2, size of icon">
<Label Name = "String, ScriptName" Position="Vector3, position of text" TextCat="String, TextCategory" TextEntry="String, TextEntry" Font="String, FontsTag" TextAlign="String, valid alignments are Left, Right and Center" WordWrap="Boolean, if the words should wrap around the edges or continue off-screen" Size="Vector2, size of text, in width and height"/>
</Image>
</Frame>

<Button Name="String, ScriptName" Position="Vector3, button position" Size="Vector2, size of button in width and height" TextCat="String, TextCategory" TextEntry="String, TextEntry" />
</Window>



<Window Name="String, ScriptName" Position="Vector3, window position" Size="String, size of window" TextCat="String, TextCategory" TextEntry="String, TextEntry" Visible="Boolean, whether or not the frame should be drawn" Enabled="Boolean, whether or not the window should be enabled">
<Frame Position="Vector3, position of image viewer window" Size="Vector2, size of image viewer window" DrawBackground="Boolean, doesn't do anything" DrawFrame="Boolean, does nothing" >
<Image Name="String, ScriptName" Position="Vector3, position of image" Image="String, ImageTag" Size="Vector2, size of image, in width and height" />
</Frame>

<Button Name="CloseImageWindow" Position="160 340 1" Size="100 30" TextCat="GUI" TextEntry="Close Window" />
</Window>
</Image>
</Widgets>
</GUI>
</syntaxhighlight>

HPL1/Content Creation Chapter 10

2023-04-17T18:55:38Z

Iamrealife: Created page with "{{constructionNotice|This page is undergoing major editing, as information is still being gathered and researched. More pages and information will gradually be added.}} == 10..."

{{constructionNotice|This page is undergoing major editing, as information is still being gathered and researched. More pages and information will gradually be added.}}

== 10 Graphical User Interface files ==

=== 10.1 Intro ===
'''NOTE:''' Before you begin, make sure you've familiarized yourself with the Extensible Markup Language (XML) before beginning to edit these files. Currently you may only change and replace existing GUI files as they are referenced elsewhere in order for the game to be able to initialize and use them.

Graphical User Interface files are ordinary XML files albeit slightly more advanced than your usual Entity (*.ent) or Heads-Up Display (*.hud) file, GUI files are mostly used to display interfaces on the screen when the player interacts with a certain object (such as a computer or bombs). The most common use however is for the Computer Terminals found throughout Black Plague.

Overture cannot load nor display Graphical User Interface files.

Prior to editing Graphical User Interface (*.gui) files make sure that the language is set to XML in Notepad++.

The following values are used, note that all types have "" around the value:
{| class="wikitable sortable" border=1
| '''String''' || A string of letters. "MyName" or "My_Name"
|-
| '''Float''' || A decimal number. "1.04" or "1.04f"
|-
| '''Integer''' || A number without decimals "-15"
|-
| '''Vector3''' || Three numbers in a row separated by space: "1 1 1".
|-
| '''Boolean''' || A data type using "true" or "false" values.
|-
|}

=== 10.2 Script Functions ===
Here are all the valid Scripting Functions available for associating your Graphical User Interface files with. Most of the functions are defined here, think of GUI files as a setting file.

Use these as a reference and look at existing AngelScript files used by the various GUI files.

<syntaxhighlight lang="C++">
void ClickMyFunction(string asName, string asMessage, int alVal)
</syntaxhighlight>
This is the standard syntax used to define various windows and playing back sound.

<syntaxhighlight lang="C++">
void CloseScreenGui();
</syntaxhighlight>
This will kick the player out of the terminal.

<syntaxhighlight lang="C++">
void SetWidgetBool(string asName, string asString, bool abActive);
</syntaxhighlight>
Displays or hides a window.
 
asName name of the window 
asString what string value to change (enabled or visible) 
abActive whether to change the value to true or false 

<syntaxhighlight lang="C++">
void SetAttentionWidget(string asName);
</syntaxhighlight>
Makes the current window active. (Think folder directories or an error message)

<syntaxhighlight lang="C++">
CreateGuiPopUpTrans("string asCat1","string asEntry1",
"string asCat2","string asEntry2",
"string asCat3","string asEntry3",
"","",
"string asFunction");
</syntaxhighlight>
Display a simple text window. 
asCat1 Text Category for the toolbar text 
asEntry1 Text Entry for the toolbar text 
asCat2 Text Category for the window text 
asEntry2 Text Entry for the window text 
asCat3 Text Category for the window button 
asEntry3 Text Entry for the window button 
asFunction Must be a valid int xButton function name 

<syntaxhighlight lang="C++">
void MyFunction(int xButton)
</syntaxhighlight>
Defines what sound should be played when pressing a button in the interface.

Valid syntax: "PlayGuiSound(string asName, float afVol)"

<syntaxhighlight lang="C++">
void CreateGuiTextView( "string asCat1", "string asEntry1",
"string asCat2", "string asEntry2","string, asFunction");
</syntaxhighlight>
Creates a text window.

asCat1 Text Category for the toolbar 
asEntry1 Text Entry for the toolbar 
asCat2 Text Category for the actual text 
asEntry2 Text Name for the actual text 
asFunction Must be a valid int xButton function name

<syntaxhighlight lang="C++">
void ViewImage("string asName", "string asCat", "string asEntry");
</syntaxhighlight>
Creates an image window.

asName Name of the image to display. Must match name in the GUI images tag. 
asCat Category for the image window name 
asEntry Entry for the image window name

<syntaxhighlight lang="C++">
void SetWidgetCallback("string asName", "string asButton", "string asFunction");
</syntaxhighlight>
Add a callback that is called when the player interacts with the interface

asName Name of the Widget in the GUI file 
asButton Type of interaction (ButtonPressed, MouseDoubleClick)
=== 10.3 Graphical User Interface reference file ===
Below is a sample that will help you define a GUI file, this file has some of the more basic stuff to creating a computer terminal interface, you can add more advanced stuff as you go through the various existing ones and this documentation.

Due to the nature and structuring of GUI files it is recommended that you only use this as a reference when editing existing GUI files rather than making your own as it can become quite cumbersome.

"ScriptName" Implies what you'd call the function in order to be referenced with the accompanying script file. (I.E VacationPic) 
"FontsTag" Must match the name used in the Fonts tag. (I.E FileTextWhite) 
"ImageTag" Must match the name used in the Images tag. (I.E DeskTop.jpg or Folder.bmp) 
<syntaxhighlight lang="XML">
<GUI>
<Main SkinFile="String, name of skin (*.skin) file" ScriptFile="String, name of accompanying script (*.hps) file" IsFullScreen="Boolean" />

<Images>
<Image Name="String, ImageTag" File="String, name of a valid bitmap (*.bmp) file" Offset="0 0" ActiveSize="-1 -1" Color="Vector4, Red, Green, Blue, Alpha values" />

<Texture Name="String, ScriptName" File="String, name of image (*.jpg) file" Offset="0 0" ActiveSize="-1 -1" Color="Vector4, Red, Green, Blue, Alpha values"/>
</Images>

<Fonts>





</Fonts>

<Widgets>
<Image Position="Vector3, position of image" Image="String, ImageTag" Size="Vector2, size of image" >

<Button Name="CloseTerminal" Position="775 5 1" Size="20 20" Text="X"/>



<Image Name="String, ScriptName" Position="Vector3, icon position" Image="String, ImageTag" Size="Vector2, size of the icon">
<Label Name = "String, ScriptName" Position="Vector3, position of label text" TextCat="String, TextCategory" TextEntry="String, TextEntry" Font="String, must match font name in fonts tag" TextAlign="String, valid alignments are Left, Right and Center" WordWrap="Boolean" Size="Vector2, size of text, in width and height, default"/>
</Image>



<Window Name="String, ScriptName" Position="Vector3, icon position" Size="Vector2, size of the icon" TextCat="String, TextCategory" TextEntry="String, TextEntry" Visible="Boolean, whether or not the frame should be drawn" Enabled="Boolean, whether or not the window should be enabled">
<Frame Position="Vector3, position of folder window" Size="Vector2, size of folder window" BackgroundColor="Vector4, Red, Gree, Blue, Alpha values" DrawBackground="Boolean, doesn't do anything" DrawFrame="Boolean, does nothing" >
<Image Name="String, ScriptName" Position="Vector3, position of icon" Image="String, ImageTag" Size="Vector2, size of icon">
<Label Name = "String, ScriptName" Position="Vector3, position of text" TextCat="String, TextCategory" TextEntry="String, TextEntry" Font="String, FontsTag" TextAlign="String, valid alignments are Left, Right and Center" WordWrap="Boolean, if the words should wrap around the edges or continue off-screen" Size="Vector2, size of text, in width and height"/>
</Image>
</Frame>

<Button Name="String, ScriptName" Position="Vector3, button position" Size="Vector2, size of button in width and height" TextCat="String, TextCategory" TextEntry="String, TextEntry" />
</Window>



<Window Name="String, ScriptName" Position="Vector3, window position" Size="String, size of window" TextCat="String, TextCategory" TextEntry="String, TextEntry" Visible="Boolean, whether or not the frame should be drawn" Enabled="Boolean, whether or not the window should be enabled">
<Frame Position="Vector3, position of image viewer window" Size="Vector2, size of image viewer window" DrawBackground="Boolean, doesn't do anything" DrawFrame="Boolean, does nothing" >
<Image Name="String, ScriptName" Position="Vector3, position of image" Image="String, ImageTag" Size="Vector2, size of image, in width and height" />
</Frame>

<Button Name="CloseImageWindow" Position="160 340 1" Size="100 30" TextCat="GUI" TextEntry="Close Window" />
</Window>
</Image>
</Widgets>
</GUI>
</syntaxhighlight>

HPL1/Glossary

2023-04-17T16:38:43Z

Iamrealife: /* File extensions */

This page explains words and terms which have a unique meaning to the engine.
==General==
{| class="wikitable"
|'''Static'''
|An in-game object which is used only for physics collissions. They can't be influenced by scripts nor be interacted with.
|-
|'''Entity'''
|An in-game object with configurable parameters and custom physics bodies.
|-
|'''Reference'''
|An item referencing a valid Entity file to be used within the game's engine. All entities in your 3D editor must begin with ''_ref_''
|-
|'''Item'''
|A type of entity which can be collected and added to the player's inventory.
|-
|'''Area'''
|Invisible in-game cuboid which marks 3D space. Used for a variety of things based on the type.
|-
|'''Script'''
|Written code which determines what happens in a map. This includes events, puzzles, music, and more.
|-
|'''Stick'''
|Areas that act as glue towards entities in the game world. The entities will stay in place until interacted with again.
|-
|'''Link'''
|Start Locator for the player. This can also be a link between two Starting Positions in a single map.
|-
|'''Node'''
|Navigation points for character entities.
|-
|'''Portal'''
|Special type of handler for what room (or sector) is currently being rendered in-game. A way to optimize ones map better.
|}

==File extensions==
{| class="wikitable"
|'''*.hps'''
|[[HPL1/Script_Reference|Howard Phillip Script]], this is where you make the magic happen with the help of AngelScript.
|-
|'''*.ent'''
|[[HPL1/Content_Creation_Chapter_6|Entity]], objects that can be interacted with, these files can only be created manually.
|-
|'''*.hud'''
|[[HPL1/Content_Creation_Chapter_9|Heads-Up Display]], defines items that the player can wield and holster, these files can only be created manually.
|-
|'''*.ps'''
|[[HPL1/Editors/Particle_Editor|Particle System]], displays cool little effects like fog and electrical sparking etc.
|-
|'''*.bnt'''
|[[HPL1/Content_Creation_Chapter_3#3.12_Billboards|Billboard Entity]], gives your map a little more life with some lightrays and whatnot, these files can only be created manually.
|-
|'''*.snt'''
|[[HPL1/Content_Creation_Chapter_5#5.7_Sound|Sound Entity]], stores information on what audio file to play, how many audio files to play and whether or not they loop and so forth.
|-
|'''*.lang'''
|[[HPL1/Content_Creation_Chapter_5#5.8_Translation|Language]], contains in-game messages, item descriptions, etc.
|-
|'''*.beam'''
|[[HPL1/Content_Creation_Chapter_3#3.13_Beams|Beam]], defines things such as laser beams, these files can only be created manually.
|-
|'''*.cfg'''
|[[HPL1/Content_Creation_Chapter_7|Configuration]], used to define various settings.
|-
|'''*.mat'''
|[[HPL1/Content_Creation_Chapter_4|Material]], contains information on texture as well as the type used for it including transparency information.
|-
|'''*.lnt'''
|[[HPL1/Content_Creation_Chapter_3#3.3.4_Light_Entity_file|Light Entity]], an XML file that displys an image file to be casted by a spotlight in the game world, these files can only be created manually.
|-
|'''*.gui'''
|[[HPL1/Content_Creation_Chapter_10|Graphical User Interface]], XML file that contains information on the various interfaces used throughout Black Plague, these files can only be created manually.
|}

HPL1/Script Reference

2023-04-08T12:38:38Z

Iamrealife:

= Script Reference document =

In this document you will find all the various scripting functions used in the Penumbra trilogy, it's good to have a basic understanding of how Angelscript works before attempting to do anything. Unlike HPL2, the HPL1 engine will crash if too many errors are present. In some cases instead of crashing the game just won't run the accompanying map's script file until the errors have been cleared up. It's also a good idea to locate a Howard Phillip Script (*.hps) file to see how it is used in the Penumbra games to get a better understanding of its functions if you get stuck here. 
== Engine scripts ==

=== General ===

<syntaxhighlight lang="c++">
void Print(string asText)
</syntaxhighlight>

Prints a string to the log. <syntaxhighlight lang="c++">
string FloatToString(float afX)
</syntaxhighlight>

Converts a float to string <syntaxhighlight lang="c++">
string IntToString(int alX)
</syntaxhighlight>

Converts an integer to string, <syntaxhighlight lang="c++">
float RandFloat(float afMin, float afMax)
</syntaxhighlight>

Generates a random float. <syntaxhighlight lang="c++">
int RandInt(int alMin, int alMax)
</syntaxhighlight>

Generates a random int. <syntaxhighlight lang="c++">
StringContains(string asString, string asSubString)
</syntaxhighlight>

Checks what a string contains. asString what string to check asSubString what to check the string against 
=== Resources ===

<syntaxhighlight lang="c++">
string Translate(string asCat, string asName)
</syntaxhighlight>

Gets a string in the current language. asCat The translation category asName The name of the category entry. <syntaxhighlight lang="c++">
void PreloadSound(string asFile)
</syntaxhighlight>

Preloads the data for a sound. asFile This can be a wav, ogg, mp3 or snt file. <syntaxhighlight lang="c++">
void ResetLogicTimer()
</syntaxhighlight>

Resync screen frames to logic timer. 
=== Particle Systems ===

<syntaxhighlight lang="c++">
void SetParticleSystemActive(string asName, bool abActive)
</syntaxhighlight>

Set if a particle system should be active or not. asName The name of the particle system. abActive If it should be active or not. <syntaxhighlight lang="c++">
void CreateParticleSystem(string asName, string asType, string asArea, float afX, float afY, float afZ)
</syntaxhighlight>

Create a particle system at the position of an area asName The name of the particle system. asType The type of aprticle system asArea The name of the area X Y and Z the variables of the particle system. <syntaxhighlight lang="c++">
CreateParticleSystemOnCamera(string asName ,string asFile)
</syntaxhighlight>

Create an particle on the position of the camera(player). asName the name of the particle system ingame. asFile the name of the file for the particle system. <syntaxhighlight lang="c++">
void KillParticleSystem(string asName)
</syntaxhighlight>

Kill a particle system asName The name of the particle system. 
=== Beams ===

<syntaxhighlight lang="c++">
void CreateBeam(string asName, string asFile, string asStartArea, string asEndArea)
</syntaxhighlight>

Creates a beam between 2 areas asName the name of the beam asFile the name of the .beam file asStartArea name of the area to start the beam asEndArea name of the area to end the beam <syntaxhighlight lang="c++">
void DestroyBeam(string asName)
</syntaxhighlight>

Destroy a beam asName name of the beam to destory 
=== Lights ===

<syntaxhighlight lang="c++">
void FadeLight3D(string asName, float afR,float afG, float afB, float afA, float afRadius, float afTime)
</syntaxhighlight>

Fades a sound to a color and a radius asName The name of the light afR The red channel to fade to. afG The green channel to fade to. afB The blue channel to fade to. afA The alpha channel to fade to. afRadius The radius to fade to. afTime The amount of seconds the fade should last. <syntaxhighlight lang="c++">
void AttachBillboardToLight3D(string asBillboardName, string asLightName,bool abX)
</syntaxhighlight>

Attaches a billboard to a light asBillboardName The billbaord name asLightName The light name abX True if it should be attached, false if you want to remove. <syntaxhighlight lang="c++">
void SetLight3DVisible(string asName, bool abX)
</syntaxhighlight>

Sets on/off a light asName The light name abX if the light should be on or off. <syntaxhighlight lang="c++">
void SetLight3DFlickerActive(string asName, bool abX)
</syntaxhighlight>

Sets flickering on/off a light asName The light name abX if the light flicker should be on or off. <syntaxhighlight lang="c++">
void SetLight3DFlicker(string asName,
float afR,float afG, float afB, float afA,
float afRadius,
float afOnMinLength, float afOnMaxLength,
string asOnSound,string asOnPS,
float afOffMinLength, float afOffMaxLength,
string asOffSound,string asOffPS,
bool abFade,
float afOnFadeLength, float afOffFadeLength)
</syntaxhighlight>

Sets flickering parameters asName The light name abR, afG, afB, afA The color of the light when off afRadius The radius of the light when off. afOnMinLength Minimum time before going from off to on. afOnMaxLength Maximum time before going from off to on. asOnSound Name of the sound played when going from off to on. “” means no sound. asOnPS Name of the particle system played when going from off to on. “” means none. afOffMinLength Minimum time before going from on to off. afOffMaxLength Maximum time before going from on to off. asOffSound Name of the sound played when going from on to off. “” means no sound. asOffPS Name of the particle system played when going from on to off. “” means none. abFade If there should be a fade between off and on. afOnFadeLength Fade length from off to on. afOffFadeLength Fade length from on to off. <syntaxhighlight lang="c++">
void CreateLightFlashAtArea(string asArea, float afRadius,
float afR,float afG, float afB, float afA,
float afAddTime, float afNegTime);
</syntaxhighlight>

Creates a flash of light at an area. asArea Name of the area to create the flash in afRadius Radius of the flash afR, afG, afB, afA Red, Green, Blue and alpha of the flash.. afAddTime Time it will take to reach full strenght. afNegTime Time it will take to end flash, turning black. <syntaxhighlight lang="c++">
void SetLight3DOnlyAffectInSector(string asName, bool abX);
</syntaxhighlight>

If a light should cast its light and shadow, affecting the surroundings in its sector(_room grouping) or in all sectors it reaches. By default static lights added in the editor to a level is true, the same goes for lights that are part of an Lamp entity. asName The light name abX if it should only affect the sector or not. 
=== Audio ===

<syntaxhighlight lang="c++">
void CreateSoundEntity(string asName, string asFile, string asArea)
</syntaxhighlight>

Creates a sound entity at the postion of an area. asName Name of the created sound entity. asFile The snt file to load. asArea The area to create at. <syntaxhighlight lang="c++">
void CreateSoundEntityAt(string asType,string asDestName,string asSoundName,string asSoundFile);
</syntaxhighlight>

Creates a sound entity at the position of an entity. asType The type of entity. This can be: “Joint”,“Body” or “Entity”. asDestName The entity/body/joint name asSoundName The name of created sound entity. asSoundFile The name of the snt file. <syntaxhighlight lang="c++">
void PlaySoundEntity(string asName, bool abPlayStart)
</syntaxhighlight>

Play a sound entity asName The entity name abPlayStart If the start sound should be played. <syntaxhighlight lang="c++">
void StopSoundEntity(string asName, bool abPlayEnd)
</syntaxhighlight>

Stop a sound entity asName The entity name abPlayEnd If the end sound should be played. <syntaxhighlight lang="c++">
void FadeInSoundEntity(string asName, float afSpeed)
</syntaxhighlight>

Play a sound entity fading it asName The entity name afSpeed Volume increase per second. <syntaxhighlight lang="c++">
void FadeOutSoundEntity(string asName, float afSpeed)
</syntaxhighlight>

Stop a sound entity fading it asName The entity name afSpeed Volume decrease per second. <syntaxhighlight lang="c++">
void PlayMusic(string asName, float afVol, float afStepSize, bool abLoop)
</syntaxhighlight>

Play music track. asName Name of the music file. afVol Volume of the music afStepSize The increase in volume per second when fading in. <syntaxhighlight lang="c++">
void StopMusic(float afStepSize)
</syntaxhighlight>

Stop music track. afStepSize The decrease in volume per second when fading out. <syntaxhighlight lang="c++">
PlayGameMusic(string asFile, float afVolume,float afFadeStep,bool abLoop, int alPrio);
</syntaxhighlight>

Play music track with prio, added to episode 1 to be able to play different tracks that mix in and out depending on prio. asFile The name of the music file. afVolume The volume to play the music at 0 to 1. afFadeStep The decrease in volume per second when fading out. abLoop If the music should loop. alPrio The priority of the track, 0 to 10. A higher numbers fades a lower number out, if you have an ambient music track using prio 0 it will fade out if you add a music track to an enemy entity with prio 1 and the enemy attacks the player. When the attack is over the ambient track will fade back in. <syntaxhighlight lang="c++">
StopGameMusic(float afFadeStep, int alPrio);
</syntaxhighlight>

Stop game music track with prio. afFadeStepThe decrease in volume per second when fading out. alPrio priority of the music track. <syntaxhighlight lang="c++">
void PlayGuiSound(string asName, float afVol)
</syntaxhighlight>

Play a sound gui sound, with out any position. asName The sound name afVol Volume of the sound 
=== Physics ===

<syntaxhighlight lang="c++">
void SetJointCallback(string asJointName, string asType,string asFunc)
</syntaxhighlight>

Sets a callback for a joint. The syntax for the function is: void MyFunction(string asJointName) asJointName The joint name asType The type, can be: “OnMax” or “OnMin”. asFunc The script function to be called. Must be in the current script file. “” = disabled. <syntaxhighlight lang="c++">
void BreakJoint(string asJointName)
</syntaxhighlight>

Breaks a joint. asJointName The joint name <syntaxhighlight lang="c++">
void SetJointControllerActive(string asJointName,string asCtrlName, bool abActive)
</syntaxhighlight>

Sets if a joint controller is active or not. asJointName The joint name asCtrlName The controller name abActive If the controller is to be active or not. <syntaxhighlight lang="c++">
SetJointControllerPropertyFloat(string asJointName,string asCtrlName, string asProperty, float afValue)
</syntaxhighlight>

Sets if a joint controller is active or not. asJointName The joint name asCtrlName The controller name asProperty The property to change. afValue The value of the property to change. <syntaxhighlight lang="c++">
void ChangeJointController(string asJointName,string asCtrlName)
</syntaxhighlight>

Change the active controller. All other controllers are set to false. asJointName The joint name asCtrlName The controller name <syntaxhighlight lang="c++">
float GetJointProperty(string asJointName, string asProp)
</syntaxhighlight>

Gets a property from the joint. Valid properties are: “Angle” The angle between the bodies (in degrees) (Not working for ball joint) “Distance” The distance between the bodies (in meter) “LinearSpeed” The relative linear speed between the bodies (in m/s) “AngularSpeed” The relative angular speed between the bodies (in m/s) “Force” The size of the force (in newton, kg*m/s^2). “MinLimit” The minimum limit of the joint. “MaxLimit” The maximum limit of the joint. asJointName The joint name asProp The property to get <syntaxhighlight lang="c++">
SetJointProperty(string asJoint, string asProp, float afVal)
</syntaxhighlight>

Sets a property to the joint. asJoint the joint to change property for asProp what property to change: “MinLimit” the min limit on joint, does not work on ball joint. “MaxLimit” the max limit on joint, does not work on ball joint. afVal the value in float to set. <syntaxhighlight lang="c++">
float GetBodyProperty(string asBodyName, string asProp)
</syntaxhighlight>

Gets a property from the body. Valid properties are: “Mass” The mass of the body (in kg) “LinearSpeed” The linear speed the body has (in m/s) “AngularSpeed” The angular speed the body has (in m/s) asBodyName The body name asProp The property to get <syntaxhighlight lang="c++">
void SetBodyProperty(string asBodyName, string asProp, float afVal)
</syntaxhighlight>

Sets a property to the body. Valid properties are: “Mass” The mass of the body (in kg) “CollideCharacter” If the body should collide with the character or not, 0=false 1=true. “HasGravity” If a body is affected by gravity. 0=false 1=true. asBodyName The body name asProp The property to get afVal The new value of the property <syntaxhighlight lang="c++">
void AddBodyForce(string asBodyName, string asCoordType, float afX, float afY, float afZ)
</syntaxhighlight>

Adds a force to the body. This can either be in the bodies local coord system or the world's. asBodyName The body name asCoordType The coordinate system type. “World” or “Local”. afX force in the x direction. (in newton, kg*m/s^2) afY force in the y direction. (in newton, kg*m/s^2) afZ force in the z direction. (in newton, kg*m/s^2) <syntaxhighlight lang="c++">
void AddBodyImpulse(string asBodyName, string asCoordType, float afX, float afY, float afZ)
</syntaxhighlight>

Adds an impule (a change in velocity) to the body. This can either be in the bodies local coord system or the world's. asBodyName The body name asCoordType The coordinate system type. “World” or “Local”. afX velocity in the x direction. (in m/s) afY velocity in the y direction. (in m/s) afZ velocity in the z direction. (in m/s) 
=== Local Variables ===

<syntaxhighlight lang="c++">
void CreateLocalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
void SetLocalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
void AddLocalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
int GetLocalVar(string asName)
</syntaxhighlight>

 
=== Global Variables ===

<syntaxhighlight lang="c++">
void CreateGlobalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
void SetGlobalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
void AddGlobalVar(string asName, int alVal)
</syntaxhighlight>
<syntaxhighlight lang="c++">
int GetGlobalVar(string asName)
</syntaxhighlight>

 
== Game scripts ==

=== General ===

<syntaxhighlight lang="c++">
void ResetGame();
</syntaxhighlight>

Resets the game and returns to main menu <syntaxhighlight lang="c++">
void StartCredits();
</syntaxhighlight>

Starts the end credits screen, uses .lang Category “MainMenu” and .lang Entry “CreditsText” as well as music file “penumbra_music_E1_E.ogg” <syntaxhighlight lang="c++">
void StartDemoEndText();
</syntaxhighlight>

Starts the end images that are used in the demo of episode 1, images are named “demo_end01.jpg” increase the number for each image you want to use. <syntaxhighlight lang="c++">
string GetActionKeyString(string asAction);
</syntaxhighlight>

Gets the key for a certain action, for example can be used in tutorials to create text that uses the user configured key for “Interact”. asAction The name of the action <syntaxhighlight lang="c++">
void AddMessageTrans(string asTransCat, string asTransName);
</syntaxhighlight>

Adds on on screen game message. TransCat The translation category TransName The translation name <syntaxhighlight lang="c++">
void AddMessage(string asMessage);
</syntaxhighlight>

Adds on on screen game message. asMessage The text to be shown. <syntaxhighlight lang="c++">
void SetMessagesOverCallback(string asFunction);
</syntaxhighlight>

Sets a callback that is called (and removed) when the last message as been shown. asFunction The function to be called, syntax “MyFunc()“ <syntaxhighlight lang="c++">
void AddSubTitleTrans(string asTransCat,string asTransName, float afTime);
</syntaxhighlight>

Adds a onscreen message at the bottom, that does not interrupt the gameplay. asTransCat The translation files category. asTransName The translation files name of the entry to be displayed. afTime the length of time it should be displayed. <syntaxhighlight lang="c++">
void AddSubTitle(string asMessage, float afTime);
</syntaxhighlight>

Adds a onscreen message at the bottom, that does not interrupt the gameplay. asMessage the text you want to appear on screen. afTime the length of time it should be displayed. <syntaxhighlight lang="c++">
SetMessageBlackText(bool abX)
</syntaxhighlight>

Makes the onscreen text invert colours to be easier to read on bright backgrounds. abX enable or disabled the function. <syntaxhighlight lang="c++">
void AddRadioMessage(string asTransCat,string asTransName,string asSound);
</syntaxhighlight>

Plays an audio file and displays subtitles for it. asTransCat the Category in the translations file asTransName the name of the entry in the translations file asSound the sound file to play for the text. <syntaxhighlight lang="c++">
void SetRadioOnEndCallback(string asFunc);
</syntaxhighlight>

Callback that activates when a Radio message is over asFunc The name of the callback to activate VARIOUS TEMP STRINGS

<syntaxhighlight lang="c++">
void AddToTempString(string asString); //A piece of text to add to a string
void AddToTempStringTrans(string asCat,string asEntry); //A text from the translations file in Category from Entry
void AddToTempStringAction(string); //Get user configured key for a certain action
void AddMessageTempString(); //Add the strings to one temporary string to print as a Message on screen
void AddSubTitleTempString(float); //Add the strings to one temporary string to print as a Subtitle on screen
</syntaxhighlight>

Used to create a flow of text that uses various sources, as an example from episode 1:

<syntaxhighlight lang="c++">
AddToTempStringTrans("00_01_boat_cabin", "PadLock01");
AddToTempStringAction("Inventory");
AddToTempStringTrans("Misc", "ParentDot");
AddMessageTempString();
</syntaxhighlight>

Wrote the message “Always travel with a padlock. And a key, preferably. Mine's in the inventory (TAB).” as a message. <syntaxhighlight lang="c++">
void ChangeMap(string asMapFile, string asMapPos,
string asStartSound, string asStopSound,
float afFadeOutTime, float afFadeInTime,
string asLoadTextCat, string asLoadTextEntry);
</syntaxhighlight>

Changes the map. asMapFile The file to be loaded asMapPos The position on the map to be spawned on. asStartSound The sound that is played when the change starts. asStopsSound The sound that is played when the new map is loaded afFadeOutTime Time in seconds it takes for the fade out. afFadeInTime Time in seconds it takes for the fade in. asLoadTextCat Category in .lang file to use asLoadTextEntry Entry in .lang file to use <syntaxhighlight lang="c++">
void AddNotebookTask(string asName, string asTransCat,
string asTransEntry);
</syntaxhighlight>

Adds a new task note in the notebook asName Name of the task asTransCat Translation category of text. asTransEntry Translation entry of text. <syntaxhighlight lang="c++">
void AddNotebookTaskText(string asName,string asText);
</syntaxhighlight>

Adds a new task note in the notebook without using the lang file. asName Name of the task asText The text for the task <syntaxhighlight lang="c++">
void AddNotebookNote(string asNameCat, string asNameEntry,
string asTextCat, string asTextEntry);
</syntaxhighlight>

Adds a note to the note book asNameCat asNameEntry Name of the note asTextCat asTextEntry The note text. <syntaxhighlight lang="c++">
void RemoveNotebookTask(string asName);
</syntaxhighlight>

Removes a task note in the notebook. asName Name of the task <syntaxhighlight lang="c++">
void StartNumericalPanel(string asName,int alCode1,int alCode2,int alCode3,
int alCode4, float afDifficulty, string asCallback);
</syntaxhighlight>

Starts the numerical panel asName Name of the panel alCode1 1st code digit. alCode2 2nd code digit. alCode3 3rd code digit. alCode4 4th code digit. afDifficulty How difficult it is to hack. asCallback Called when the code as been entered. Syntax: '''MyCallback(string asName, bool abCodeWasCorrect)''' <syntaxhighlight lang="c++">
void SetInventoryActive(bool abX);
</syntaxhighlight>

Set if the inventory should be active. abX If it is active or not. <syntaxhighlight lang="c++">
void FadeIn(float afTime);
</syntaxhighlight>

Fades the screen to full color. afTime Time the fade will take in seconds. <syntaxhighlight lang="c++">
void FadeOut(float afTime);
</syntaxhighlight>

Fades the screen to black. afTime Time the fade will take in seconds. <syntaxhighlight lang="c++">
bool IsFading();
</syntaxhighlight>

Check if a fade is going on. <syntaxhighlight lang="c++">
void SetWideScreenActive(bool abActive);
</syntaxhighlight>

Sets wide screen mode on or off. <syntaxhighlight lang="c++">
void AutoSave();
</syntaxhighlight>

Save the game to the auto save. <syntaxhighlight lang="c++">
void ClearSavedMaps();
</syntaxhighlight>

Clears the “history” of the save, useful to do when you know the player will not be able to go back anymore. Makes the next save much smaller in size. It's a must to clear the save history a couple of times during the length of a game, in Penumbra: Overture we do it 5-7 times during the whole game. <syntaxhighlight lang="c++">
SetDepthOfFieldActive(bool abX, float afFadeTime);
</syntaxhighlight>

Sets depth of field on/off abX if true/false afFadeTime how long for it to focus. <syntaxhighlight lang="c++">
SetupDepthOfField(float afNearPlane, float afFocalPlane, float afFarPlane);
</syntaxhighlight>

How the depth of field should appear afNearPlane where the focus should begin afFocalPlane how large area that is in focus afFarPlane where the focus should end <syntaxhighlight lang="c++">
FocusOnEntity(string asEntity);
</syntaxhighlight>

Set focus on a particular entity. asEntity name of the entity <syntaxhighlight lang="c++">
SetConstantFocusOnEntity(string asEntity);
</syntaxhighlight>

Set focus on a particular entity and keep focus on it if it moves or the player moves. asEntity name of the entity <syntaxhighlight lang="c++">
void StartFlash(float afFadeIn, float afWhite, float afFadeOut);
</syntaxhighlight>

Creates a white flash on screen. afFadeIn The time the fade in takes. afWhite The time it stays white. afFadeOut The time the fade out takes. <syntaxhighlight lang="c++">
StartScreenShake(float afAmount, float afTime,float afFadeInTime,float afFadeOutTime);
</syntaxhighlight>

Makes the screen shake. afAmount The ammount of shaking. afTime How long the shake should be. afFadeInTime How fast the shake should fade in. afFadeOutTime How fast the shake should fade out. <syntaxhighlight lang="c++">
SetupSaveArea(string asName,string asMessageCat,string asMessageEntry, string asSound);
</syntaxhighlight>

Properties for an area to type “save”, eg “_area_save_gamename”. asName the name of the area asMessageCat The message category in lang file asMessageEntry The message entry in lang file asSound The sound to play during the save 
=== Attacks ===

<syntaxhighlight lang="c++">
void CreateSplashDamage(string asAreaName, float afRadius, float afMinDamage, float afMaxDamge,
float afMinForce, float afMaxForce, float afMaxImpulse, int alStrength);
</syntaxhighlight>

Creates a ball shaped splash damage at the center of an area. asAreaName Name of the area. afRadius Radius of the slash damage in meters. afMinDamage The minimum damage if in side radius afMaxDamge The maximum damage, this is when you are at center. afMinForce The minimum force if you are inside the radius. afMaxForce The maximum force, this is when you are at center. afMaxImpulse Impulse is ForceSize / Mass and this is the max value for that. This is useful to insure that samll objects to no gain very high speed. alStrength The strength of the the damage. <syntaxhighlight lang="c++">
void SetupDamageArea( string asName, float afDamage,
float afUpdatesPerSec, int alStrength,
bool abDisableObjects, bool abDisableEnemies,
string asDamageType, string asDamageSound);
</syntaxhighlight>

Properties for an area of type “damage”, eg “_area_damage_gamename”. Will inflict damage on player and entites while in it. asName The name of the area afDamage Damage to do for each update afUpdatesPerSec How many updates per second alStrength The strength of each update abDisableObjects If objects should be disabled on destruction abDisableEnemies If enemies should be disabled on destruction asDamageType What sort of damage graphics to use. “BloodSplash”, “Ice”, “Poison”. asDamageSound What sound to play at each damage. <syntaxhighlight lang="c++">
void DamageEntity(string asName, float afDamage, int alStrength);
</syntaxhighlight>

Gives damage to an entity asName the name of the entity afDamage the amount of damage to do alStrength the strength of the damage 
=== Game Timer ===

<syntaxhighlight lang="c++">
void CreateTimer(string asName, float afTime, string asCallback, bool abGlobal);
</syntaxhighlight>

Creates a new timer which calls a callback function when the time is out. Syntax: '''MyCallback(string asTimerName)''', the prefix ”@” (ie “@Func()”) shows that the function is in the global script asName Name of the timer afTime The time til time out in seconds. asCallback The callback fucntion abGlobal If the timer is global. Global timers are not deleted at map change. <syntaxhighlight lang="c++">
void DestroyTimer(string asName);
</syntaxhighlight>
<syntaxhighlight lang="c++">
void SetTimerPaused(string asName, bool abPaused);
</syntaxhighlight>
<syntaxhighlight lang="c++">
void SetTimerTime(string asName, float afTime);
</syntaxhighlight>
<syntaxhighlight lang="c++">
void AddTimerTime(string asName, float afTime);
</syntaxhighlight>
<syntaxhighlight lang="c++">
float GetTimerTime(string asName);
</syntaxhighlight>

 
=== Player ===

<syntaxhighlight lang="c++">
void GivePlayerDamage(float afAmount, string asType);
</syntaxhighlight>

Gives the player a hit + damage afAmount The amount of health taken. asType what sort of damage effect “BloodSplash” “Ice” “Poison” <syntaxhighlight lang="c++">
void SetPlayerHealth(float afHealth);
</syntaxhighlight>

Sets the health of the player. afHealth The amount the health should be set to. <syntaxhighlight lang="c++">
float GetPlayerHealth();
</syntaxhighlight>

Gets the current health of the player. <syntaxhighlight lang="c++">
void SetPlayerPose(string asPose,bool abChangeDirectly);
</syntaxhighlight>

Sets the pose of the player. asPose The pose, can be “Stand” or “Crouch” abChangeDirectly, if the pose should change instantly or in a movement <syntaxhighlight lang="c++">
void SetPlayerActive(bool abActive);
</syntaxhighlight>

Sets if player can be moved or not. abActive If the player is active or not. <syntaxhighlight lang="c++">
void StartPlayerLookAt(string asEntityName, float afSpeedMul, float afMaxSpeed);
</syntaxhighlight>

This turns the players head towards a specific entity. asEntityName The entity name afSpeedMul The speed of the head movement is determined by the angle length multiplied by this. afMaxSpeed The maximum speed the head will turn. <syntaxhighlight lang="c++">
void StopPlayerLookAt();
</syntaxhighlight>

Stops the look at motion. <syntaxhighlight lang="c++">
void StartPlayerFearFilter(float afStrength);
</syntaxhighlight>

Starts a fear effect filter. afStrength strength of the filter. <syntaxhighlight lang="c++">
SetFlashlightDisabled(bool abDisabled);
</syntaxhighlight>

Disabled the flashlight. abDisabled true/false for flashlight on/off. <syntaxhighlight lang="c++">
void StopPlayerFearFilter();
</syntaxhighlight>

Stops the fear filter. <syntaxhighlight lang="c++">
void TeleportPlayerToArea(string asArea);
</syntaxhighlight>

Teleports the player to an area, players feet is aligned to the center of the area. asArea the name of the area to teleport to. <syntaxhighlight lang="c++">
bool GetPlayerHasGasMask();
</syntaxhighlight>

Get if the player has gasmask or not. 
=== Inventory ===

<syntaxhighlight lang="c++">
void AddPickupCallback(string asItem, string asFunction);
</syntaxhighlight>

Add a callback that is called when the player picks up an item. The syntax for the callback function is: '''void MyFunction(string asItem)''', the prefix “@” (ie “@Func()”) shows that the function is in the global script asItem The name of the item. asFuntion The name of the function called. <syntaxhighlight lang="c++">
void AddUseCallback(string asItem, string asEntity, string asFunction);
</syntaxhighlight>

Add a callback that is called when the player uses the item on en entity The syntax for the callback function is: '''void MyFunction(string asItem, string asEntity)''', the prefix “@” (ie “@Func()”) shows that the function is in the global script. asItem The name of the item. asEntity The name of the entity. asFuntion The name of the function called. <syntaxhighlight lang="c++">
void AddCombineCallback(string asItem1,string asItem2, string asFunction);
</syntaxhighlight>

Add a callback that is called when the player combines two items The syntax for the callback function is (alSlotIndex = slot at which combination occurd): '''void MyFunction(string asItem1, string asItem2, int alSlotIndex)''', the prefix “@” (ie “@Func()”) shows that the function is in the global script. asItem1 The name of the first item. asItem2 The name of the second item. asFuntion The name of the function called. <syntaxhighlight lang="c++">
void RemovePickupCallback(string asFunction);
</syntaxhighlight>
<syntaxhighlight lang="c++">
void RemoveUseCallback(string asFunction);
</syntaxhighlight>
<syntaxhighlight lang="c++">
void RemoveCombineCallback(string asFunction);
</syntaxhighlight>

Removes the callback. asFuntion The name of the function used by the callback. <syntaxhighlight lang="c++">
bool HasItem(string asName);
</syntaxhighlight>

Checks if the player has a certain item. asName The name of the item. <syntaxhighlight lang="c++">
void RemoveItem(string asName);
</syntaxhighlight>

Removes an item from the inventory. asName The name of the item. <syntaxhighlight lang="c++">
void GiveItem(string asName,string asEntityFile, int alSlotIndex);
</syntaxhighlight>

Give an item to the player. asName The name of the entity asEntityFile The file to load it from. lSlotIndex The index of the slot to put the item in. -1 = first empty slot <syntaxhighlight lang="c++">
SetInventoryMessage(string asMessage);
</syntaxhighlight>

Displays a message in the inventory. asMessage The message to write in the inventory. <syntaxhighlight lang="c++">
SetInventoryMessageTrans(string asTransCat, string asTransName);
</syntaxhighlight>

Displays a message from the lang file in the inventory. asTransCat The name of the category in the lang file. asTransName The name of the entry in the lang file. 
=== Map / Level Properties ===

<syntaxhighlight lang="c++">
SetAmbientColor(float r, float g, float b);
</syntaxhighlight>

Sets the ambient color of the level, this should always be part of a level as it gives it a bit of light otherwise shadows will be pitch black. <syntaxhighlight lang="c++">
SetSectorProperties(string asSector, float afAmbR,float afAmbG, float afAmbB);
</syntaxhighlight>

Sets the ambient color of a sector(individual groups of _room. asSector the name of the sector. afAmbR red 0-1 afAmbG green 0-1 afAmbB blue 0-1 The values are multiplied with the SetAmbientColor(f,f,f); values. This script function will most likely be expanded to include specific ambient sounds etc for each sector. <syntaxhighlight lang="c++">
SetSkybox(string asTexture);
</syntaxhighlight>

Sets a texture as a sky box. <syntaxhighlight lang="c++">
SetSkyboxActive(bool);
</syntaxhighlight>

Set the skybox active with true/False <syntaxhighlight lang="c++">
SetSkyboxColor(float R, float G, float B, float A);
</syntaxhighlight>

What color should the Skybox have R, G, B and Alpha <syntaxhighlight lang="c++">
SetFogActive(bool abX);
</syntaxhighlight>

If a level should have fog or not. bool abX, false/true <syntaxhighlight lang="c++">
SetFogProperties(float afStart, float afEnd, float r,float g, float b);
</syntaxhighlight>

The properties of the fog. afStart how many meters from the camera should the fog begin. afEnd how many meters from the camera should the fog reach full thickness. float r,float g, float b the color of the fog in RGB. <syntaxhighlight lang="c++">
SetFogCulling(bool);
</syntaxhighlight>

Should the game stop rendering the level when the fog is full thickness true/false <syntaxhighlight lang="c++">
SetWaveGravityActive(bool abX);
</syntaxhighlight>

Enable a dynamic gravity that mimics waves, ture/false <syntaxhighlight lang="c++">
SetupWaveGravity(float afMaxAngle, float afSwingLength, float afGravitySize, string asAxis);
</syntaxhighlight>

Set the properties for the dynamic wave gravity afMaxAngle The maximum angel of the wave afSwingLength The length for going from top to bottom afGravitySize The strength of the gravity asAxis Along which axis should the wave “move” <syntaxhighlight lang="c++">
SetMapGameName(string asName);
</syntaxhighlight>

Set the name of the current map, is used for naming the saved games. asName the name of the map <syntaxhighlight lang="c++">
SetMapGameNameTrans(string asTransCat,string asTransEntry);
</syntaxhighlight>

Set the name of the current map using the lang file, is used for naming the saved games. asTransCat the category in the lang file asTransEntry the entry in the lang file with the name of the map 
=== Game Entity Properties ===

<syntaxhighlight lang="c++">
void SetGameEntityActive(string asName, bool abX);
</syntaxhighlight>

Set if a game entity is active. asName The name of the game entity abX If active or not. <syntaxhighlight lang="c++">
bool GetGameEntityActive(string asName);
</syntaxhighlight>

Get if a game entity is active. asName The name of the game entity return if active or not. <syntaxhighlight lang="c++">
void ReplaceEntity(string asName, string asBodyName, string asNewName, string asNewFile);
</syntaxhighlight>

Replaces an ingame entity with another entity, the new entity will appear at the center of the old entities location asName Name of the ingame entity asBodyName The name of the body in the old entity that will be used as a center for the new entity, leave as “” if entity only has 1 body asNewName The ingame name given to the new entity asNewFile The .ent file to be used for the new entity <syntaxhighlight lang="c++">
void CreateGameEntityVar(string asEntName, string asVarName, int alVal);
</syntaxhighlight>

Create a variable for a game entity. Nothing happens if it is already created. asEntName The name of the game entity asVarName The name of variable alVal value to set the variable to. <syntaxhighlight lang="c++">
void SetGameEntityVar(string asEntName, string asVarName, int alVal);
</syntaxhighlight>

Change the value of a entity variable to a new value asEntName The name of the game entity asVarName The name of variable alVal value to set the variable to. <syntaxhighlight lang="c++">
void AddGameEntityVar(string asEntName, string asVarName, int alVal);
</syntaxhighlight>

Change the value of an entity variable by adding to the previous value asEntName The name of the game entity asVarName The name of variable alVal value to add to the existing variable. <syntaxhighlight lang="c++">
int GetGameEntityVar(string asEntName, string asVarName);
</syntaxhighlight>

Get the value of a variable for a game entity. asEntName The name of the game entity asVarName The name of variable alVal value to set the variable to. <syntaxhighlight lang="c++">
void SetGameEntityMaxExamineDist(string asName,float afDist);
</syntaxhighlight>

Set the maximum distance at which a game entity can be examined. asName The name of the game entity afDist The distance in meters <syntaxhighlight lang="c++">
void SetGameEntityMaxInteractDist(string asName,float afDist);
</syntaxhighlight>

Set the maximum distance at which a game entity can be interacted with. asName The name of the game entity afDist The distance in meters <syntaxhighlight lang="c++">
void SetGameEntityDescriptionTrans(string asName,string asTransCat, string asTransName);
</syntaxhighlight>

Set a description on a game entity. asName The name of the game entity asTransCat The translation category asTransName The translation name <syntaxhighlight lang="c++">
SetGameEntityDescriptionOnceTrans(string asName,string asTransCat,string asTransName);
</syntaxhighlight>

Set a description on a game entity BUT display the eye only 1 time, after that the you can still examine but the eye wont show unless in Interact mode. asName The name of the game entity asTransCat The translation category asTransName The translation name <syntaxhighlight lang="c++">
void SetGameEntityDescription(string asName, string asMessage);
</syntaxhighlight>

Set a description on a game entity. asName The name of the game entity asMessage The message <syntaxhighlight lang="c++">
void SetGameEntityGameNameTrans(string asName, string asTransCat,string asTransName);
</syntaxhighlight>

Set a game name on a game entity. asName The name of the game entity asTransCat The translation category asTransName The translation name <syntaxhighlight lang="c++">
void SetDoorState(string asName,string asState);
</syntaxhighlight>

Sets the state of a door with animation. This entity was only used in early test builds of HPL. asName The name of the game entity asState The state to set, thís can be “Open”,“Closed”, “Opening” or “Closing”. <syntaxhighlight lang="c++">
SetDoorLocked(string asDoor, bool abLocked);
</syntaxhighlight>

Sets a door locked or unlocked, only works with SwingDoor entities(set in the .ent file) asDoor the name of the entity. abLocked true or false if locked or not. <syntaxhighlight lang="c++">
SetDoorLockedProperties(string asDoor,
string asMessCat,string asMessEntry,
string asSound,
bool RepeatLockedMessage);
</syntaxhighlight>

Gives properties to a locked door, how it should sound what message to show etc. Only works with SwingDoor entities(set in the .ent file) asDoor the name of the entity. asMessCat the name of the category in the translations file. asMessEntry the name of the entry in the translations file to use. asSound sound to play for the locked door when player interacts. RepeatLockedMessage true or false if the event should be every time or only the first time. <syntaxhighlight lang="c++">
void SetObjectInteractMode(string asName,string asMode);
</syntaxhighlight>

Sets the interact mode of an game object. asName The name of the game object asState The mode to set, valid modes are “Static”, “Grab”, “Move” and “Push”. <syntaxhighlight lang="c++">
void SetupLink(string asName, string asMapFile, string asMapPos,
string asStartSound, string asStopSound,
float afFadeOutTime, float afFadeInTime);
</syntaxhighlight>

Sets up the properties for a link. asName The name of the link asMapFile The file to be loaded asMapPos The position on the map to be spawned on. asStartSound The sound that is played when the change starts. asStopsSound The sound that is played when the new map is loaded afFadeOutTime Time in seconds it takes for the fade out. afFadeInTime Time in seconds it takes for the fade in. <syntaxhighlight lang="c++">
void SetupLinkLoadText(string asName,
string asMapFile, string asMapPos,
string asStartSound, string asStopSound,
float afFadeOutTime, float afFadeInTime,
string asTextCat, string asTextEntry);
</syntaxhighlight>

Sets up the properties for a link and displays a screen with text/picture while loading. asName The name of the link asMapFile The file to be loaded asMapPos The position on the map to be spawned on. asStartSound The sound that is played when the change starts. asStopsSound The sound that is played when the new map is loaded afFadeOutTime Time in seconds it takes for the fade out. afFadeInTime Time in seconds it takes for the fade in. asTextCat The text category in translations file .lang asTextEntry The text entry in translations file .lang <syntaxhighlight lang="c++">
void SetupLinkLockedProp(string asName,string asLockedSound,
string asLockedDescCat,string asLockedDescEntry);
</syntaxhighlight>

Properties for an area of type “link”, eg “_area_link_gamename”, to be used if the link is “locked”. asName The name of the link asLockedSound The “locked sound” to play asLockedDescCat In what category the text to use is in the .lang file. asLockedDescEntry In what entry the text is found in the .lang file. <syntaxhighlight lang="c++">
void SetLinkLocked(string asName, bool abLocked);
</syntaxhighlight>

Set an area of type “link” as locked or unlocked. asName The name of the link abLocked True/false for locked or not. <syntaxhighlight lang="c++">
void SetAreaCustomIcon(string asName, string asIcon);
</syntaxhighlight>

Makes the area show a custom icon on player focus. asName The name of the area asIcon The icon, can be: “Inactive”, “Active”, “Invalid”, “Grab”, “Examine”,, “PickUp”, “Pointer”, “Item”, “DoorLink” or “None”. <syntaxhighlight lang="c++">
void AddEnemyPatrolNode(string asEnemy,string asNode,float afTime,string asAnimation);
</syntaxhighlight>

Adds node that the enemy will have on his patrol path. asEnemy Name of the enemy asNode The Node to walk to. afTime The time to stay at the node when reached. asAnimation The animation to be played when at the node. “” = idle. <syntaxhighlight lang="c++">
void ClearEnemyPatrolNodes(string asEnemy);
</syntaxhighlight>

Clears all the patrol nodes for the enemy asEnemy The Name of the enemy. <syntaxhighlight lang="c++">
void SetEntityHealth(string asName, float afHealth);
</syntaxhighlight>

Sets the health of an entity asName Name of the entity afHealth the amount to set the health to. <syntaxhighlight lang="c++">
float GetEnemyHealth(string asEnemy);
</syntaxhighlight>

Gets the health of an enemy asEnemyName Name of the enemy return the health. <syntaxhighlight lang="c++">
void ShowEnemyPlayer(string asEnemy);
</syntaxhighlight>

Show the enemy the position of the player and sets the enemy into hunt mode. asEnemy The name of the Enemy. <syntaxhighlight lang="c++">
void SetEnemyUseTriggers(string asEnemy, bool abUseTriggers);
</syntaxhighlight>

If an enemy should use triggers, for example if an enemy should react to sounds. asEnemy The name of the Enemy. abUseTriggers use triggers or not. <syntaxhighlight lang="c++">
void SetEnemyAttackCallback(string asEnemy,string asFunction);
</syntaxhighlight>

Activates a callback when an enemy attacks the player. asEnemy The name of the Enemy. asFunction The name of the callback to activate. <syntaxhighlight lang="c++">
SetLampLit(string asName,bool abLit, bool abFade);
</syntaxhighlight>

Sets a Lamp entity light on/off, requires the entity file to be a Type=“Lamp”. asName The name of the lamp entity. abLit if it should be lit or not. abFade if it should fade on/off, properties are set in the entity file. <syntaxhighlight lang="c++">
void SetLampFlicker(string asName,bool abFlicker);
</syntaxhighlight>

Sets a Lamp entity lights flicker, requires the entity file to be a Type=“Lamp”. asName The name of the lamp entity. abFlicker starts/stops the flicker. Flicker properties are set in the entity file. <syntaxhighlight lang="c++">
SetupStickArea(string asArea, bool abCanDeatch,
bool abMoveBody, bool abRotateBody,
bool abCheckCenterInArea, float afPoseTime,
string asAttachSound, string asDetachSound,
string asAttachPS, string asDetachPS,
string asAttachFunc, string asDetachFunc);
</syntaxhighlight>

Give properties to an area of type “stick”. Used to make an object attach itself to another etc. asArea The name of the stick area abCanDeatch if the area will allow to detach and attached object abMoveBody Should the attached object be moved into the center abRotateBody should the attached object be rotated to attach in a certain direction(rotating the stick area in the level will decide this) abCheckCenterInArea only attach if the object to be attached is in the center of the stick area afPoseTime how long will the attach movement(move/rotate) take asAttachSound what attach sound to play asDetachSound what detach sound to play asAttachPS what particle effect to use on attach asDetachPS what particle effect to use on detach asAttachFunc name of attach callback asDetachFunc name of detach callback <syntaxhighlight lang="c++">
void AllowAttachment();
</syntaxhighlight>

Executes the attachment settings in SetupStickArea. ''Example of an attach callback''
<syntaxhighlight lang="c++">
void MyAttach(string asArea, string asBody)
{
if(StringContains(asBody, "entityname"))
{
AllowAttachment();
}
}
</syntaxhighlight>

<syntaxhighlight lang="c++">
DetachBodyFromStickArea(string asArea);
</syntaxhighlight>

Detach a body from a stick area. asArea Name of the area. <syntaxhighlight lang="c++">
SetupLadder(string asName,string asAttachSound, string asClimbUpSound, string asClimbDownSound);
</syntaxhighlight>

Sets properties for an area of type “ladder”. eg “_area_ladder_gamename” asName Name of the area. asAttachSound Sound to be played as player grabs onto ladder asClimbUpSound Sound to be played as player climbs up. asClimbDownSound Sound to be played as player climbs down. <syntaxhighlight lang="c++">
void ChangeEntityAnimation(string asName,string asAnimation,bool abLoop);
</syntaxhighlight>

Change the animation of an entity. asName Name of the entity. asAnimation the animation that should be used abLoop if it should loop or not. <syntaxhighlight lang="c++">
void SetupForceArea( string asName,
float afMaxForce, float afConstant,
float afDestSpeed, float afMaxMass,
bool abMulWithMass, bool abForceAtPoint,
bool abAffectBodies, bool abAffectCharacters);
</syntaxhighlight>

Properties for an area of type “force”, eg “_area_force_gamename”. asName Name of the entity. afMaxForce the value for the maximum force to apply afConstant Used in the formula. Force = Constant * DistanceToDestSpeed, meaning it determines the force based on how far from the dest speed the object is. afDestSpeed the value of the speed an object will travel at when reached maximum afMaxMass the maximum mass that will be affected by the force abMulWithMass if the force should apply the same amount to all objects of different mass abForceAtPoint if force is to be applied to the collison point with the area. False = just use center of object. abAffectBodies affect dynamic objects/bodies abAffectCharacters affect charaters(player/enemies/etc) <syntaxhighlight lang="c++">
SetupLiquidArea(string asName,float afDensity, float afLinearViscosity,float afAngularViscosity,string asPhysicsMaterial.
float fR, float fG, float fB, abHasWaves);
</syntaxhighlight>

Properties for an area of type “liquid”, eg “_area_liquid_gamename”. asName Name of the entity. afDensity The density of the liquid afLinearViscosity How much “friction” the liquid should have in linear direction. afAngularViscosity How much “friction” the liquid should have in angular direction asPhysicsMaterial What physics material to use fR, fG, fB The color of the liquid in Red, Green, Blue abHasWaves if objects should bob in the water.

<syntaxhighlight lang="c++">
void SetupGameButton(string asName,string asCallback,string asAffectedEntities);
</syntaxhighlight>

Creates a callback for entity of type “button”, eg .ent says Type=“Button”. asName Name of the entity. asCallback the name of the callback to activate. asAffectedEntities The names of the entities that should be activated, example “light01” or “light01, light02, light03”.

Callback syntax: '''void OnStateChange(string asButton,bool asInOn);'''
<syntaxhighlight lang="c++">
void SetGameButtonOn(string asName, bool abOn, bool abUseEffects);
</syntaxhighlight>

Sets a button entity on/off. asName Name of the entity. abOn On or off, true/false abUseEffects if various effects set in the entity files of the entities affected by the button switch should be used or not. <syntaxhighlight lang="c++">
int GetLeverState(string asName);
</syntaxhighlight>

Gets the current state of a Lever entity. asName Name of the entity. returns int as -1 = min, 0=middle, 1=max <syntaxhighlight lang="c++">
void SetLeverStuck(string asName,int alState);
</syntaxhighlight>

Sets a Lever entity stuck at a certain position. asName Name of the entity. alState What position to stick it in, state: -1 = min, 0=middle, 1=max <syntaxhighlight lang="c++">
int GetWheelState(string asName);
</syntaxhighlight>

Gets the current state of a Wheel entity. asName Name of the entity. returns int as -1 = min, 0=middle, 1=max <syntaxhighlight lang="c++">
void SetWheelStuck(string asName,int alState );
</syntaxhighlight>

Sets a Wheel entity stuck at a certain position. asName Name of the entity. alState What position to stick it in, state: -1 = min, 0=turn off stuck, 1=max <syntaxhighlight lang="c++">
float GetWheelAngle(string asName);
</syntaxhighlight>

Gets the current angle of a Wheel entity. asName Name of the entity. returns the value as float. <syntaxhighlight lang="c++">
float GetWheelSpeed(string asName);
</syntaxhighlight>

Gets the current speed of a Wheel entity. asName Name of the entity. returns the value as float. <syntaxhighlight lang="c++">
ConnectWheelToController(string asWheelName,string asEntName,string asCtrlName,
float afMinDest, float afMaxDest);
</syntaxhighlight>

Connects a controller in the .ent file to the wheel. asWheelName Name of the wheel entity in level. asEntName Name of the entity file to use. asCtrlName Name of the controller. afMinDest Value of the minimum destination. afMaxDest Value of the maximum destination. <syntaxhighlight lang="c++">
MoveEntityToArea(string asEntityName, string asAreaName,
float afSpeed, float afAcceleration,
float afSlowDownRange, string asCallback);
</syntaxhighlight>

Moves an entity to an area. This can be used to create moving platforms, elevators etc. asEntityName Name of the entity. asAreaName Name of the area to move the entity to. afSpeed At what speed to move the entity. afAcceleration Acceleration of the entity. afSlowDownRange How far away from the area to begind deceleration. asCallback name of the callback to trigger when entity reaches area. '''Callback syntax: MyFunc(string asEntityName)''' 
=== Game Entity Callbacks ===

<syntaxhighlight lang="c++">
void AddEntityCollideCallback(string asType, string asDestName,
string asEntityName, string asFuncName);
</syntaxhighlight>

Add a collide callback to an entity. The syntax for the callback function is: '''void MyFunction(string asParent, string asChild)''', the prefix “@” (ie “@Func()”) shows that the function is in the global script. asParent is the entity the function is attached to and asChild is the other entity in the collision. asType The type of callback, this can be “Enter”, “During” or “Leave” asDestName The entity that should have the callback. “Player” will add it to the player. asEntityName The entity to check for collision with. asFuncName The name of the script function to add. This must be in the level's script file and not the global. <syntaxhighlight lang="c++">
void RemoveEntityCollideCallback(string asType, string asDestName, string asEntityName);
</syntaxhighlight>

Removes a collide callback on an entity. asType The type of callback, this can be “Enter”, “During” or “Leave” asDestName The entity that has the callback asEntityName The entity to check for collision with. <syntaxhighlight lang="c++">
void AddEntityCallback(string asType, string asDestName, string asFuncName);
</syntaxhighlight>

Add a callback to an entity. The syntax for the callback function is: '''void MyFunction(string asEntity)''', the prefix “@” (ie “@Func()”) shows that the function is in the global script. The different types are the following “PlayerInteract” The player interacts with the entity. “PlayerExamine” The player examines the entity. “PlayerLook” The player is looking at the entity (it is in “focus”). “OnUpdate” When the entity is updated. “OnBreak” When the entity breaks. asType The type of callback asDestName The entity that should have the callback asFuncName The name of the script function to add. This must be in the level's script file and not the global. <syntaxhighlight lang="c++">
void RemoveEntityCallback(string asType, string asDestName);
</syntaxhighlight>

Removes a callback on an entity. asType The type of callback. The same types as for AddEntityCallback applies. asDestName The entity that has the callback <syntaxhighlight lang="c++">
void SetEnemyDeathCallback(string asEnemy,string asFunction);
</syntaxhighlight>

Sets the function that is called when the enemy dies. asEnemyName Name of the enemy asFunction The function, syntax: '''MyFunc(string asEnemyName)''' <syntaxhighlight lang="c++">
SetLampLitChangeCallback(string asName,string asCallback);
</syntaxhighlight>

Adds a callback for a Lamp entity, Type=“Lamp” in .ent, as it changes from on to off or vice versa. asName The name of the lamp entity. asCallback The name of the callback, syntax: '''MyFunc(bool abActive)''' <syntaxhighlight lang="c++">
SetLeverCallback(string asName,string asType, string asCallback);
</syntaxhighlight>

Adds a callback for a Lever entity, Type=“Lever” in .ent, as it changes states. asName The name of the lever entity. asType What type: “Enter”, “Leave” or “During”. asCallback The name of the callback, syntax: '''void MyFunc(string asName, int alType, int alState)''' type: 0=enter, 1=leave, 2=during state: -1 = min, 0=middle, 1=max <syntaxhighlight lang="c++">
SetWheelCallback(string asName,string asType,string asCallback);
</syntaxhighlight>

Adds a callback for a Wheel entity, Type=“Wheel” in .ent. asName The name of the wheel entity. asType What type: “Enter”, “Leave” or “During”. asCallback The name of the callback, syntax: '''void MyFunc(string asName, int alType, int alState)''' type: 0=enter, 1=leave, 2=during state: -1 = min, 0=middle, 1=max

HPL1/Editors/Particle Editor

2023-04-08T12:34:55Z

Iamrealife: /* 1.6 Particle Viewer */

=HPL1/Content Creation Chapter 6 HPL Particle Editor=

==1 Introduction==
This is the guide for the HPL-Particle editor which is a tool for creating various particle effects. 
===1.1 Min and Max values===
A lot of values in the editor have both a min and max. This means that when the value is set to a particle a value between min and max is randomly selected. 
===1.2 Fading===
Fading can be used to fade in and/or out some property like size or colour. The fading works like this. There are three relative values that are relative to the start value of the particle. The names for these values are start, middle and end and are used in that order. There are also two times that are relative to the life of the particle, for example if a particle has 2 seconds life time and the middle time is 0.5 then this occurs after 1 second (0.5 * 2). The first time is called middle time and this is when the start value is entirely faded from start to middle. The middle length is how long the middle value lasts. After middle time + middle length the middle value is faded to the end value. 
===1.3 File===
*New - Creates a new particle system and resets all the settings to default.
*Save - Saves your settings to the currently opened Particle System (*.ps) file.
*Save as... - Allows you to save your particle under a different name.
*Open - Lets you open particle files. 

===1.4 Emitters===
This section allows you to view a list of all the currently available emitters in your particle file as well as Add, Copy and remove emitters. 
===1.5 Room===
*Show Room - Here you can choose whether or not the Particle Viewer program should render a small room around the particle that you're currently viewing.
*Room size - This defines how large said room should be. Default settings are 6x6x6 
===1.6 Particle Viewer===
This program allows you to view your Particle by pressing the large and obvious Save and View Particle System button. 
Left Mouse Button lets you move the view around and Middle Mouse Button zooms in and out. Pressing B toggles the bloom option. 

==2 Parameters==
===2.1. General===
'''Name''' The name of the emitter currently selected. 
'''Type''' Only Normal type can be used, Beam type was never implemented. 
'''Max Particles''' The maximum number of particles that can be alive at once. When this limit is reached no more particles willl be created. 
'''Particles per Second''' The number of particles per second that will be created. 
'''Start time offset''' Time offset in seconds before the emitter starts. 
'''Respawn dead particles''' If dead particles should be respawned. 
'''Warm up time''' Time that the emitter gets to warm up. This is useful when doing a a stream of something (like a fire or waterfall) and the particles should not be shown “starting up”. 
'''Pause''' A pause is a break during which no particles are created. Particles are updated though. 
'''Pause Length''' The length of the pauses, 0 and 0 means that there are no pauses. 
'''Pause Interval''' The length between pauses. 0 and 0 means that there are no pauses. 
'''Offset position''' How the emitter is offset relative to its starting positon. 
'''Offset angle''' How to particle system is offset relative to its start angles. 
===2.2 Rendering===
'''Draw Type''' The different ways in which the particles can be draw to screen. Point: The particle is a point and will always be pointing towards the camera. Line: The particle is aligned in the direction in which the particle is travelling. 
'''Multiply RGB with Alpha''' Some materials does not fade out the image when alpha is decreased (for example Additive) in this case it can be good to check this. 
'''Size''' The size of the particle. This is the value used in the fading. 
'''Size Fading''' See 1.2 for instructions on fading. 
===2.3 Collision===
'''Use Collision''' If collision detection should be used. 
'''Update Rate''' How many times a second collision is check for each particle. 
'''Maximum Collisions''' The maximum amount of collions can have before dying. 
'''Bounce Amount''' How much of the speed is retained when bouncing. 0.5 means half of the speed. 2 means that the speed doubles when bouncing. 
===2.4 Beam Specific===
This was meant to create and handle [[HPL1/Content_Creation_Chapter_3#3.13_Beams|Beam]] files, never implemented.

 

===2.5 Rotation===
'''Use Particle Spinning''' 
If enabled, particles will rotate around themselves. 
'''Spin Type''' 
Type for the particle spinning. Can be: 
'''Constant''' 
A value will be picked from the spin velocity range at random. 
'''Movement''' 
The rotation will be linked to how fast the particle is moving. 
'''Particle spin velocity range (rad/s)''' 
Spin velocity for constant spin type. About 6.283 radians is a single spin. 
'''Use Revolution''' 
If enabled, particles will rotate around some axis. 
'''Revolution Velocity (rad/s)''' 
3D Vector that will determine the axis and rotation speed for particles.

 

===2.6 Start===
'''Start type''' Sets what method to use to generate the start position of the particles in the emitter. 
'''Box start''' A box start is created using an x, y and z min and max value. The collection of particles will get the shape of a box. 
'''Sphere start''' The positions are generated using an angle interval and the min and max value for the radius. You can think of it like this; an arrow start pointing up. This arrow is then rotated around the X axis (red) using a value between min and max. After that the arrow is rotated by the y axis (blue). The arrow will now be pointing in a specific direction and in this direction a position is created at a distance from center according to a number generated from min/max radius. [[File:spherestart.jpg]]
 
===2.7 Color===
''NOTE: all of the colour channels have values from 0 -1.'' 
'''Color''' This sets the colour of the particle. 
'''Fading''' Settings for fading the colour. See chapter 1.2 for fading. 
===2.8 Movement===
'''Velocity type''' The way in which the starting velocity is generated. 
'''Box velocity''' The same as box start but with velocity instead. 
'''Sphere Velocity''' The same as sphere start but with velocity instead. 
'''Coord system''' The way in which the particles are related to the world and the object the system is attached to (if any). In world all the particles have an individual postion that does change depending on the parent object. In local however the particle position is dependant on the parent object so if that the particle moves and turns along with the parent. 
'''Uses direction''' If the direction of the start velocity depends on the way the particle system is “facing” (with no rotation it faces up). This is useful for systems like steam where the system has a direction. 
'''Gravity Type''' The type of gravity being applied to the particles. None: No gravity it applied. Vector: The gravity acceleration is applied. Centre: The particles are drawn towards the centre of the particle system with Gravity Acceleration Y as acceleration. 
'''Gravity Acceleration''' Used differently according by the gravity type. 
'''Acceleration''' Accleration applied to all bodies. 
'''Speed multiplier''' How much the speed is multiplied by each second. For example, 0.5 means that the speed halfed each second. 2 means it is doubled each second. 
'''Maximum speed''' The maximum speed that the particles can reach. 
===2.9 Life===
'''Lifespan''' Time in seconds that the particle will live. 
'''Death Type''' Type of death for the particles. Only Age can be selected. 
'''PS created at death''' Particle System to be spawned when the particle dies. Could be used to loop particle creations.
 

===2.10 Material===
'''File''' The material file to use. 
'''Number of Files''' The number of material files used. Normally this should just be one, but in some cases an animation needed is spread out over several material files. When using several material files these must be name “[name]01.mat”, “[name]02.mat”, etc. Also the file text must be just “[name]”. So if the files are called “test01.mat”, “test02.mat”, etc it must say “test” in the file field. 
'''Animation length''' The number of seconds the animation lasts, if the particle lives longer than this time, the animation is looped. 
'''Sub Division''' This is used in order to animate individual particles (when using several files, the material for all particles are changed at the same time). It can also be used for more variety among particles. The sub divisoion is set up by specifying how the texture is to be split and then setting how the particles will be assigned to a sub division. The splitting is like this: [[File:subdiv.jpg]]
 
'''Sub Division Amount''' The number of divisons on each axis. 
'''Sub Division Type''' How the subdivisions are assigned to the particles. Random: A division is randomly picked. Animation: During the life time of an object it has all the subdivisions. Starting in the upper left corning and ending in the lower right. 

==3 Tutorials==
[[HPL1/Tutorials/Particles|See tutorial 4]] \\

HPL1/Glossary

2023-04-08T12:28:34Z

Iamrealife: /* File extensions */

HPL1/Glossary

2023-04-08T12:26:18Z

Iamrealife: /* General */

HPL1/Glossary

2023-04-08T07:51:42Z

Iamrealife: /* General */

This page explains words and terms which have a unique meaning to the engine.
==General==
{| class="wikitable"
|'''Static'''
|An in-game object which is used only for physics collissions. They can't be influenced by scripts nor be interacted with.
|-
|'''Entity'''
|An in-game object with configurable parameters and custom physics bodies.
|-
|'''Reference'''
|An item referencing a valid Entity file to be used within the game's engine. All entities in your 3D editor must begin with ''_ref_''
|-
|'''Item'''
|A type of entity which can be collected and added to the player's inventory.
|-
|'''Area'''
|Invisible in-game cuboid which marks 3D space. Used for a variety of things based on the type.
|-
|'''Script'''
|Written code which determines what happens in a map. This includes events, puzzles, music, and more.
|-
|'''Sticky'''
|Areas that act as glue towards entities in the game world. The entities will stay in place until interacted with again.
|-
|'''Link'''
|Start Locator for the player. This can also be a link between two Starting Positions in a single map.
|-
|'''Node'''
|Navigation points for character entities.
|-
|'''Portal'''
|Special type of handler for what room (or sector) is currently being rendered in-game. A way to optimize ones map better.
|}

==File extensions==
{| class="wikitable"
|'''*.hps'''
|[[HPL1/Script_Reference|Howard Phillip Script]], this is where you make the magic happen with the help of AngelScript.
|-
|'''*.ent'''
|[[HPL1/Content_Creation_Chapter_6|Entity]], objects that can be interacted with, these files can only be created manually.
|-
|'''*.hud'''
|[[HPL1/Content_Creation_Chapter_9|Heads-Up Display]], defines items that the player can wield and holster, these files can only be created manually.
|-
|'''*.ps'''
|[[HPL1/Editors/Particle_Editor|Particle System]], displays cool little effects like fog and electrical sparking etc.
|-
|'''*.bnt'''
|[[HPL1/Content_Creation_Chapter_3#3.12_Billboards|Billboard Entity]], gives your map a little more life with some lightrays and whatnot, these files can only be created manually.
|-
|'''*.snt'''
|[[HPL1/Content_Creation_Chapter_5#5.7_Sound|Sound Entity]], stores information on what audio file to play, how many audio files to play and whether or not they loop and so forth.
|-
|'''*.lang'''
|[[HPL1/Content_Creation_Chapter_5#5.8_Translation|Language]], contains in-game messages, item descriptions, etc.
|-
|'''*.beam'''
|[[HPL1/Content_Creation_Chapter_3#3.13_Beams|Beam]], defines things such as laser beams, these files can only be created manually.
|-
|'''*.cfg'''
|[[HPL1/Content_Creation_Chapter_7|Configuration]], used to define various settings.
|-
|'''*.mat'''
|[[HPL1/Content_Creation_Chapter_4|Material]], contains information on texture as well as the type used for it including transparency information.
|-
|'''*.lnt'''
|[[HPL1/Content_Creation_Chapter_3#3.3.4_Light_Entity_file|Light Entity]], an XML file that displys an image file to be casted by a spotlight in the game world.
|}

HPL1/Editors/Particle Editor

2023-03-31T16:56:29Z

Iamrealife:

=HPL1/Content Creation Chapter 6 HPL Particle Editor=

==1 Introduction==
This is the guide for the HPL-Particle editor which is a tool for creating various particle effects. 
===1.1 Min and Max values===
A lot of values in the editor have both a min and max. This means that when the value is set to a particle a value between min and max is randomly selected. 
===1.2 Fading===
Fading can be used to fade in and/or out some property like size or colour. The fading works like this. There are three relative values that are relative to the start value of the particle. The names for these values are start, middle and end and are used in that order. There are also two times that are relative to the life of the particle, for example if a particle has 2 seconds life time and the middle time is 0.5 then this occurs after 1 second (0.5 * 2). The first time is called middle time and this is when the start value is entirely faded from start to middle. The middle length is how long the middle value lasts. After middle time + middle length the middle value is faded to the end value. 
===1.3 File===
*New - Creates a new particle system and resets all the settings to default.
*Save - Saves your settings to the currently opened Particle System (*.ps) file.
*Save as... - Allows you to save your particle under a different name.
*Open - Lets you open particle files. 

===1.4 Emitters===
This section allows you to view a list of all the currently available emitters in your particle file as well as Add, Copy and remove emitters. 
===1.5 Room===
*Show Room - Here you can choose whether or not the Particle Viewer program should render a small room around the particle that you're currently viewing.
*Room size - This defines how large said room should be. Default settings are 6x6x6 
===1.6 Particle Viewer===
This program allows you to view your Particle by pressing the large and obvious Save and View Particle System button.

Left Mouse Button lets you move the view around and Middle Mouse Button zooms in and out. Pressing B toggles the bloom option. 

==2 Parameters==
===2.1. General===
'''Name''' The name of the emitter currently selected. 
'''Type''' Only Normal type can be used, Beam type was never implemented. 
'''Max Particles''' The maximum number of particles that can be alive at once. When this limit is reached no more particles willl be created. 
'''Particles per Second''' The number of particles per second that will be created. 
'''Start time offset''' Time offset in seconds before the emitter starts. 
'''Respawn dead particles''' If dead particles should be respawned. 
'''Warm up time''' Time that the emitter gets to warm up. This is useful when doing a a stream of something (like a fire or waterfall) and the particles should not be shown “starting up”. 
'''Pause''' A pause is a break during which no particles are created. Particles are updated though. 
'''Pause Length''' The length of the pauses, 0 and 0 means that there are no pauses. 
'''Pause Interval''' The length between pauses. 0 and 0 means that there are no pauses. 
'''Offset position''' How the emitter is offset relative to its starting positon. 
'''Offset angle''' How to particle system is offset relative to its start angles. 
===2.2 Rendering===
'''Draw Type''' The different ways in which the particles can be draw to screen. Point: The particle is a point and will always be pointing towards the camera. Line: The particle is aligned in the direction in which the particle is travelling. 
'''Multiply RGB with Alpha''' Some materials does not fade out the image when alpha is decreased (for example Additive) in this case it can be good to check this. 
'''Size''' The size of the particle. This is the value used in the fading. 
'''Size Fading''' See 1.2 for instructions on fading. 
===2.3 Collision===
'''Use Collision''' If collision detection should be used. 
'''Update Rate''' How many times a second collision is check for each particle. 
'''Maximum Collisions''' The maximum amount of collions can have before dying. 
'''Bounce Amount''' How much of the speed is retained when bouncing. 0.5 means half of the speed. 2 means that the speed doubles when bouncing. 
===2.4 Beam Specific===
This was meant to create and handle [[HPL1/Content_Creation_Chapter_3#3.13_Beams|Beam]] files, never implemented.

 

===2.5 Rotation===
'''Use Particle Spinning''' 
If enabled, particles will rotate around themselves. 
'''Spin Type''' 
Type for the particle spinning. Can be: 
'''Constant''' 
A value will be picked from the spin velocity range at random. 
'''Movement''' 
The rotation will be linked to how fast the particle is moving. 
'''Particle spin velocity range (rad/s)''' 
Spin velocity for constant spin type. About 6.283 radians is a single spin. 
'''Use Revolution''' 
If enabled, particles will rotate around some axis. 
'''Revolution Velocity (rad/s)''' 
3D Vector that will determine the axis and rotation speed for particles.

 

===2.6 Start===
'''Start type''' Sets what method to use to generate the start position of the particles in the emitter. 
'''Box start''' A box start is created using an x, y and z min and max value. The collection of particles will get the shape of a box. 
'''Sphere start''' The positions are generated using an angle interval and the min and max value for the radius. You can think of it like this; an arrow start pointing up. This arrow is then rotated around the X axis (red) using a value between min and max. After that the arrow is rotated by the y axis (blue). The arrow will now be pointing in a specific direction and in this direction a position is created at a distance from center according to a number generated from min/max radius. [[File:spherestart.jpg]]
 
===2.7 Color===
''NOTE: all of the colour channels have values from 0 -1.'' 
'''Color''' This sets the colour of the particle. 
'''Fading''' Settings for fading the colour. See chapter 1.2 for fading. 
===2.8 Movement===
'''Velocity type''' The way in which the starting velocity is generated. 
'''Box velocity''' The same as box start but with velocity instead. 
'''Sphere Velocity''' The same as sphere start but with velocity instead. 
'''Coord system''' The way in which the particles are related to the world and the object the system is attached to (if any). In world all the particles have an individual postion that does change depending on the parent object. In local however the particle position is dependant on the parent object so if that the particle moves and turns along with the parent. 
'''Uses direction''' If the direction of the start velocity depends on the way the particle system is “facing” (with no rotation it faces up). This is useful for systems like steam where the system has a direction. 
'''Gravity Type''' The type of gravity being applied to the particles. None: No gravity it applied. Vector: The gravity acceleration is applied. Centre: The particles are drawn towards the centre of the particle system with Gravity Acceleration Y as acceleration. 
'''Gravity Acceleration''' Used differently according by the gravity type. 
'''Acceleration''' Accleration applied to all bodies. 
'''Speed multiplier''' How much the speed is multiplied by each second. For example, 0.5 means that the speed halfed each second. 2 means it is doubled each second. 
'''Maximum speed''' The maximum speed that the particles can reach. 
===2.9 Life===
'''Lifespan''' Time in seconds that the particle will live. 
'''Death Type''' Type of death for the particles. Only Age can be selected. 
'''PS created at death''' Particle System to be spawned when the particle dies. Could be used to loop particle creations.
 

===2.10 Material===
'''File''' The material file to use. 
'''Number of Files''' The number of material files used. Normally this should just be one, but in some cases an animation needed is spread out over several material files. When using several material files these must be name “[name]01.mat”, “[name]02.mat”, etc. Also the file text must be just “[name]”. So if the files are called “test01.mat”, “test02.mat”, etc it must say “test” in the file field. 
'''Animation length''' The number of seconds the animation lasts, if the particle lives longer than this time, the animation is looped. 
'''Sub Division''' This is used in order to animate individual particles (when using several files, the material for all particles are changed at the same time). It can also be used for more variety among particles. The sub divisoion is set up by specifying how the texture is to be split and then setting how the particles will be assigned to a sub division. The splitting is like this: [[File:subdiv.jpg]]
 
'''Sub Division Amount''' The number of divisons on each axis. 
'''Sub Division Type''' How the subdivisions are assigned to the particles. Random: A division is randomly picked. Animation: During the life time of an object it has all the subdivisions. Starting in the upper left corning and ending in the lower right. 

==3 Tutorials==
[[HPL1/Tutorials/Particles|See tutorial 4]] \\

HPL1/Content Creation Chapter 6

2023-03-31T08:49:28Z

Iamrealife: /* 6.3.4 Type Door */

== 6 Entity files ==

=== 6.1 Intro ===
Entity files are XML files and before editing them it is suggested to read some quick tutorial on XML files. Only very basic XML understanding is needed to edit these files.

The files are divided into different sections, some sections are in all entity files and some are only present in certain entity types.

Make sure that the language is set to XML in Notepad++ when editing the Entity files.

The following values are used, note that all types have "" around the value:
{| class="wikitable sortable" border=1
| '''String''' || A string of letters. "MyName"
|-
| '''Float''' || A decimal number. "1.04"
|-
| '''Integer''' || A number without decimals "-15"
|-
| '''Vector''' || Three numbers in a row separated by space and/or commas: "1, 1, 1".
|-
|}
 

==== 6.1.1 Entity Types====
Several different entity types have been created to simplify the creation of often used objects such as doors, lights and buttons. Much of the special entity functionality can be scripted in the .hps file for a level, but using special entities you can easily make an entity that can be imported to a level and have full functionality from the start. These entity types have extra settings mainly set in the <GAME/> section of the entity files. The specific settings for each entity type is described in [[#game.section|Chapter 6.3]].

Types are edited as described in [[#main|Chapter 6.2.1]].

The following entity types are available:
{| class="wikitable sortable" border=1
| Type || Subtype ||
|-
| '''Object''' || '''Normal''' || Regular objects with no specific function. Examples: Wooden box, rock
|-
| '''Enemy''' || '''"EnemyName"''' || Enemy entities, these have a very extended <GAME/> section. "EnemyName" = Worm, Dog, Spider. ''This entity type is somewhat limited as to what sort of enemies have been in Penumbra.''
|-
| '''SwingDoor''' || '''Normal''' || Doors and objects with door like features. Examples: All regular doors that swing open, can also be used with success to create coffins, cupboards etc. A SwingDoor is easy to lock, unlock, make it breakable etc
|-
| '''Item''' || '''Normal''' || Item is an entity type that will be added to the players inventory. Normal is used for all regular items like keys, puzzle items and such. Basically an item that you want to be added to the inventory and that the player can then combine with another item, use on an item or some other basic item usage.
|-
| '''Item''' || '''Battery''' || Item is an entity type that will be added to the players inventory. Battery is added to the energy meter.
|-
| '''Item''' || '''Dynamite''' || Item is an entity type that will be added to the players inventory. Dynamite is is for... an object that will be thrown, explode and inflict damage.
|-
| '''Item''' || '''Health''' || Item is an entity type that will be added to the players inventory. Health is an item that can be "eaten".
|-
| '''Item''' || '''Flare''' || Item is an entity type that will be added to the players inventory. Flare is an item that will be active in the players hand for a certain amount as configured in config/game.cfg.
|-
| '''Door''' || '''Normal''' || A door entity that contains animations, not used in the Tech Demo/Overture but is there and functional. Examples: Star Trek doors that slide open etc...
|-
| '''DoorPanel''' || '''Normal''' || A panel entity that is easily connectable to Door, enabling interacting with the panel to open/close door.
|-
| '''Lamp''' || '''Normal''' || Item is an entity type for creating an object with an easy to control light source. Examples: desk lamp, ceiling light, control panel with lights, a machine with lights.
|-
| '''Button''' || '''Normal''' || An entity that will easily control other entities. Examples: switch to turn on/off ceiling lights.
|-
| '''Lever''' || '''Normal''' || An entity that is a lever and as such can easily trigger events when pulled, can also be locked and unlocked.
|-
| '''Wheel''' || '''Normal''' || Not done, an entity that can be rotated several times and easily read out and trigger events based on that.
|-
|}
 

=== 6.2 General sections ===
The following sections are present in most entity files used and are part of engine standards. Some extra options will also be mentioned that are not apart of the standard and game specific.
 
==== 6.2.1 Main ====
This section exist in all entity files.

{| class="wikitable sortable" border=1
| '''Name''' || The name of the entity type. ''String''.
|-
| '''Type''' || The root type that is entity is. ''String''.
|-
| '''Subtype''' || This is a subtype of the root type. For example the enemy type. ''String''.
|-
|}
 

==== 6.2.2 Physics ====
This section deals with the physical properties of an entity. For entities that have joints there are several versions of this section. One for each body connected with joints.

{| class="wikitable sortable" border=1
| '''SubName''' || When entities with joints are used this is the name of the body. This should be the SHAPE name and not the node name! (i.e. pCube1Shape and not pCube1). ''String''.
|-
| '''CollideCharacter''' || If the body collides with character bodies. ''Boolean''.
|-
| '''Collides''' || If the entity colldies with the world. ''Boolean''.
|-
| '''HasPhysics''' || If the physics are to be simulated. ''Boolean''.
|-
| '''StaticMeshCollider''' || If a submesh should be used as a collider, mass must be 0. ''Boolean''.
|-
| '''ColliderMesh''' || The name of the submesh used for StaticMeshCollider. This should be the SHAPE name and not the node name! (i.e. pCube1Shape and not pCube1). ''String''.
|-
| '''Material''' || The name of the material used. ''String''.
|-
| '''Mass''' || The mass of the body in kg. ''Float''.
|-
| '''InertiaScale''' || Scale the inertia of the object (this is how easy it rotates). Should be “1 1 1” in most cases. ''Vector''.
|-
| '''AngularDamping''' || Damping can be described has air friction. 1 is max friction and 0 is no fricton at all. Anglular means that this is the friction on the spinning motion of the entity, the more friction that faster it will stop spinning. Valid values are 0.0001 – 1.0, normally "0.1" is used. ''Float''.
|-
| '''LinearDamping''' || The same as Angular damping but on the movement instead of spinning motion. The more friction the faster the entity will stop moving. ''Float''.
|-
| '''BlocksSound''' || This body will make sound lower if the camera is behind it. ''Boolean''.
|-
| '''HasGravity''' || If the body has gravity or not. ''Boolean''.
|-
| '''MaxLinearSpeed''' || The maxium linear (up,down, right, left, etc) speed in m/s the body can have. 0 = unlimited speed. ''Float''.
|-
| '''MaxAngularSpeed''' || The maxium angular (rotation) speed in m/s the body can have. 0 = unlimited speed. ''Float''.
|-
| '''ContinuousCollision''' || 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. ''Boolean''.
|-
| '''PushedByCharacterGravity''' || If the body will be affected when a characters stands on top. ''Boolean''.
|-
| '''PauseGravity''' || If gravity should be removed during interaction. ''Boolean''.
|-
| '''AutoDisableLinearThreshold''' || Square of the min linear speed before body is disabled. Default 0.1 ''Float''.
|-
| '''AutoDisableAngularThreshold''' || Square of the min angular speed before body is disabled. Default 0.1 ''Float''.
|-
| '''AutoDisableNumSteps''' || Min steps of required speeds before the body is disabled. Default 10 ''Int''.
|-
| '''Volatile''' || If a body might disappear or for some reason leave the way open for AI. Only needed on mass 0. Default false ''Boolean''.
|-
| '''CanAttachCharacter''' || 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. Default false ''Boolean''.
|-
|}
 

==== 6.2.3 Graphics ====
This section set the graphical appearance of the entities.

{| class="wikitable sortable" border=1
| '''ModelFile''' || The name of the model file. No extension needed. ''String.''
|-
| '''CastShadows''' || Sets if the entity casts shadows or not. ''Boolean.''
|-
| '''AnimationLoop''' || If the start animation should be looped or not. ''Boolean.''
|-
| '''AnimationRandStart''' || If the start animation should start at a random location, false starts always at 0 and true starts randomly between 0 and length of animation. ''Boolean.''
|-
|}
 
==== 6.2.4 Submesh ====
A submesh section is created for each submesh in the mesh.

{| class="wikitable sortable" border=1
| '''Name''' || Name of the geometry for the submesh. ''String''.
|-
| '''MaterialFile''' || Sets a new material for the submesh. If not the defined the one in the model is used. ''String''.
|-
|}
 
==== 6.2.5 Attach Billboards ====
The section contains info on how to attach billboards to lights, the styntax is as follows:

<syntaxhighlight lang="xml">
<ATTACH_BILLBOARDS>
<Pair Light="rampspot1" Billboard="rampbb1" >
[more pairs]
</ATTACH_BILLBOARDS>
</syntaxhighlight>

{| class="wikitable sortable" border=1
| '''Light''' || The name of the light to add the billboard to.
|-
| '''Billboard''' || The name of the billboard to be added.
|-
|}
 

==== 6.2.6 Animation ====
The animation is used to give an object more than one animation. The model file defined by ModelFile in Graphics will be the main file (for more information, see 2.2). The syntax is the following for adding animations:

<syntaxhighlight lang="xml">
<ANIMATIONS>
<Animation [properties]>
[…]
</ANIMATIONS>
</syntaxhighlight>

The properties for each animation field are the following:

{| class="wikitable sortable" border=1
| '''File''' || The model file that contains the animation. ''String''.
|-
| '''Name''' || The name the animation will have ingame. ''String''.
|-
| '''Speed''' || The speed of the animation in percent /100. 1 = normal speed, 0.5 = half speed, 2 = double speed. ''Float''.
|-
| '''SpecialEventTime''' || Generic variable that is game dependant. Should signify some event happening in the animation ''Float''.
|-
|}

Example:

<syntaxhighlight lang="xml">
<GRAPHICS
ModelFile = “test.dae”
/>
</syntaxhighlight>

Test.dae will be the main file, it is in this file colliders and such must be.

<syntaxhighlight lang="xml">
<ANIMATIONS>
<Animation File=”test_run.dae” Name=”Run” Speed=”1”>
<Animation File=”test_jump.dae” Name=”Jump” Speed=”1”>
</ANIMATIONS>
</syntaxhighlight>

This will add the animations “test_run.dae” and “test_jump.dae” and will name them “Run” and “Jump” in game. These files should not have colliders and such. 
It's also possible to add events to an animation. Currently it's only used to add in sounds for an animation. See below example.

<syntaxhighlight lang="xml">
<ANIMATIONS>
<Animation File=”test_run.dae” Name=”Run” Speed=”1” >
<Event Time="0.1" Type="PlaySound" Value="name_of_snt_file"/>
</Animation>
</ANIMATIONS>
</syntaxhighlight>

The properties for each event field are the following:

{| class="wikitable sortable" border=1
| '''Time''' || At what time in the animation to do the event. ''String''.
|-
| '''Type''' || What type, currently on PlaySound is available. ''String''.
|-
| '''Value''' || The name of the file to use for the event, for PlaySound that is what sound entity file to use. ''String''.
|-
|}
 

==== 6.2.7 Joint ====
{| class="wikitable sortable" border=1
| '''Name''' || This is the name of the joint and is the same as the '''name parameter'''. If the joint is like this: '''_joint_hinge_test_test_10_20_MyJoint''' Then “MyJoint” is the name to use. ''String''.
|-
| '''MinValue''' || Min limit value for joint, depends on joint type and overrides previous value if defined. ''Integer''.
|-
| '''MaxValue''' || Max limit value for joint, depends on joint type and overrides previous value if define. ''Integer''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MaxLimit_Sound''' || The sound played when reaching the max limit. ''String''.
|-
| '''MaxLimit_MinSpeed''' || The minimum speed for the sound to be played. ''Float''.
|-
| '''MaxLimit_MaxSpeed''' || At this speed the sounds stops getting louder. ''Float''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MinLimit_Sound''' || The sound played when reaching the min limit. ''String''.
|-
| '''MinLimit_MinSpeed''' || The minimum speed for the sound to be played. ''Float''.
|-
| '''MinLimit_MaxSpeed''' || At this speed the sounds stops getting louder.''Float''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MoveSound''' || The sound played when the joint objects are moving. ''String''.
|-
| '''MoveType''' || The type of movement that the speed will be determined from, this can be “Linear” or “Angular”. This is up/down/left/etc movement and rotation respectively. ''String''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MinMoveSpeed''' || The minimum speed in m/s at which sound is heard. Valid values are 0 – infinity. ''Float''.
|-
| '''MinMoveFreq''' || The lowest frequency played from the sound. Valid values are 0 – infinity. ''Float''.
|-
| '''MinMoveVolume''' || The lowest volume played. . Valid values are 0 – 1. ''Float''.
|-
| '''MinMoveFreqSpeed''' || The speed (and below) at which MinMoveFreq and MinMoveVolume is played. 0 – infinity. ''Float''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MaxMoveFreq''' || The highest frequency played from the sound. Valid values are 0 – infinity. ''Float''.
|-
| '''MaxMoveVolume''' || The loudest volume played. . Valid values are 0 – 1. ''Float''.
|-
| '''MaxMoveFreqSpeed''' || The speed (and above) at which MaxMoveFreq and MaxMoveVolume is played. 0 – infinity. ''Float''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''MiddleMoveSpeed''' || The Speed at which frequency is 1 and MiddleMoveVolume. ''Float''.
|-
| '''MiddleMoveVolume''' || The middle volume. ''Float''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''Breakable''' || If the joint should break if enough force is applied to it. ''Boolean''.
|-
| '''BreakForce''' || The minimum force for the joint to break. 0 – inf. ''Float''.
|-
| '''BreakSound''' || The sound played when the joint breaks. ''String''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''LimitAutoSleep''' || If there should be extra autosleep at limits. ''Boolean''.
|-
| '''LimitAutoSleepDist''' || The distance at which the sleep occurs. 0 – inf. ''Float''.
|-
| '''LimitAutoSleepNumSteps''' || The number of steps need for the sleep to start. 0 – inf. ''Int''.
|-
|}
{| class="wikitable sortable" border=1
|-
| '''StickyMaxDistance''' || The distance from max limit that the body is stopped. 0 = disabled. (this is in radians for hinge). ''Float''.
|-
| '''StickyMinDistance''' || The distance from min limit that the body is stopped. 0 = disabled. (this is in radians for hinge). ''Float''.
|-
|}
 

==== 6.2.8 Joint Controller ====
The Joint may also contain one or more Controllers. Controllers are used for controlling a body in some way. This maybe used to keep the body at a certain orientation or at a certain speed. This can simulate things like spinning fans and levers that go back to a certain position when released.

A demo of a Pid controller can be found in the Pid Demo folder.

'''Note''' that only the child body of the joint is affected by the controller, '''not''' the parent.

A controller is defined like this:

<syntaxhighlight lang="xml">
<Controller
[properties]
/>
</syntaxhighlight>

And resides inside the joint tag, like:

<syntaxhighlight lang="xml">
<JOINT>
<Controller />
<Controller />
[continues for as many controllers are needed]
</JOINT>
</syntaxhighlight>

At its basics a controller is a machine that gets an input and generates an output. The input could be the distance from a goal and the output could be a speed. This would create a controller that lowers the speed of an object as it gets closer to its goal. To control the amount of speed at a certain distance some constants are used. In most cases these the will make the relationship between input and output vary in a linear fashion, i.e. at half the distance the speed is at 50%, at 1/4th the distance 25% and so on.

There are two types of controllers. “Spring” and “Pid” these work in about the same way but can produce very different results.

'''Spring''' This is probably the easiest type to understand. It is controlled by the formula: 
'''Output = (DesiredValue – Input) * k – Input * b''' 
The first part of the equation is used to control the output needed to reach the desired value. As you see the higher difference between desired value and input (called error) the higher output. The second part of the equation is used to make the output smaller if input gets too large. For example at a long distance you don’t want have too large speed. (Normally the same input is not used for the first and second part, but this is a simplified spring.)

'''Pid''' A Pid is a little harder to describe than a spring. It consists of 3 constants; p, i and d. These are part of an equation but is better to explain what the 3 constants do instead of describing the equation used.
{| class="wikitable sortable" border=1
| '''p''' || This is the proportional constant and works exactly like the first part of the spring formula. The higher it is, the higher the output generated will be. This has most influence over the generated output.
|-
| '''i''' || This is the integral term and can be said to be a memory of the previous errors. The greater the previous errors have been the greater affect this will have on the output. This is good to use if the input/output gets in a steady state (the output makes no change on the input) often, this state will make the old errors the same and thus it will increase the output by this term.
|-
| '''d''' || This is the derivative term and it is change in error. The term normally work negative on the output and is used to dampen the output when it is closing in too fast. The result will be that the desired valued is not over shot but instead reached in a smooth matter. The higher the term the more negative impact on the output when the error difference gets lower. This term will also give an extra boost to the output if the error difference gets higher (input gets further away from the desired value).
|-
|}

The properties are as follows:

{| class="wikitable sortable" border=1
| '''Name''' || The name of the controller. ''String''.
|-
| '''Active''' || If the controller is active or not. ''Boolean''.
|-
| '''Type''' || The type of the controller. “Pid” or “Spring”.
|-
| '''A''' || p-term for Pid and k term for Spring. ''Float''.
|-
| '''B''' || i-term for Pid and b term for Spring. ''Float''.
|-
| '''C''' || d-term for Pid and not used in springs. ''Float''.
|-
| '''IntegralSize''' || The number of errors saved for the integral term. 1 – inf. ''Integer''.
|-
| '''Input''' || The type of input. "JointAngle", "JointDist","LinearSpeed" or "AngularSpeed".
|-
| '''InputAxis''' || The axis of the input (use “X” joint inputs). “X”,”Y” or “Z”.
|-
| '''DestValue''' || The desired value for input. ''Float''.
|-
| '''Output''' || The output type. “Force” or “Torque”. (Torque is for rotation.)
|-
| '''OutputAxis''' || The axis of the output. “X”,”Y” or “Z”.
|-
| '''MaxOutput''' || The maximum output. 0 – infinity. 0 equals infinity (no upper limit). ''Float''.
|-
| '''MulMassWithOutput''' || If the output should be multiplied with the body’s mass before being used. ''Boolean''.
|-
| '''EndType''' ||
|-
|}
This defines what is the end of the controller. When this happens the motor will become non active and another controller (if specified) will be active instead. This can be “Null”, “OnMax”, “OnMin” or “OnDest”. Null: No end. OnMax: The max limit of the joint is reached. OnMin: The min limit of the joint is reached. OnDest: DestValue is reached.
{| class="wikitable sortable" border=1
| '''NextController''' || The controller that will be activated when the end (specified in EndType) of this controller is reached.
|-
| '''LogInfo''' || If the controller should write debug info to the log, default is false. ''Boolean''.
|-
|}
 

==== 6.2.9 Light ====
The light section can be used to change the properties to lights in a model, if section not present the values from the model will be used.

<syntaxhighlight lang="xml">
<LIGHT>
Name = "pointLight1"
[…]
</LIGHT>
</syntaxhighlight>

{| class="wikitable sortable" border=1
| '''Name''' || The name of the light to change values for. ''String''.
|-
| '''CastShadows''' || Should the light cast a shadow or not. ''Boolean''.
|-
| '''Attenuation''' || The size of the light in meters. ''Float''.
|-
| '''Color''' || The color of the light, "R G B A". ''Vector4''.
|-
| '''FOV''' || How quickly the radius of the light increases, as degree. '''Only for spotlights.''' ''Float''.
|-
| '''Aspect''' || The difference between width and height increase set by the FOV, example: Aspect 1.5 for FOV 90 gives width=135 and height=90. '''Only for spotlights.''' ''Float''.
|-
|}
 

=== 6.3 Game Section ===

The game section of an entity file is the section that contains the most interesting properties, is in this section where the different types have all their specific settings.

The game section is defined like this:

<syntaxhighlight lang="c++">
<GAME
InteractMode = “Static”
[...] Other settings
/>
</syntaxhighlight>

In it you add all the specifics for the different entity types as well as the standard features that are present in most entities. All settings are written '''Setting = "The Value"''', it uses " " regardless of int, float, string, boolean. 

==== 6.3.1 Game Section General ====
These settings are usable in all entities, there might be some that only work for a certain type or some that work against each other. Overall should be no problem and nothing to risk by trial and error.

{| class="wikitable" border=1
!Name !!Type !!Default !!Description
|-
| '''InteractMode''' || ''String'' || Static || Different modes for when you interact with the object, additional specific information see below for details. "Static", "Grab", "Move", "Push".
|-
| '''ForwardUpMul''' || ''Float'' || 1 || MoveMode: Multiplied to the forward/backward force when moving the mouse up/down.
|-
| '''UpMul''' || ''Float'' || 1 || MoveMode: Multiplied to the up/down force when moving the mouse up/down.
|-
| '''RightMul''' || ''Float'' || 1 || MoveMode: Multiplied to the right/left force when moving the mouse right/left.
|-
| '''PickAtPoint''' || ''Bool'' || False || GrabMode: Should the object be picked that point the mouse is.
|-
| '''RotateWithPlayer''' || ''Bool'' || True || GrabMode: Should the object rotate along with the player.
|-
| '''UseNormalMass''' || ''Bool'' || False || GrabMode: Should the object's normal mass be used.
|-
| '''GrabMassMul''' || ''Float'' || 1 || GrabMode: Multiplied to the force applied to the object.
|-
| '''MaxInteractDist''' || ''Float'' || additional specific information Depends || The maximum length at which the object can be interacted with.
|-
| '''PauseControllers''' || ''Bool'' || || MoveMode: Should controllers be paused when interacting.
|-
| '''DamageCharacter''' || ''Bool'' || False || Should the characters take damage from the object.
|-
| '''MinLinearDamageSpeed''' || ''Float'' || 0 || Minimum linear speed at which damage is dealt.
|-
| '''MinAngularDamageSpeed''' || ''Float'' || 0 || Minimum angular speed at which damage is dealt.
|-
| '''MaxLinearDamageSpeed''' || ''Float'' || 0 || Maximum linear speed at which damage stops getting higher.
|-
| '''MaxAngularDamageSpeed''' || ''Float'' || 0 || Maximum angular speed at which damage stops getting higher.
|-
| '''MinDamage''' || ''Float'' || 0 || Damage dealt at minium speed.
|-
| '''MaxDamage''' || ''Float'' || 0 || Damage dealt at maximum speed.
|-
| '''DamageStrength''' || ''???'' || ??? || ???.
|-
| '''Destroyable''' || ''Bool'' || false || If enemies can destroy all joints conneced to the body.
|-
| '''Toughness''' || ''Int'' || 0 || Thoughness of entity.
|-
| '''DestroyStrength''' || ''Float'' || 0 || Mimimum strength of the enemy to destroy the body.
|-
| '''DestroySound''' || ''String'' || "" || The sounds played when the object is destroyed.
|-
| '''LightFlash''' || ''Bool'' || "" || If a ligth flash should be displayed on destruction.
|-
| '''LightFlash_Color''' || ''Color'' || "R G B A" || Color of flash.
|-
| '''LightFlash_Radius''' || ''Float'' || 0 || Radius of flash.
|-
| '''LightFlash_AddTime''' || ''Float'' || 0 || The time it takes for falsh to expand.
|-
| '''LightFlash_NegTime''' || ''Float'' || 0 || The time it takes for falsh to contract.
|-
| '''LightFlash_Offset''' || ''Vector3'' || 0 || The offset from the object position.
|-
| '''CanBeThrown''' || ''Bool'' || True || Sets if an object can be thrown.
|-
| '''AttractEnemies''' || ''Bool'' || False || If the object will attract enemies to it.
|-
| '''AttractDistance''' || ''Float'' || 0 || The distance at which the attraction works.
|-
| '''AttractSubtypes''' || ''String Vector'' || " " || A string vec of the subtypes of enemies that are attraced. ie: "Dog Spider".
|-
| '''AttractIsEaten''' || ''Bool'' || False || If the object is eaten once reached by the enemy.
|-
| '''AttractEatLength''' || ''Float'' || 0 || The time it takes for the object to be eaten.
|-
| '''CanBePulled''' || ''Bool'' || True || If an object with InteractMode Push can be pulled as well.
|-
| '''ForceLightOffset''' || ''Bool'' || False || If light should have an extra offset in absolute world coords.
|-
| '''LightOffset''' || ''Vector3'' || 0 0 0 || Extra light offest.
|-
| '''DisappearMinCloseDist''' || ''Float'' || 0 || When below this distance to another eneity of the same type, disappera instantly. 0 = off.
|-
|}

===== 6.3.1.1 Additional specific information =====
{| class="wikitable" border=1
!Interact Modes !!Description
|-
| '''Static''' || Nothing happens when you interact, example: ceiling light, large machine run by control panel.
|-
| '''Grab''' || Used to grab and move around objects, exampel: small rocks, bottles.
|-
| '''Move''' || Used to interact and move objects. These should be stuck onto something, example: a furniture door.
|-
| '''Push''' || Used to push around larger objects, example: crates, barrels.
|-
|}
{| class="wikitable" border=1
!MaxInteractDist!!Description
|-
| '''Grab''' || Default value: 1.5.
|-
| '''Move''' || Default value: 1.4.
|-
| '''Push''' || Default value: 1.5.
|-
|}

 

==== 6.3.2 Type Lamp ====

{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''InteractDist''' || ''Float'' || ??? || Max distance you can interact with the lamp.
|-
| '''TurnOnTime''' || ''Float'' || 1 || Time for fade when turning on.
|-
| '''TurnOffTime''' || ''Float'' || 1 || Time for fade when turning off.
|-
| '''InteractOff''' || ''Bool'' || ??? || If you can interact to turn off.
|-
| '''InteractOn''' || ''Bool'' || ??? || If you can interact to turn on.
|-
| '''TurnOnSound''' || ''String'' || " " || Sound played when turning on.
|-
| '''TurnOffSound''' || ''String'' || " " || Sound played when turning off.
|-
| '''OnItem''' || ''String'' || " " || Item used to turn on, if " " then normal interaction works.
|-
| '''OffItem''' || ''String'' || " " || Item used to turn off, if " " then normal interaction works.
|-
| '''OffMaterial''' || ''String'' || " " || Material used when off.
|-
| '''OffSubMesh''' || ''Float'' || " " || Sub mesh to change material on when off.
|-
| '''OffColor''' || ''Vector'' || "R G B A" || The color of the light when off, 0 0 0 = black.
|-
|}
{| class="wikitable sortable" border=1
! !! !! !!
|-
| '''Flickering''' || ''Bool'' || False || Flickering active or not see the following options.
|-
| '''FlickerOffSound''' || ''String'' || " " || The sound to play when flickering off.
|-
| '''FlickerOnSound''' || ''String'' || " " || The sound to play when flickering on.
|-
| '''FlickerOffPS''' || ''String'' || " " || The particle effect to use when flickering off.
|-
| '''FlickerOnPS''' || ''String'' || " " || The particle effect to use when flickering on.
|-
| '''FlickerOnMinLength''' || ''Float'' || ??? || Minimum time the light will be on.
|-
| '''FlickerOnMaxLength''' || ''Float'' || ??? || Maximum time the light will be on.
|-
| '''FlickerOffMinLength''' || ''Float'' || ??? || Minimum time the light will be off.
|-
| '''FlickerOffMaxLength''' || ''Float'' || ??? || Maximum time the light will be off.
|-
| '''FlickerOffColor''' || ''Vector'' || "R G B A" || The color of the light when off, 0 0 0 = black.
|-
| '''FlickerOffRadius''' || ''Float'' || ??? || The radius of the light when off during a flicker.
|-
| '''FlickerFade''' || ''Bool'' || False || If it should fade between on and off.
|-
| '''FlickerOnFadeLength''' || ''Float'' || ??? || How long the fade should be when going to on.
|-
| '''FlickerOffFadeLength''' || ''Float'' || ??? || How long the fade should be when going to off.
|-
|}
 
==== 6.3.3 Type SwingDoor ====
Entities with a door that swings open. There are some rules: - May only have hinge joints - Must open towards positive Z-axis. 
{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''Health''' || ''float'' || 0 || The health of the door, the door will be breakable this way.
|-
| '''Toughness''' || ''int'' || 0 || The toughness of the door, depending on toughness of the attacking entity the door will or will not take damage.
|-
|}
 

==== 6.3.4 Type Door ====
Door is an old entity type that was added even before the tech demo. It's a door that uses animations to open and close, and when closed it can block portals making it a good optimization tool in crowded areas.

The Door entity needs 4 animations named: Opening, Open, Closing and Closed. It's an opening animation, the static open look, the closing animation and the static closed door. See [[HPL1/Content_Creation_Chapter_2#2.2_Animations|Chapter 2.2]] for more details on animations.

<syntaxhighlight lang="c++">
<ANIMATIONS>
<Animation File="door_model_opening.dae" Name="Opening" Speed="1.0" />
<Animation File="door_model_closed.dae" Name="Closed" Speed="1.0" />
<Animation File="door_model_closing.dae" Name="Closing" Speed="1.0" />
<Animation File="door_model_open.dae" Name="Open" Speed="1.0" />
</ANIMATIONS>
</syntaxhighlight>

{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''OpenStartSound''' || ''String'' || " " || Sound Played when started opening.
|-
| '''OpenLoopSound''' || ''String'' || " " || Sound Looped when opening.
|-
| '''OpenStopSound''' || ''String'' || " " || Sound Played when stopped opening.
|-
| '''OpenLoopStartFadeSpeed''' || ''Float'' || 1 || Fade in speed of loop sound.
|-
| '''OpenLoopStopFadeSpeed''' || ''Float'' || 1 || Fade out speed of loop sound.
|-
| '''CloseStartSound''' || ''String'' || " " || Sound Played when started closing.
|-
| '''CloseLoopSound''' || ''String'' || " " || Sound Looped when closing.
|-
| '''CloseStopSound''' || ''String'' || " " || Sound Played when stopped closing.
|-
| '''CloseLoopStartFadeSpeed''' || ''Float'' || 1 || Fade in speed of loop sound.
|-
| '''CloseLoopStopFadeSpeed''' || ''Float'' || 1 || Fade out speed of loop sound.
|-
| '''OpenWhenBlocked''' || ''Bool'' || False || If the door should openitself if blocked. For example, place a box in the gap to bounce doors open on collide.
|-
| '''BlockPortals''' || ''Bool'' || True || If the door blocks portals when closed.
|-
|}
 

==== 6.3.5 Type DoorPanel ====
An Entity that is an object that the player can interact with to trigger the Door entity. They require a certain naming that needs to be looked into, it's a sort of lost knowledge as it has never been used beyond early testing... 
{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''ChangeWhileMoving''' || ''Bool'' || False || If the door can have its state changed while it is moving.
|-
|}
 

==== 6.3.6 Type Button ====

{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''InteractDist''' || ''Float'' || ??? || Max interaction distance.
|-
| '''InteractOff''' || ''Bool'' || ??? || If you can turn off by interacting.
|-
| '''InteractOn''' || ''Bool'' || ??? || If you can turn on by interacting.
|-
| '''TurnOnSound''' || ''String'' || " " || Sound played when turning on.
|-
| '''TurnOffSound''' || ''String'' || " " || Sound played when turning off.
|-
| '''TurnOnAnimation''' || ''String'' || " " || Animation played when turning on.
|-
| '''TurnOffAnimation''' || ''String'' || " " || Animation played when turning off.
|-
| '''OffMaterialName''' || ''String'' || " " || Material used when turned off.
|-
| '''OffSubMesh''' || ''String'' || " " || Sub mesh that material is switch on (if OffMaterialName != "").
|-
|}

 

==== 6.3.7 Type Wheel====

{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''InteractDist''' || ''Float'' || 1.8f || Max interaction distance.
|-
| '''MinLimit''' || ''Float'' || 0 || Min limit of wheel (should be negative).
|-
| '''MaxLimit''' || ''Float'' || 0 || Max limit of wheel (should be postive).
|-
| '''MinSound''' || ''String'' || " " || Sound played at min.
|-
| '''MaxSound''' || ''String'' || " " || Sound played at max.
|-
| '''StuckAtMin''' || ''Bool'' || false || If it gets stuck at min.
|-
| '''StuckAtMax''' || ''Bool'' || false || If it gets stuck at max.
|-
| '''SpinDir''' || ''int'' || 0 || 0=both dirs, 1=to max, -1=to min.
|-
| '''PauseControllers''' || ''bool'' || true || if controllers should be paused during player interaction.
|-
|}
 
==== 6.3.8 Type Enemy ====

 

===== 6.3.8.1 Enemy Dog =====
An enemy that can take care of itself.

'''Needs animations for:'''
* Standing still, named: Idle
* Walking forwards, named: Walk
* Walking backwards, named: Backward
* Running, named: Run
* Eating, named: Eating
* Attacking high, named: Attack
* Rise right after knocked, named: RiseRight
* Rise left after knocked,, named: RiseLeft
* Attacking a door to break it, named: BreakDoor
* Calling for backup, named: Howl
* Attacking low, named: AttackLow
* Seeing player and waiting to attack, named:Angry
 
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''ShowDebug''' || ''Bool'' || Displays additional informaiton on the screen about the enemy and it's behavior, useful to check path nodes etc.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''Disappear''' || ''Bool'' || If the enemy should disappear on death.
|-
| '''DisappearMinTime''' || ''Float'' || The minimum of time before disappearing.
|-
| '''DisappearMaxTime''' || ''Float'' || The maximum of time before disappearing.
|-
| '''DisappearMinDistance''' || ''Float'' || The minimum of distance from player to disappear.
|-
| '''DisappearPS''' || ''String'' || Particle effect to display on disappearing.
|-
| '''DisappearSound''' || ''String'' || Sound to play on disappearing.
|-
| '''DisappearFreezesRagdoll''' || ''Bool'' || If the Ragdoll should turn static or remain active on diseappering.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''CloseMusic''' || ''String'' || The music to play when enemy close to player.
|-
| '''CloseMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
| '''CloseMusicStartDist''' || ''Float'' || At what distance the music should start playing.
|-
| '''CloseMusicStopDist''' || ''Float'' || At what distance the music should stop playing.
|-
| '''AttackMusic''' || ''String'' || The music to play when enemy enters attack mode.
|-
| '''AttackMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''MaxPushMass''' || ''Float'' || The maximum mass of an object that the enemy can move.
|-
| '''PushForce''' || ''Float'' || At what force an emeny pushes an object.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''MaxHealth''' || ''Float'' || The maximum health on an enemy, regenerates other time. 100 = players health.
|-
| '''MaxSeeDist''' || ''Float'' || The maximum distance that the enemy can spot the player.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''MaxForwardSpeed''' || ''Float'' || Maximum forward speed of enemy, default 1.
|-
| '''Acceleration''' || ''Float'' || Acceleration speed.
|-
| '''Deacceleration''' || ''Float'' || Deceleration speed.
|-
| '''StoppedToWalkSpeed''' || ''Float'' || How long to go from halt to walk.
|-
| '''WalkToStoppedSpeed''' || ''Float'' || How long to go from walk to halt.
|-
| '''WalkToRunSpeed''' || ''Float'' || How long to go from walk to run.
|-
| '''RunToWalkSpeed''' || ''Float'' || How long to go from run to walk.
|-
| '''MoveAnimSpeedMul''' || ''Float'' || Speed multiplier for the animations, to sync the animation to the movement speed.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''BodySize''' || ''Vector3'' || The size of the body.
|-
| '''BodyMass''' || ''Float'' || The mass of the body.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''ModelOffset_Rot''' || ''Vector3'' || Rotating offset for the model.
|-
| '''ModelOffset_Pos''' || ''Vector3'' || Position offset for the model.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''AlignToGroundNormal''' || ''Bool'' || If the body should align to the ground as the ground changes angel.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''HitPS''' || ''String'' || Particle effect to be played at point of impact on enemy.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''MinKnockDamage''' || ''Float'' || The minimum damage where the enemy might be knocked over.
|-
| '''CertainKnockDamage''' || ''Float'' || The amount of damage where the enemy will always be knocked over.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''LengthBodyToAss''' || ''Float'' || Who knows... (Hahaha wtf)
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''IdleFOV''' || ''Float'' || Field of view for enemy when idle.
|-
| '''IdleFoundPlayerSound''' || ''String'' || Sound for enemy spotting the player.
|-
| '''IdleMinSeeChance''' || ''Float'' || Minimum chance of enemy seeing player. 0 never 1 always, 0.x the chance.
|-
| '''IdleMinHearVolume''' || ''Float'' || Minimum chance of enemy hearing the player. 0 never 1 always, 0.x the chance.
|-
| '''IdleSound''' || ''String'' || Sound to be played at random intervals.
|-
| '''IdleSoundMinInteraval''' || ''Float'' || Minimum time between each time it plays the idle sound.
|-
| '''IdleSoundMaxInteraval''' || ''Float'' || Maximum time between each time it plays the idle sound.
|-
| '''IdleCallBackupChance''' || ''Float'' || Chance of the enemy running away and calling for backup, 0 never 1 always, 0.x the chance.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''InvestigateSound''' || ''String'' || Sound to be played when enemy hears or sees something worth investigating.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''AttentionSound''' || ''String'' || Sound to be played when the enemy sees player and goes into attention.
|-
| '''AttentionTime''' || ''Float'' || For how long the enemy will stay in attention, if player moves out of sight before end enemy will go back.
|-
| '''AttentionMinDist''' || ''Float'' || Minimum distance for attention to happen, if enemy within this distance it will go to attack directly.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''HuntFOV''' || ''Float'' || Field of view for enemy when in hunt mode.
|-
| '''HuntSpeed''' || ''Float'' || At what speed the enemy moves when in hunt mode.
|-
| '''HuntForLostPlayerTime''' || ''Float'' || For how long will enemy continue to hunt for the player when enemy lost track of player.
|-
| '''HuntMinSeeChance''' || ''Float'' || Minimum chance of seeing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
| '''HuntMinHearVolume''' || ''Float'' || Minimum chance of hearing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''AttackDistance''' || ''Float'' || At what distance the enemy will do it's attack.
|-
| '''AttackSpeed''' || ''Float'' || At what speed the attack will happen.
|-
| '''AttackJumpTime''' || ''Float'' || How long to delay before jump.
|-
| '''AttackDamageTime''' || ''Float'' || How long the damage from the attack will be active.
|-
| '''AttackDamageSize''' || ''Vector3'' || How large the area will be affected by the attack.
|-
| '''AttackDamageRange''' || ''Float'' || How far the attack will reach.
|-
| '''AttackMinDamage''' || ''Float'' || Minimum damage dealt with each attack.
|-
| '''AttackMaxDamage''' || ''Float'' || Maximum damage dealt with each attack.
|-
| '''AttackStartSound''' || ''String'' || The sound to play at the beginning of an attack.
|-
| '''AttackHitSound''' || ''String'' || The sound to play when the attack is successful.
|-
| '''AttackMinMass''' || ''Float'' || Minimum mass that will be affected by an attack.
|-
| '''AttackMaxMass''' || ''Float'' || Maximum mass that will be affected by an attack.
|-
| '''AttackMinImpulse''' || ''Float'' || Minimum impulse given from an attack.
|-
| '''AttackMaxImpulse''' || ''Float'' || Maximum impulse given from an attack.
|-
| '''AttackStrength''' || ''Float'' || The strength of an attack.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''BreakDoorAnimation''' || ''String'' || The animation to use for enemy attacking a door it encounters locked/blocked.
|-
| '''BreakDoorSpeed''' || ''Float'' || At what speed to play the animation.
|-
| '''BreakDoorDamageTime''' || ''Float'' || How long the damage will be active for the attack.
|-
| '''BreakDoorDamageSize''' || ''Vector3'' || The size of the area affected by the attack.
|-
| '''BreakDoorDamageRange''' || ''Float'' || The range of the attack.
|-
| '''BreakDoorMinDamage''' || ''Float'' || Minimum damage dealt with attack.
|-
| '''BreakDoorMaxDamage''' || ''Float'' || Maximum damage dealt with attack.
|-
| '''BreakDoorStartSound''' || ''String'' || Sound of start of door attack.
|-
| '''BreakDoorHitSound''' || ''String'' || Sound when hitting the door during attack.
|-
| '''BreakDoorMinMass''' || ''Float'' || The minimum mass affected by the attack.
|-
| '''BreakDoorMaxMass''' || ''Float'' || The maximum mass affected by the attack.
|-
| '''BreakDoorMinImpulse''' || ''Float'' || The minimum impulse given by the attack.
|-
| '''BreakDoorMaxImpulse''' || ''Float'' || The maximum impulse given by the attack.
|-
| '''BreakDoorStrength''' || ''Float'' || The strength of the attack on the door,.
|-
| '''BreakDoorRiseAtEnd''' || ''Bool'' || Should the rise animation be played at the end of the break door animation.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''KnockDownSound''' || ''String'' || The sound played as an enemy is knocked over.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''DeathSound''' || ''String'' || The sound played as an enemy dies.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''FleePositionChance''' || ''Float'' || The chance of fleeing when knocked. 0 never 1 always, 0.x the chance.
|-
| '''FleePositionMaxTime''' || ''Float'' || How long the flee will last.
|-
| '''FleePositionMinDistance''' || ''Float'' || Minimum distance to run away.
|-
| '''FleePositionMaxDistance''' || ''Float'' || Maximum distance to run away.
|-
| '''FleeBackChance''' || ''Float'' || The chance of running back to the player. 0 never 1 always, 0.x the chance.
|-
| '''FleeBackTime''' || ''Float'' || How long it will wait to run back.
|-
| '''FleeBackSpeed''' || ''Float'' || At what speed to run back.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''CallBackupAnimation''' || ''String'' || What animation to use when calling for backup.
|-
| '''CallBackupSound''' || ''String'' || What sound to play during call for backup animation.
|-
| '''CallBackupRange''' || ''Float'' || How far the backup call will reach, one enemy within the range will come to help the other.
|-
|}
{| class="wikitable" border=1
!Name !!Type !!Description
|-
| '''EatFOV''' || ''Float'' || The field of view while eating
|-
| '''EatMinSeeChance''' || ''Float'' || The chance it will see the player while eating. 0 never 1 always, 0.x the chance.
|-
| '''EatMinHearVolume''' || ''Float'' || The chance it will hear the player while eating. 0 never 1 always, 0.x the chance.
|-
|}
 

===== 6.3.8.2 Enemy Spider=====
A erratic enemy that hunts the player when seen, and optionally runs away from the flashlight.

'''Needs animations for:'''
* Standing still, named: Idle
* Walking forwards, named: Walk
* Running, named: Run
* Attacking high, named: Attack
* Death animation that takes over after landing from ragdoll, named:Death
 
{| class="wikitable sortable" border=1
!Name !!Type !!Description
|-
| '''ShowDebug''' || ''Bool'' || Displays additional informaiton on the screen about the enemy and it's behavior, useful to check path nodes etc.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''Disappear''' || ''Bool'' || If the enemy should disappear on death.
|-
| '''DisappearMinTime''' || ''Float'' || The minimum of time before disappearing.
|-
| '''DisappearMaxTime''' || ''Float'' || The maximum of time before disappearing.
|-
| '''DisappearMinDistance''' || ''Float'' || The minimum of distance from player to disappear.
|-
| '''DisappearPS''' || ''String'' || Particle effect to display on disappearing.
|-
| '''DisappearSound''' || ''String'' || Sound to play on disappearing.
|-
| '''DisappearFreezesRagdoll''' || ''Bool'' || If the Ragdoll should turn static or remain active on diseappering.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''CloseMusic''' || ''String'' || The music to play when enemy close to player.
|-
| '''CloseMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
| '''CloseMusicStartDist''' || ''Float'' || At what distance the music should start playing.
|-
| '''CloseMusicStopDist''' || ''Float'' || At what distance the music should stop playing.
|-
| '''AttackMusic''' || ''String'' || The music to play when enemy enters attack mode.
|-
| '''AttackMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxPushMass''' || ''Float'' || The maximum mass of an object that the enemy can move.
|-
| '''PushForce''' || ''Float'' || At what force an emeny pushes an object.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxHealth''' || ''Float'' || The maximum health on an enemy, regenerates other time. 100 = players health.
|-
| '''MaxSeeDist''' || ''Float'' || The maximum distance that the enemy can spot the player.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''AlignToGroundNormal''' || ''Bool'' || If the body should align to the ground as the ground changes angel.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxForwardSpeed''' || ''Float'' || Maximum forward speed of enemy, default 1.
|-
| '''Acceleration''' || ''Float'' || Acceleration speed.
|-
| '''Deacceleration''' || ''Float'' || Deceleration speed.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''mfMaxTurnSpeed''' || ''Float'' || Turning speed.
|-
| '''mfAngleDistTurnMul''' || ''Float'' || Multiplier for turning ???.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''mfMinBreakAngle''' || ''Float'' || Break angle ???
|-
| '''mfBreakAngleMul''' || ''Float'' || Multiplier for break angel ???
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''StoppedToWalkSpeed''' || ''Float'' || How long to go from halt to walk.
|-
| '''WalkToStoppedSpeed''' || ''Float'' || How long to go from walk to halt.
|-
| '''WalkToRunSpeed''' || ''Float'' || How long to go from walk to run.
|-
| '''RunToWalkSpeed''' || ''Float'' || How long to go from run to walk.
|-
| '''MoveAnimSpeedMul''' || ''Float'' || Speed multiplier for the animations, to sync the animation to the movement speed.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''BodySize''' || ''Vector3'' || The size of the body.
|-
| '''BodyMass''' || ''Float'' || The mass of the body.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''ModelOffset_Rot''' || ''Vector3'' || Rotating offset for the model.
|-
| '''ModelOffset_Pos''' || ''Vector3'' || Position offset for the model.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''HitPS''' || ''String'' || Particle effect to be played at point of impact on enemy.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MinKnockDamage''' || ''Float'' || The minimum damage where the enemy might be knocked over.
|-
| '''CertainKnockDamage''' || ''Float'' || The amount of damage where the enemy will always be knocked over.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''LengthBodyToAss''' || ''Float'' || Who knows...
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''IdleFOV''' || ''Float'' || Field of view for enemy when idle.
|-
| '''IdleFoundPlayerSound''' || ''String'' || Sound for enemy spotting the player.
|-
| '''IdleMinSeeChance''' || ''Float'' || Minimum chance of enemy seeing player. 0 never 1 always, 0.x the chance.
|-
| '''IdleMinHearVolume''' || ''Float'' || Minimum chance of enemy hearing the player. 0 never 1 always, 0.x the chance.
|-
| '''IdleMinWaitLength''' || ''Float'' || Minimum time it stands still waiting.
|-
| '''IdleMaxWaitLength''' || ''Float'' || Maximum time it stands still waiting.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''HuntFOV''' || ''Float'' || Field of view for enemy when in hunt mode.
|-
| '''HuntSpeed''' || ''Float'' || At what speed the enemy moves when in hunt mode.
|-
| '''HuntForLostPlayerTime''' || ''Float'' || For how long will enemy continue to hunt for the player when enemy lost track of player.
|-
| '''HuntMinSeeChance''' || ''Float'' || Minimum chance of seeing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
| '''HuntMinHearVolume''' || ''Float'' || Minimum chance of hearing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''AttackDistance''' || ''Float'' || At what distance the enemy will do it's attack.
|-
| '''AttackForce''' || ''Float'' || At what what force to do the attack.
|-
| '''AttackJumpTime''' || ''Float'' || How long to delay before jump.
|-
| '''AttackDamageTime''' || ''Float'' || How long the damage from the attack will be active.
|-
| '''AttackDamageSize''' || ''Vector3'' || How large the area will be affected by the attack.
|-
| '''AttackDamageRange''' || ''Float'' || How far the attack will reach.
|-
| '''AttackMinDamage''' || ''Float'' || Minimum damage dealt with each attack.
|-
| '''AttackMaxDamage''' || ''Float'' || Maximum damage dealt with each attack.
|-
| '''AttackStartSound''' || ''String'' || The sound to play at the beginning of an attack.
|-
| '''AttackHitSound''' || ''String'' || The sound to play when the attack is successful.
|-
| '''AttackMinMass''' || ''Float'' || Minimum mass that will be affected by an attack.
|-
| '''AttackMaxMass''' || ''Float'' || Maximum mass that will be affected by an attack.
|-
| '''AttackMinImpulse''' || ''Float'' || Minimum impulse given from an attack.
|-
| '''AttackMaxImpulse''' || ''Float'' || Maximum impulse given from an attack.
|-
| '''AttackStrength''' || ''Float'' || The strength of an attack.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''KnockDownSound''' || ''String'' || The sound played as an enemy is knocked over.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''DeathSound''' || ''String'' || The sound played as an enemy dies.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''FleeMinDistance''' || ''Float'' || Minimum distance the enemy runs away when fleeing.
|-
| '''FleeMaxDistance''' || ''Float'' || Maximum distance the enemy runs away when fleeing.
|-
| '''FleeFromFlashlight''' || ''Float'' || IF the enemy should be scared of the flashlight beam.
|-
|}
 

===== 6.3.8.3 Enemy Worm=====
An enemy that follows the player around and deals damage at set intervals.

'''Needs animations for:'''
* Being still, named: Idle
* Moving, named: Move
* Attacking, named: Attack
 
{| class="wikitable sortable" border=1
!Name !!Type !!Description
|-
| '''ShowDebug''' || ''Bool'' || Displays additional informaiton on the screen about the enemy and it's behavior, useful to check path nodes etc.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''Disappear''' || ''Bool'' || If the enemy should disappear on death.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''CloseMusic''' || ''String'' || The music to play when enemy close to player.
|-
| '''CloseMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
| '''CloseMusicStartDist''' || ''Float'' || At what distance the music should start playing.
|-
| '''CloseMusicStopDist''' || ''Float'' || At what distance the music should stop playing.
|-
| '''AttackMusic''' || ''String'' || The music to play when enemy enters attack mode.
|-
| '''AttackMusicPrio''' || ''Int'' || The priority of the music, should be higher than ambient music of level or else it wont play.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxPushMass''' || ''Float'' || The maximum mass of an object that the enemy can move.
|-
| '''PushForce''' || ''Float'' || At what force an emeny pushes an object.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxHealth''' || ''Float'' || The maximum health on an enemy, regenerates other time. 100 = players health.
|-
| '''MaxSeeDist''' || ''Float'' || The maximum distance that the enemy can spot the player.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''AlignToGroundNormal''' || ''Bool'' || If the body should align to the ground as the ground changes angel.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MaxForwardSpeed''' || ''Float'' || Maximum forward speed of enemy, default 1.
|-
| '''Acceleration''' || ''Float'' || Acceleration speed.
|-
| '''Deacceleration''' || ''Float'' || Deceleration speed.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''mfMaxTurnSpeed''' || ''Float'' || Turning speed.
|-
| '''mfAngleDistTurnMul''' || ''Float'' || Multiplier for turning ???.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''mfMinBreakAngle''' || ''Float'' || Break angle ???
|-
| '''mfBreakAngleMul''' || ''Float'' || Multiplier for break angel ???
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''StoppedToWalkSpeed''' || ''Float'' || How long to go from halt to walk.
|-
| '''WalkToStoppedSpeed''' || ''Float'' || How long to go from walk to halt.
|-
| '''WalkToRunSpeed''' || ''Float'' || How long to go from walk to run.
|-
| '''RunToWalkSpeed''' || ''Float'' || How long to go from run to walk.
|-
| '''MoveAnimSpeedMul''' || ''Float'' || Speed multiplier for the animations, to sync the animation to the movement speed.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''BodySize''' || ''Vector3'' || The size of the body.
|-
| '''BodyMass''' || ''Float'' || The mass of the body.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''ModelOffset_Rot''' || ''Vector3'' || Rotating offset for the model.
|-
| '''ModelOffset_Pos''' || ''Vector3'' || Position offset for the model.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''HitPS''' || ''String'' || Particle effect to be played at point of impact on enemy.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''MoveSound''' || ''String'' || A sound to play while moving.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''IdleFOV''' || ''Float'' || Field of view for enemy when idle.
|-
| '''IdleFoundPlayerSound''' || ''String'' || Sound for enemy spotting the player.
|-
| '''IdleMinSeeChance''' || ''Float'' || Minimum chance of enemy seeing player. 0 never 1 always, 0.x the chance.
|-
| '''IdleMinHearVolume''' || ''Float'' || Minimum chance of enemy hearing the player. 0 never 1 always, 0.x the chance.
|-
| '''IdleMinWaitLength''' || ''Float'' || Minimum time it stands still waiting.
|-
| '''IdleMaxWaitLength''' || ''Float'' || Maximum time it stands still waiting.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''HuntFOV''' || ''Float'' || Field of view for enemy when in hunt mode.
|-
| '''HuntSpeed''' || ''Float'' || At what speed the enemy moves when in hunt mode.
|-
| '''HuntForLostPlayerTime''' || ''Float'' || For how long will enemy continue to hunt for the player when enemy lost track of player.
|-
| '''HuntMinSeeChance''' || ''Float'' || Minimum chance of seeing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
| '''HuntMinHearVolume''' || ''Float'' || Minimum chance of hearing the player when in hunt. 0 never 1 always, 0.x the chance.
|-
|}
{| class="wikitable sortable" border=1
! !! !!
|-
| '''AttackInterval''' || ''Float'' || At what intervals the attacks will be.
|-
| '''AttackDamage''' || ''Float'' || The damage dealt from an attack.
|-
| '''AttackHitSound''' || ''String'' || The sound to play when attacking with a hit.
|-
| '''AttackHitSoundInterval''' || ''Float'' || The interval between hit sounds.
|-
| '''AttackMinMass''' || ''Float'' || Minimum mass that will be affected by an attack.
|-
| '''AttackMaxMass''' || ''Float'' || Maximum mass that will be affected by an attack.
|-
| '''AttackMinImpulse''' || ''Float'' || Minimum impulse given from an attack.
|-
| '''AttackMaxImpulse''' || ''Float'' || Maximum impulse given from an attack.
|-
| '''AttackStrength''' || ''Float'' || The strength of an attack.
|-
| '''AttackDamageSize''' || ''Vector3'' || How large the area will be affected by the attack.
|-
|}
 

===== 6.3.8.4 Enemy Roach (Flying dolphin)=====
All properties hardcoded. ???

 
==== 6.3.9 Type Item ====

{| class="wikitable sortable" border=1
!Name !!Type !!Default !!Description
|-
| '''ImageFile''' || ''String'' || " " || The image file to be loaded.
|-
| '''CanBeDropped''' || ''Bool'' || True || If it should be possible to drop the item.
|-
| '''NameCat''' || ''String'' || " " || Translation Category for name.
|-
| '''NameEntry''' || ''String'' || " " || Translation Entry for name.
|-
| '''DescCat''' || ''String'' || " " || Translation Category for description.
|-
| '''DescEntry''' || ''String'' || " " || Translation Entry for description.
|-
| '''ItemType''' || ''String'' || "Normal" || Type of Item, different types of items see below for possible values.
|-
| '''HasCount''' || ''Bool'' || False || If the item has a count, ie it only takes up one slot.
|-
| '''Count''' || ''Int'' || 1 || If the items has a count this specifies how much the count increases.
|-
| '''PickUpSound''' || ''String'' || "player_pickup_generic" || The sound that is played when the item is picked.
|-
| '''HudModelFile''' || ''String'' || " " || The hud file to be used.
|-
| '''HudModelName''' || ''String'' || " " || The name of the object in the hud file.
|-
| '''EnterFlashDist''' || ''Float'' || 3 || The Distance at which an item can flash.
|-
| '''ExitFlashDist''' || ''Float'' || 6 || The distance at which the flash will be reset and it might flash again (when in sight and near enough).
|-
| '''SkipRayCheck''' || ''Bool'' || False || Skips the ray check when doing flashes.
|-
|}

===== 6.3.9.1 Different types of Items =====
{| class="wikitable sortable" border=1
!ItemType!! Description
|-
| '''Normal''' || Regular items, as it's default you do not need to add an ItemType to the GAME unless you are going to specify any of the below.
|-
| '''Note''' || Note item that will be added to notebook, is a Type="Item", SubType="Normal".
|-
| '''Map''' || Map item that will be added to map folder, this type was canceled but might still be functional.
|-
| '''Battery''' || Battery item, is a Type="Item", SubType="Battery".
|-
| '''Throw''' || A throwable object like the dynamite that can be wielded and charged to throw, is a Type="Item", SubType="Dynamite"/SubType="DogFood" .
|-
| '''Flashlight''' || Flashlight item that will run on batteries, is a Type="Item", SubType="Normal".
|-
| '''GlowStick''' || Light item that will last indefinitely, is a Type="Item", SubType="Normal".
|-
| '''Flare''' || Light item that will burn out, is a Type="Item", SubType="Flare".
|-
| '''Food''' || Eatable, do not think it has been used at all. But it should be there.. maybe.
|-
| '''Painkillers''' || A health item that restores the players health, is a Type="Item", SubType="Health".
|-
| '''WeaponMelee''' || An item that can be wielded and swung around, is a Type="Item", SubType="Normal".
|-
|}

 \\

HPL1/Content Creation Chapter 9

2023-03-31T08:05:11Z

Iamrealife: /* 9.1 Intro */

== 9 Heads-Up Display files ==

=== 9.1 Intro ===
The Hud Object Editor is a tool that aids you with creating items that can be wielded in-game, this can be anything from a custom lantern, throwable object or even a custom weapon for defending yourself.

Heads-Up Display files are XML files and before editing them it is suggested to read some quick tutorial on XML files. Only very basic XML understanding is needed to edit these files.

The files are divided into different sections, some sections are in all hud files and some are only present in certain hud types.

Prior to editing Heads-Up Display (*.hud) files make sure that the language is set to XML in Notepad++.

The following values are used, note that all types have "" around the value:
{| class="wikitable sortable" border=1
| '''String''' || A string of letters. "MyName" or "My_Name"
|-
| '''Float''' || A decimal number. "1.04" or "1.04f"
|-
| '''Integer''' || A number without decimals "-15"
|-
| '''Vector3''' || Three numbers in a row separated by space: "1 1 1".
|-
| '''Boolean''' || A data type using "true" or "false" values.
|-
|}
 
==== 9.1.1 Prerequisite ====
In order to use the Hud Object Editor you need the fmod library and the Verdana font. You can download these things from the [[HPL1/Getting_started|Getting Started]] page. The prerequisites archive also contains an offline version of this document as well as some other last minute information, should the wiki ever go down for whatever reason.
 
Toss the fmod Dynamic Library Link (*.dll) into the redistributable directory of Penumbra and the Verdana TrueType Font into the fonts folder.
 
Depending on where you installed Penumbra the Drive letter and directory might differ from the following example:
 
The fmod.dll file goes into
 
<code>C:\penumbra2\redist</code>
 
And the TrueType Font goes into
 
<code>C:\penumbra2\redist\fonts</code>
 
The program can only be called via Windows' Command Prompt. Grip never made a GUI for the program, you must also be in the redistributable directory when calling the program.
 
==== 9.1.2 Invocation ====
In the Windows Command Prompt, change the directory to the folder and drive where you have penumbra installed.
 
<code>cd C:\penumbra2\redist</code>
 
Then, load the Collada file (*.dae) while invoking the program. File extension isn't necessary.
 
<code>hudobjecteditor my_model</code>
 
The program will then fire up while using the HPL engines resource configuration file to search and index all directories currently written to it.
Your model file and the accompanying materials for it can be placed anywhere you like so long as it's within the reach of the resource.cfg file.
 
Use the [[HPL1/Content_Creation_Chapter_5|HPL Helper]] program to add new directories or type them out manually with something like Notepad++.
 

=== 9.2 Hud Object Editor ===
When you first fire up the program, you'll notice that it's very similar to the Model Viewer program. The controls are the same asides from a few minor changes.
{| class="wikitable sortable" border="1"
|'''Left Mouse Button:'''||Dolly around.
|-
|'''Middle Mouse Button:'''||Zoom in/out.
|-
|'''1:'''||Switch to viewer camera.
|-
|'''2:'''||Switch to Player camera.
|-
|'''A and Z:'''||Rotate models along the X axis. (A rotates up Z rotates down)
|-
|'''S and X:'''||Rotate models along the Y axis. (S rotates counter-clockwise X rotates clockwise)
|-
|'''D and C:'''||Rotate models along the Z axis. (D rotates left C rotates right)
|-
|'''P:'''||Prints the axis information to the Hud Object Editor log file to be used when creating the Heads-up Display (*.hud) file.
|-
|'''Arrow keys:'''||Moves the model in the respective directions. (Up, Left, Right, Down etc.)
|-
|'''Page Up:'''||Move item forward.
|-
|'''Page Down:'''||Move item backward.
|-
|}
 
==== 9.2.1 Heads-Up Display reference file ====
Below you will find a sample that will help you define a HUD file.
 
Use the Hud Object Editor to print the XYZ axis position and rotation values and then paste it to the Equip and Unequip roations and positions.
 
You can print multiple axis values without having to close the program down each time.
 
The Sound Entity (*.snt), Particle System (*.ps) and Entity (*.ent) files don't need their extensions when being referenced.
 
MAIN must always be present to define and reference the items to be used.
 
THROW is used for items with the Throw type.
 
MELEE is used for miscellanous stuff, not needed.
 
ATTACK is only used for WeaponMelee types. It defines various weapon information like how much damage it can deal, starting position and so forth.
 
For example: if the item is a "Throw" type, you get rid of the ATTACK tags.
 
When you're finished, create a new text file and rename the extension from .txt to .hud and then copypaste the stuff below into it to be used in-game.
<syntaxhighlight lang="XML">
<HUD_MODEL>
<MAIN
Name = "String, name of the item (for example: Meat, Lantern)"
Type = "Valid types are Throw and WeaponMelee, remove this line if object is neither"

ModelFile = "String, name of a valid Collada (*.dae) file to be used, must include extension as well when referencing (I.E banana.dae)"
EquipTime = Float, how long it takes to draw the item.
UnequipTime = Float, how long it takes to holster the item.

EquipPose_Pos = "Vector3, XYZ position of the item when drawn"
EquipPose_Rot = "Vector3, XYZ rotation of the item when drawn"

UnequipPose_Pos = "Vector3, XYZ position of the item when holstered"
UnequipPose_Rot = "Vector3, XYZ rotation of the item when holstered"

EquipSound = "String, name of the Sound Entity (*.snt) file to be used when drawing the item"
UnequipSound = "String, name of the Sound Entity (*.snt) file to be used when holstering the item"
/>
<MELEE
DrawDebug = "Boolean, whether or not to display debug information for the Haptic hardware"

HapticSize = "Vector3, this was meant to be utilized by the Novint Falcon controller with Reachin Technologies' HaptX API but remains unused"
/>
<ATTACK
Name = "String, name of the item (for example: SwingLeft, SwingRight, Poke)"

StartPose_Pos = "Vector3, XYZ position of the item when being positioned to strike"
StartPose_Rot = "Vector3, XYZ rotation of the item when being positioned to strike"

EndPose_Pos = "Vector3, XYZ position of the item when being positioned to strike"
EndPose_Rot = "Vector3, XYZ rotation of the item when being positioned to strike"

AttackLength = "Float, how fast or slow the attack animation should play"
ChargeLength = "Float, how fast or slow the charge animation should play"

TimeOfAttack = "Float, how long it takes before the attack begins"

MaxImpulse = "Integer, maximum impulse"
MinImpulse = "Integer, minimum impulse"

MinMass = "Integer, minimum mass"
MaxMass = "Integer, maximum mass"

MinDamage = "Integer, minimum damage dealt"
MaxDamage = "Integer, maximum damage dealt"

SpinMul = "Vector3, If the weapon spinning should be multiplied to the forward/backward force when moving the mouse up/down"

DamageRange = "Float, how far the damage can be dealt"
DamageSize = "Vector3, how large the damage area is in XYZ axis format (0 0 0)"

AttackRange = "Float, how far the attack range is"

AttackSpeed = "Integer, speed of the attack"
AttackStrength = "Integer, strength of the attack"

HitPS = "String, the Particle System (*.ps) file to be used when the weapon hits something"
HitPSPrio = Integer, set Particle priority

SwingSound = "String, name of the Sound Entity (*.snt) file to be used when swinging the weapon"
ChargeSound = "String, name of the Sound Entity (*.snt) file to be used when charging the weapon"
HitSound = "String, name of the Sound Entity (*.snt) file to be used when the weapon hits something"
/>
<THROW
ChargePose_Pos = "Vector3, XYZ position of the item when being prepared to be thrown"
ChargePose_Rot = "Vector3, XYZ rotation of the item when being prepared to be thrown"

ChargeTime = "Integer, how long it takes to prepare the item to be thrown"
MinImpulse = "Integer, minimum impulse given when thrown"
MaxImpulse = "Integer, maximum impulse given when thrown"

ReloadTime = "Float, how fast it takes to draw another batch"

Torque = "Vector3, set rotation"

ThrowEntity = "String, the entity (*.ent) file to be used when the item is thrown"

ChargeSound = "String, name of the Sound Entity (*.snt) file to be used when charging the item"
ThrowSound = "String, name of the Sound Entity (*.snt) file to be used when throwing the item"
/>
</HUD_MODEL>
</syntaxhighlight>

HPL1/Troubleshooting

2023-03-30T16:44:31Z

Iamrealife: /* Modding */

{{note|Please keep in mind that these games are VERY old (2007/2008) and official support has long since ceased, if you need help with the games please refer to the FAQ below. Don't expect them to work error free under anything higher than Windows Vista either.}} 

==Before troubleshooting==
Make sure you meet the minimum requirements and that all of your drivers are up-to-date.

'''MINIMUM SYSTEM REQUIREMENTS''' 
Windows XP/2000 or Vista 
(Windows 95/NT not supported) 
1.5 Ghz CPU 
512 Mb RAM 
1GB Disk Space 
CD-ROM 
ATI Radeon 8500/NVidia GeForce3 Ti 
(Geforce 4MX not supported) 
Keyboard and mouse

==Main game issues==

===The game will not start, what is happening?===
1. Check that you meet the minimum requirements. 
2. Make sure that you have the latest drivers for your graphics card.

===The graphics have strange artefacts or look weird in some other way.===
1. Make sure that you have the latest drivers for your graphics card. 
2. If you have an ATI card try turning off the A.I. optimisation option in Catalyst Center. 
3. If you have [http://www.stardock.com/products/windowblinds/wb5/ StarDock WindowBlinds 5] installed, try turning it off.

===Why is there no audio?===
1. Make sure you have the latest drivers for your soundcard. 
2. Try resetting the audio settings in the control panel. 
3. Check and make sure your speakers are turned on.

===The game is very slow. How can I make it faster?===
1. Choose a lower resolution in graphics. 
2. Try choosing a lower shader quality in graphics. 
3. Turn off post effects in graphics/advanced. 
4. Turn off shadows in graphics/advanced. 
5. Make sure you have the latest drivers for your graphics card!

===None of these answers help me!===
Go to http://support.frictionalgames.com to get more information, but please keep in mind that offical support has long since ceased for these products. 

==Modding==

===Viewers not scaling===
The HPL1 viewer windows cannot be scaled with the mouse. When you first run one of the viewers HPL Helper will create a little file in your Penumbra root directory called <code>viewer_settings.cfg</code> the file is in the XML format. 
You edit this file to change how the viewers behave. For example, you can change whether or not they will start in fullscreen or a certain resolution and whether or not the viewers framerate should synchronize to your monitor's refresh rate.

Changing the settings affects the following programs:
*HudObjectEditor
*ModelViewer
*ParticleViewer
*SceneViewer

===Game not executing scripts===
If you start the game with your custom map and script and nothing happens then you most likely have one too many errors in your script file that prevents it from being executed. Check the hpl.log file in your Penumbra root directory to see what errors are causing this fuss.

===Custom assets crash the Model Viewer===
1. You most likely forgot to assign a proper material to the model or didn't create a Material (*.mat) file with the accompanying texture. 
2. The Entity (*.ent) file used lacks a collider. All entities must have a body of some kind in order to function in-game. 
3. You're most likely trying to use a modern version of either Maya, 3D Studio or Blender. Unfortunately no modern alternative seems to work as the game uses a very old Collada specification for its models. 
4. You didn't specify the file path for your model. Use the [[HPL1/Content_Creation_Chapter_5#5.2.1_Resource_Directories|HPL Helper]] program to define the paths and write them to the <code>resources.cfg</code> file.

===libtheora.dll was not found===
In the highly unlikely event that you have an old retail copy of Penumbra: Overture, you will receive this error message if you try to use the HPL1 viewers. Download the latest update patch [https://fricpub.s3.amazonaws.com/updates/penumbra_overture_1.1u.exe here] to fix this.

HPL1/Content Creation Chapter 5

2023-03-30T14:30:38Z

Iamrealife: /* 5.4 Scenes */

==5. HPL Helper==

===5.1 General===
HPL-Helper is a front-end for various programs and an editing tool for various engine purposes. Latest version of the .Net Framework must be installed to get it working. See [[HPL1/Getting started|Getting started]] for details and download location.
 

===5.2 Settings===
Under this tab various settings can be altered.
 
====5.2.1 Resource Directories====
The HPL-Engine doesn’t use paths when searching for files, it only searches after specific filename. The option lets you set what directories the engine will search for the files in.

{| class="wikitable sortable" border="1"
|'''Add:'''||Adds a new directory to the list. This MUST be a subdirectory of the folder that HPL Helper is in!
|-
|'''Remove:'''||Simply just removes a directory from the list.
|-
|'''Save To File:'''||Saves all the directories to a file, this button must be pressed for the resource directories to be used by the applications.
|-
|}
 
===5.3 Models===
This part of the program is used to view and convert model files.
 

====5.3.1 Model File====
Click browse and choose the file you want to work with. ''You can open a .dae file directly or you can use a .ent file to get some/most of the ingame functionality for the model.''
 

====5.3.2 View====
Click this button to open the model viewer. Inside the viewer hold the left mouse button and move the mouse around to change the view. Press middle button and move the mouse up and down to zoom in and out. If the model has colliders use the right mouse button to hook onto the model and then move the mouse while holding the button down to drag it around.

For the time being there are no nice menus so one has to deal with using keys to toggle features.
{| class="wikitable sortable" border="1"
|-
|'''Up arrow:'''||Move camera up.
|-
|'''Down arrow:'''||Move camera down.
|-
|'''1:'''||Turn shadows on /off.
|-
|'''2:'''||Show/hide colliders.
|-
|'''3:'''||Turn physics on /off.
|-
|'''4:'''||Change animation.
|-
|'''5:'''||Start/stop spinning lights.
|-
|'''6:'''||Show/hide bounding box.
|-
|'''B:'''||Bloom on / off
|-
|'''R:'''||Turn ragdoll on/off if present.
|-
|}

====5.3.3 Convert====
Does nothing.
 

===5.4 Scenes===
Under this tab a scene can be loaded and viewed. This works exactly the same way as with models (described the previous chapter) apart from a few small things.

The View button allows you to see your map exactly how it will look in the game.

The StartPos box was meant to be used to define the starting position for the viewer camera, if one of your start areas was called something like "link02" you would input that and the viewer would start from that position. The functionality was never implemented and does nothing no matter what you put into the box.

Convert does nothing.

The following keys are used inside the viewer:
{| class="wikitable sortable" border="1"
|'''W,A,S,D:'''||Movement.
|-
|'''Mouse:'''||Look around.
|-
|'''1:'''||Toggles shadow modes, on, static only, off
|-
|'''2:'''||Turn room/portal debug graphics on and off. In this mode the rooms are randomly colored according to the order they where created. The portals are colored red and have a normal in the same color to witch the room it belongs to. At the end of the portal normal is a sphere in the same color as the room the portal connects to.
|-
|'''3:'''||Turns light bounding boxes on/off.
|-
|'''4:'''||Turns collision geometry on/off.
|-
|'''5:'''||Turns bounding boxes for entities on and off.
|-
|'''6:'''||Turns sound colliders on / off.
|-
|'''7:'''||Turns line rendering on / off. This is useful for optimizing portals.
|-
|'''8:'''||Turns show areas on / off.
|-
|'''9:'''||Displays Object names.
|-
|'''B:'''||Bloom on / off
|-
|}
 

===5.5 Materials===
There shouldn’t be anything strange in this part, the different settings are all explained in [[HPL1/Content Creation Chapter 4|chapter 4]].

Just remember that the changes aren’t updated until the file is saved!
 

===5.6 Physics Materials===
''Later on there should be an editor for physical material, right now one has to write by hand. In the redist folder you'll find the '''materials.cfg''' file which you can edit and add materials to.''

Physics materials are different from normal materials in that they describe physical properties of a surface/object rather can the visual. They describe what sounds are heard when two objects hit each other, how much they bounce, etc. If no material is set “Default” is used.

There are several properties that need some explanation:

'''Name''' Simply the name of the material, entities and texture refer to this. 
'''Elasticity''' How much of the energy that is conserved when the object hits another object. 0 = all is lost and 1 = no energy loss. This means 1 creates a bouncy surface or object and 0 creates a something that just stops at impact. 
'''StaticFriction''' The amount of energy required to get an object moving. The value can be between 0 and 1 (even up to 2 in special cases) and MUST be larger or equal to kinetic friction. 
'''Priority''' Gives materials different priorities, materials with the same priority will blend together while a higher priority for one material will make it dominant and the only one used. 
'''KineticFriction''' How fast the object stops sliding once it is moving (static describes how hard it is to get it start moving). This is a value between 0 and 1. 
'''ElasticityMode''' When two objects collide this describes how the elasticity values blend. See BlendMode for more information. 
'''FrictionMode''' When two objects collide this describes how the friction values blend. See BlendMode for more information. 
'''BlendModes:''' Each blendmode have a weight and when two objects collide the mode with the highest weight is used. Weight is written in front of the mode.
{| class="wikitable sortable" border="1"
|'''0. Average:'''||The average of the two values is used (r = (x+y)/2
|-
|'''1. Min:'''||The smaller of the two values is used.
|-
|'''2. Multiply'''||The two values are multiplied together. (r = x * y)
|-
|'''3. Max'''||The largest value is used.
|-
|}
 
'''StepType''' A game specific string meant to help specify what step sound to use. There are 3 kinds of steps: sneaking, walking and running. Make sure to name the sound entity files you want to use with the same ending, for example:player_step_sneak_dirt.snt,player_step_walk_dirt.snt,player_step_run_dirt.snt.

This way the game will know what sound to use for the different kinds of steps. In the materials.cfg file make StepType = Last word in the name, meaning StepType = "dirt". This will point the game to the player_step_xxx_dirt.snt files and automatically load them all 3. 
'''Scrape sound properties''' The following properties are used to set what sound is played when an object slides against some other object.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinScrapeSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinScrapeFreq'''||The minimum frequency the sound will have. 0 – 1.
|-
|'''MinScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxScrapeFreq'''||The maximum frequency the sound will have. 0 – infinity.
|-
|'''MaxScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleScrapeSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''MinScrapeContacts'''||The minimum number of contacts for a the scrape sound to play. 0 – infinity.
|-
|'''ScrapeSoundName'''||The name of the sound entity played.
|-
|}
 
'''Roll sound properties''' The following properties are used to set what sound is played when an object rolls.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinRollSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinRollFreq'''||The minimum pitch frequency the sound will have. 0 – 1.
|-
|'''MinRollVolume'''||The minimum volume the sound will have. 0 – 1.
|-
|'''MinRollFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxRollFreq'''||The maximum pitch frequency the sound will have. 0 – infinity.
|-
|'''MaxRollVolume'''||The volume the sound will have at maximum. 0 – 1.
|-
|'''MaxRollFreqSpeed'''||The object speed at which the maximum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleRollSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''RollSoundName'''||The name of the sound entity played.
|-
|'''RollAxis'''||Along which axis the roll is for, ''X,Y,Z''.
|-
|}
 

'''Impact properties''' The impact properties are used to define effects at impact. They are written like:

<syntaxhighlight lang="xml">
<Impact MinSpeed="2.1" […] />
<Impact MinSpeed="1.1" […] />
[…]
</syntaxhighlight>

The impacts must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}
 
'''Hit properties''' The hit properties are used to define effects from hitting on an object. They are written like:

<syntaxhighlight lang="xml">
<Hit MinSpeed="3" […] />
<Hit MinSpeed="1" […] />
[…]
</syntaxhighlight>

The hits must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}

In closing a physical material entry looks somewhat like this:
<syntaxhighlight lang="c++">
<Material
Name = "Name_Of_Material"
Elasticity = "0"
KineticFriction = "0.2"
StaticFriction = "0.2"

Priority="0"

ElasticityMode = "Min"
FrictionMode = "Min"

StepType="The_Sound_For_Steps"

MinScrapeSpeed = "0.04"
MinScrapeFreq = "0.5"
MinScrapeFreqSpeed = "0.7"
MaxScrapeFreq = "0.8"
MaxScrapeFreqSpeed = "2.5"
MiddleScrapeSpeed = "1.5"
MinScrapeContacts = "3"
ScrapeSoundName = "The_Sound_For_Scrape"

MinRollSpeed = "0.05"
MinRollFreq = "0.5"
MinRollVolume = "1"
MinRollFreqSpeed = "0.5"
MaxRollFreq = "0.8"
MaxRollVolume = "1"
MaxRollFreqSpeed = "1.5"
MiddleRollSpeed = "1"
RollSoundName = "The_Sound_For_Rolling"
RollAxis = "y"
>
<Impact MinSpeed="30" SoundName="Hardest_Impact_Sound"/>
<Impact MinSpeed="20" SoundName="Medium_Impact_Sound"/>
<Impact MinSpeed="10" SoundName="Softest_Impact_Sound"/>

<Hit MinSpeed="3" SoundName="Hit_Sound_Hard" PSName="Hit_Particle_Effect_Hard" PSPrio="10" />
<Hit MinSpeed="1" SoundName="Hit_Sound_Soft" PSName="Hit_Particle_Effect_Soft" PSPrio="10" />
</Material>
</syntaxhighlight>
 

===5.7 Sound===
This will allow you to create sound entity files, .snt. A sound entity file is a XML file that contains properties for a sound you want to play, for example if it should loop, at what volume, the radius and so on. It also contains information of what sound file to actually use, a valid sound file is in either .wav or .ogg.

IMPORTANT: Sound names must be written in special way. The files must be named
[name][number].[extension], for example: “mysound1.wav” and “test_sound1.ogg”. If you have several sounds that you want randomized you name them the same and with an increasing number (9 is maximum though). Example: “testsound1.wav”, “testsound2.wav” and so on.

The names above are written '''without''' the extension and number. So if you have a sound called “testsound1.wav” you would write “testsound”. If there are more sounds named testsound with increasing number then writing “testsound” will take one of these at random.
This part functions pretty much like Material. Below is an overview of the settings:

'''Main Sound''' The main sound played. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Start Sound''' If the sound is looping and interval is set to 0, then this will be played before main sounds start playing. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Stop Sound''' Just like start sound but will be played after the main sound stops. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Fade Start / Stop''' If the main sound should fade in/out when start / stop sound is playing. (Not implemented yet).

'''Loop''' If the sound should looped.

'''Use3D''' If the sound is heard in 3d or not affected by the player moving. Example: A sound coming from a leaking steam pipe should Use3D, but the ambient rumble in a level should not Use3D.

'''Stream''' If the sound is streamed.

'''Volume''' The volume of the sound. Valid values are 0 -1.

'''Min Distance''' The distance at which the sound starts getting lower. Valid values are 0 - infinitive.

'''Max Distance''' The distance at which the sound is quiet. Must be larger than min distance.

'''Interval''' If looped the sound is played in intervals. The interval is in seconds. Valid values are 0 -infinitive.

'''Random''' The chance of the sound playing at each interval. Valid values are 0 – 1.

'''Blockable''' This determines if the sound is blocked by sound blockers.

'''Block Volume''' This is the amount the volume is lowered when behind a sound blocker. Valid values are 0 – 1. 1 will not affect the sound and 0 will kill it completely, usually a value of about 0.5 to 0.8 gives a nice result.

'''Priority''' This sets what priority the sounds has in the game. The engine sets it’s own priority depending on where the sounds is. Outside max distance: 0 Outside min distance: 10 Inside min distance: 100 
The priority property is then added to this value. To make some collision sound more important then other collision sound the priority should be set to 0 – 100 depending on you want it to go before sounds inside min dist if it the sound itself is outside. If you have for example a radio message that must be heard and cannot be started over then set the prio to above 200.

Valid values are 0 – 255. Higher value means higher priority.

'''Note:''' When looped sounds are overridden by another, the looped sound is started over once a channel gets free. This shouldn’t be any problem for most sounds though. You have 32 audio channels to work with.
 

===5.8 Translation===
This section allows you to create and edit your language files. A language file is an XML file that contains text that should appear in-game as well as other places throughout. Depending on the entries and categories, this could be the text used in the main menu or for describing various objects in the game world. These descriptions are usually called via script.

'''Translation File:''' This allows you to save and open a language (*.lang) file, prior to editing make sure that you click the "Save As" button first before any work is to be done!

'''Category:''' Allows you to add, rename or remove a text category. It can be anything like MainMenu, Notebook, Global, Items, etc.

'''Entry:''' The entry is used to name your text depending on how it will be used (I.E AlkoholDesc), categories are used a way to organize these entries without losing track. You can add, remove and rename entries.

'''Text Entry:''' You type words into this big white box, this defines the actual text to be displayed in-game.

'''Name:''' Allows you to change the name of a text entry if you're not happy with it or made a typo somewhere.

\\

HPL1/Content Creation Chapter 5

2023-03-30T14:28:19Z

Iamrealife: /* 5.4 Scenes */

==5. HPL Helper==

===5.1 General===
HPL-Helper is a front-end for various programs and an editing tool for various engine purposes. Latest version of the .Net Framework must be installed to get it working. See [[HPL1/Getting started|Getting started]] for details and download location.
 

===5.2 Settings===
Under this tab various settings can be altered.
 
====5.2.1 Resource Directories====
The HPL-Engine doesn’t use paths when searching for files, it only searches after specific filename. The option lets you set what directories the engine will search for the files in.

{| class="wikitable sortable" border="1"
|'''Add:'''||Adds a new directory to the list. This MUST be a subdirectory of the folder that HPL Helper is in!
|-
|'''Remove:'''||Simply just removes a directory from the list.
|-
|'''Save To File:'''||Saves all the directories to a file, this button must be pressed for the resource directories to be used by the applications.
|-
|}
 
===5.3 Models===
This part of the program is used to view and convert model files.
 

====5.3.1 Model File====
Click browse and choose the file you want to work with. ''You can open a .dae file directly or you can use a .ent file to get some/most of the ingame functionality for the model.''
 

====5.3.2 View====
Click this button to open the model viewer. Inside the viewer hold the left mouse button and move the mouse around to change the view. Press middle button and move the mouse up and down to zoom in and out. If the model has colliders use the right mouse button to hook onto the model and then move the mouse while holding the button down to drag it around.

For the time being there are no nice menus so one has to deal with using keys to toggle features.
{| class="wikitable sortable" border="1"
|-
|'''Up arrow:'''||Move camera up.
|-
|'''Down arrow:'''||Move camera down.
|-
|'''1:'''||Turn shadows on /off.
|-
|'''2:'''||Show/hide colliders.
|-
|'''3:'''||Turn physics on /off.
|-
|'''4:'''||Change animation.
|-
|'''5:'''||Start/stop spinning lights.
|-
|'''6:'''||Show/hide bounding box.
|-
|'''B:'''||Bloom on / off
|-
|'''R:'''||Turn ragdoll on/off if present.
|-
|}

====5.3.3 Convert====
Does nothing.
 

===5.4 Scenes===
Under this tab a scene can be loaded and viewed. This works exactly the same way as with models (described the previous chapter) apart from a few small things.

The View button allows you to see your map exactly how it will look in the game.

The StartPos box was meant to be used to define the starting position for the viewer camera, if one of your start areas was called something like "link02" you would input that and the viewer would start from that position. The functionality was never implemented and does nothing no matter what you put into the box.

Convert does nothing.

The following keys are used in side the viewer:
{| class="wikitable sortable" border="1"
|'''W,A,S,D:'''||Movement.
|-
|'''Mouse:'''||Look around.
|-
|'''1:'''||Toggles shadow modes, on, static only, off
|-
|'''2:'''||Turn room/portal debug graphics on and off. In this mode the rooms are randomly colored according to the order they where created. The portals are colored red and have a normal in the same color to witch the room it belongs to. At the end of the portal normal is a sphere in the same color as the room the portal connects to.
|-
|'''3:'''||Turns light bounding boxes on/off.
|-
|'''4:'''||Turns collision geometry on/off.
|-
|'''5:'''||Turns bounding boxes for entities on and off.
|-
|'''6:'''||Turns sound colliders on / off.
|-
|'''7:'''||Turns line rendering on / off. This is useful for optimizing portals.
|-
|'''8:'''||Turns show areas on / off.
|-
|'''9:'''||Displays Object names.
|-
|'''B:'''||Bloom on / off
|-
|}
 

===5.5 Materials===
There shouldn’t be anything strange in this part, the different settings are all explained in [[HPL1/Content Creation Chapter 4|chapter 4]].

Just remember that the changes aren’t updated until the file is saved!
 

===5.6 Physics Materials===
''Later on there should be an editor for physical material, right now one has to write by hand. In the redist folder you'll find the '''materials.cfg''' file which you can edit and add materials to.''

Physics materials are different from normal materials in that they describe physical properties of a surface/object rather can the visual. They describe what sounds are heard when two objects hit each other, how much they bounce, etc. If no material is set “Default” is used.

There are several properties that need some explanation:

'''Name''' Simply the name of the material, entities and texture refer to this. 
'''Elasticity''' How much of the energy that is conserved when the object hits another object. 0 = all is lost and 1 = no energy loss. This means 1 creates a bouncy surface or object and 0 creates a something that just stops at impact. 
'''StaticFriction''' The amount of energy required to get an object moving. The value can be between 0 and 1 (even up to 2 in special cases) and MUST be larger or equal to kinetic friction. 
'''Priority''' Gives materials different priorities, materials with the same priority will blend together while a higher priority for one material will make it dominant and the only one used. 
'''KineticFriction''' How fast the object stops sliding once it is moving (static describes how hard it is to get it start moving). This is a value between 0 and 1. 
'''ElasticityMode''' When two objects collide this describes how the elasticity values blend. See BlendMode for more information. 
'''FrictionMode''' When two objects collide this describes how the friction values blend. See BlendMode for more information. 
'''BlendModes:''' Each blendmode have a weight and when two objects collide the mode with the highest weight is used. Weight is written in front of the mode.
{| class="wikitable sortable" border="1"
|'''0. Average:'''||The average of the two values is used (r = (x+y)/2
|-
|'''1. Min:'''||The smaller of the two values is used.
|-
|'''2. Multiply'''||The two values are multiplied together. (r = x * y)
|-
|'''3. Max'''||The largest value is used.
|-
|}
 
'''StepType''' A game specific string meant to help specify what step sound to use. There are 3 kinds of steps: sneaking, walking and running. Make sure to name the sound entity files you want to use with the same ending, for example:player_step_sneak_dirt.snt,player_step_walk_dirt.snt,player_step_run_dirt.snt.

This way the game will know what sound to use for the different kinds of steps. In the materials.cfg file make StepType = Last word in the name, meaning StepType = "dirt". This will point the game to the player_step_xxx_dirt.snt files and automatically load them all 3. 
'''Scrape sound properties''' The following properties are used to set what sound is played when an object slides against some other object.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinScrapeSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinScrapeFreq'''||The minimum frequency the sound will have. 0 – 1.
|-
|'''MinScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxScrapeFreq'''||The maximum frequency the sound will have. 0 – infinity.
|-
|'''MaxScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleScrapeSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''MinScrapeContacts'''||The minimum number of contacts for a the scrape sound to play. 0 – infinity.
|-
|'''ScrapeSoundName'''||The name of the sound entity played.
|-
|}
 
'''Roll sound properties''' The following properties are used to set what sound is played when an object rolls.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinRollSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinRollFreq'''||The minimum pitch frequency the sound will have. 0 – 1.
|-
|'''MinRollVolume'''||The minimum volume the sound will have. 0 – 1.
|-
|'''MinRollFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxRollFreq'''||The maximum pitch frequency the sound will have. 0 – infinity.
|-
|'''MaxRollVolume'''||The volume the sound will have at maximum. 0 – 1.
|-
|'''MaxRollFreqSpeed'''||The object speed at which the maximum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleRollSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''RollSoundName'''||The name of the sound entity played.
|-
|'''RollAxis'''||Along which axis the roll is for, ''X,Y,Z''.
|-
|}
 

'''Impact properties''' The impact properties are used to define effects at impact. They are written like:

<syntaxhighlight lang="xml">
<Impact MinSpeed="2.1" […] />
<Impact MinSpeed="1.1" […] />
[…]
</syntaxhighlight>

The impacts must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}
 
'''Hit properties''' The hit properties are used to define effects from hitting on an object. They are written like:

<syntaxhighlight lang="xml">
<Hit MinSpeed="3" […] />
<Hit MinSpeed="1" […] />
[…]
</syntaxhighlight>

The hits must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}

In closing a physical material entry looks somewhat like this:
<syntaxhighlight lang="c++">
<Material
Name = "Name_Of_Material"
Elasticity = "0"
KineticFriction = "0.2"
StaticFriction = "0.2"

Priority="0"

ElasticityMode = "Min"
FrictionMode = "Min"

StepType="The_Sound_For_Steps"

MinScrapeSpeed = "0.04"
MinScrapeFreq = "0.5"
MinScrapeFreqSpeed = "0.7"
MaxScrapeFreq = "0.8"
MaxScrapeFreqSpeed = "2.5"
MiddleScrapeSpeed = "1.5"
MinScrapeContacts = "3"
ScrapeSoundName = "The_Sound_For_Scrape"

MinRollSpeed = "0.05"
MinRollFreq = "0.5"
MinRollVolume = "1"
MinRollFreqSpeed = "0.5"
MaxRollFreq = "0.8"
MaxRollVolume = "1"
MaxRollFreqSpeed = "1.5"
MiddleRollSpeed = "1"
RollSoundName = "The_Sound_For_Rolling"
RollAxis = "y"
>
<Impact MinSpeed="30" SoundName="Hardest_Impact_Sound"/>
<Impact MinSpeed="20" SoundName="Medium_Impact_Sound"/>
<Impact MinSpeed="10" SoundName="Softest_Impact_Sound"/>

<Hit MinSpeed="3" SoundName="Hit_Sound_Hard" PSName="Hit_Particle_Effect_Hard" PSPrio="10" />
<Hit MinSpeed="1" SoundName="Hit_Sound_Soft" PSName="Hit_Particle_Effect_Soft" PSPrio="10" />
</Material>
</syntaxhighlight>
 

===5.7 Sound===
This will allow you to create sound entity files, .snt. A sound entity file is a XML file that contains properties for a sound you want to play, for example if it should loop, at what volume, the radius and so on. It also contains information of what sound file to actually use, a valid sound file is in either .wav or .ogg.

IMPORTANT: Sound names must be written in special way. The files must be named
[name][number].[extension], for example: “mysound1.wav” and “test_sound1.ogg”. If you have several sounds that you want randomized you name them the same and with an increasing number (9 is maximum though). Example: “testsound1.wav”, “testsound2.wav” and so on.

The names above are written '''without''' the extension and number. So if you have a sound called “testsound1.wav” you would write “testsound”. If there are more sounds named testsound with increasing number then writing “testsound” will take one of these at random.
This part functions pretty much like Material. Below is an overview of the settings:

'''Main Sound''' The main sound played. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Start Sound''' If the sound is looping and interval is set to 0, then this will be played before main sounds start playing. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Stop Sound''' Just like start sound but will be played after the main sound stops. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Fade Start / Stop''' If the main sound should fade in/out when start / stop sound is playing. (Not implemented yet).

'''Loop''' If the sound should looped.

'''Use3D''' If the sound is heard in 3d or not affected by the player moving. Example: A sound coming from a leaking steam pipe should Use3D, but the ambient rumble in a level should not Use3D.

'''Stream''' If the sound is streamed.

'''Volume''' The volume of the sound. Valid values are 0 -1.

'''Min Distance''' The distance at which the sound starts getting lower. Valid values are 0 - infinitive.

'''Max Distance''' The distance at which the sound is quiet. Must be larger than min distance.

'''Interval''' If looped the sound is played in intervals. The interval is in seconds. Valid values are 0 -infinitive.

'''Random''' The chance of the sound playing at each interval. Valid values are 0 – 1.

'''Blockable''' This determines if the sound is blocked by sound blockers.

'''Block Volume''' This is the amount the volume is lowered when behind a sound blocker. Valid values are 0 – 1. 1 will not affect the sound and 0 will kill it completely, usually a value of about 0.5 to 0.8 gives a nice result.

'''Priority''' This sets what priority the sounds has in the game. The engine sets it’s own priority depending on where the sounds is. Outside max distance: 0 Outside min distance: 10 Inside min distance: 100 
The priority property is then added to this value. To make some collision sound more important then other collision sound the priority should be set to 0 – 100 depending on you want it to go before sounds inside min dist if it the sound itself is outside. If you have for example a radio message that must be heard and cannot be started over then set the prio to above 200.

Valid values are 0 – 255. Higher value means higher priority.

'''Note:''' When looped sounds are overridden by another, the looped sound is started over once a channel gets free. This shouldn’t be any problem for most sounds though. You have 32 audio channels to work with.
 

===5.8 Translation===
This section allows you to create and edit your language files. A language file is an XML file that contains text that should appear in-game as well as other places throughout. Depending on the entries and categories, this could be the text used in the main menu or for describing various objects in the game world. These descriptions are usually called via script.

'''Translation File:''' This allows you to save and open a language (*.lang) file, prior to editing make sure that you click the "Save As" button first before any work is to be done!

'''Category:''' Allows you to add, rename or remove a text category. It can be anything like MainMenu, Notebook, Global, Items, etc.

'''Entry:''' The entry is used to name your text depending on how it will be used (I.E AlkoholDesc), categories are used a way to organize these entries without losing track. You can add, remove and rename entries.

'''Text Entry:''' You type words into this big white box, this defines the actual text to be displayed in-game.

'''Name:''' Allows you to change the name of a text entry if you're not happy with it or made a typo somewhere.

\\

HPL1/Content Creation Chapter 4

2023-03-30T14:27:14Z

Iamrealife: /* 4.4 Physics material */

==4. Creating Materials==

===4.1 Types===
Instead of creating materials for your self, like one usually does in 3d modeling programs, a couple of predefined materials are used. What needs to be filled out are the different maps used.

'''Settings for General''' Use Alpha: Never implemented. Depth Test: Never Implemented. Value: Does nothing. 
====4.1.1 Flat====
This material shows the diffuse map without any lighting. '''Texture units:''' Diffuse
 
====4.1.2 Additive====
This transparent material is blended additively with the background. 

''Result = source_pixel + screen_pixel'' 

It is not affected by lighting. '''Texture units:''' Diffuse
 

====4.1.3 Modulative====
This transparent material is multiplied with the background. 
''Result = source_pixel * screen_pixel'' 
It is not affected by lighting. '''Texture units:''' Diffuse
 
====4.1.4 Modulative x 2====
This transparent material is multiplied with the background times two, like this: 
''Result = (source_pixel * screen_pixel) * 2'' 

It is not affected by lighting. '''Texture units:''' Diffuse
 
====4.1.5 Alpha====
Each texel on the texture is transperant according to the alpha channel on the texture. 
It is not affected by lighting. '''Texture units:''' Diffuse
 
====4.1.6 Diffuse====
The diffuse map with lighting. '''Texture units:''' Diffuse and Illumination (optional).
 
====4.1.7 DiffuseSpecular====
The diffuse map with lighting and specular term. Does not have any support for specular map. '''Texture units:''' Diffuse and Illumination (optional).
 
====4.1.8 Bump====
This material shows the diffuse map with a bump mapped surface. '''Texture units:''' Diffuse, Normal-Map and Illumination (optional).
 
====4.1.9 BumpSpecular====
This material shows the diffuse map with a bump mapped surface and specular term. The alpha channel of the normal map is used as specular map. '''Texture units:''' Diffuse, Normal-Map and Illumination (optional).
 
====4.1.10 BumpColorSpecular====
This material shows the diffuse map with a bump mapped surface and a color specular term. '''Texture units:''' Diffuse, Normal-Map, Specular and Illumination (optional).
 

====4.1.11 EnvironmentMapReflect====
This material shows the diffuse map with a environment reflection from a CubeMap. '''Texture units:''' Diffuse and CubeMap.
 

====4.1.12 Water====
This transparent material is blended additively with the background. It also has a bobbing surface.

Result = source_pixel + screen_pixel

It is not affected by lighting '''Texture units:''' Diffuse.
 

===4.2 Texture units===
The different material types uses texture units to calculate the value of pixel. Each texture units have the following properties:

{| class="wikitable sortable" border="1"
|'''Type:'''||The type of texture, 1D, 2D and Cube can be used. Normally only 2D is used.
|-
|'''Mipmaps:'''||If mipmaps should be created for the texture and should be used for most textures.
|-
|'''Compress:'''||If hardware compression should be used if available. (Not supported yet).
|-
|'''Wrap:'''||The wrap mode to use when drawing the texture, “Repeat” means texture is tiled. “Clamp” means that uv-values above 1 and below 0 are clamped. Useful on for example flat objects with transparent edges. “ClampToEdge” is the same as “Clamp” but does not blend with the opposite edge.
|-
|'''Anim mode:'''||How to play an animation, looping or bouncing back and forth with oscillation.
|-
|'''Frame time:'''||How long an image should be displayed in an image sequence, 1 = 1 image / second, 2 = 1 image / 2 seconds, 0.2 = 5 images / second etc.
|-
|}
 
====4.2.1 Diffuse====
The r,g and b channels contain the color values. The alpha channel is used for transparent materials.
 
====4.2.2 Normal-Map====
This is a map showing the topology of a surface in tangent space. The r,g and b channels contain the compressed normal vectors. The alpha channel is used for specifying the specular term for specular material, 0= no specularity 1 = full specularity.
 
====4.2.3 Illumination====
This map is additively added after all lights has been rendered.
 
====4.2.4 Specular====
The r,g and b channels are used to create a specular effect. The whiter the shinier, black = no shine.
 

====4.2.5 CubeMap====
''Cube map texturing is a form of texture mapping that uses a 3D direction vector (a fancy phrase that means nothing more than a direction) to index into a texture that is six square 2D textures arranged like the faces of a cube. See [http://developer.nvidia.com/object/cube_map_ogl_tutorial.html this cube map tutorial] for extensive information on it's construction.''

The CubeMap is used to create a "reflection" of the environment in a texture, for example the ice in the ice cave level in penumbra.

For the HPL engine you make the 6 images as separate images, and you name them: nameofimage_neg_x nameofimage_neg_y nameofimage_neg_z nameofimage_pos_x nameofimage_pos_y nameofimage_pos_z 
In the material editor under Texture Units at the file prompt: you add one of the images and only use the "nameofimage" excluding "_neg_x", the engine will then automatically locate and use the 6 images.
 
===4.3 File format===
Material files has the extension “.mat”, are made in XML and has the following format:

<syntaxhighlight lang="xml">
<Material>
<Main Type="[material type]"/>
<TextureUnits>
<[Texture unit] File="[file name]" Type ="[type]" Mipmaps="[true or false]" Compress="[true or false]" Wrap="[wrap mode]"/>
[additional texture units…]
</TextureUnits>
</Material>
</syntaxhighlight>

Instead of handwriting these files HplHelper can be used to create material files.
 

===4.4 Physics material===
This is gives the material physical properties as well. Read more about the different types under [[HPL1/Content_Creation_Chapter_5#5.6_Physics_Materials|chapter 5.6]]. Note that this property is only useful for static scene geometry and is NOT used for entities, entities specify their physics material in the entity file.
 \\

HPL1/Troubleshooting

2023-03-30T09:37:09Z

Iamrealife: /* Custom assets crash the Model Viewer */

HPL1/Troubleshooting

2023-03-30T09:23:39Z

Iamrealife: /* Custom assets crash the Model Viewer */

{{note|Please keep in mind that these games are VERY old (2007/2008) and official support has long since ceased, if you need help with the games please refer to the FAQ below. Don't expect them to work error free under anything higher than Windows Vista either.}} 

==Before troubleshooting==
Make sure you meet the minimum requirements and that all of your drivers are up-to-date.

'''MINIMUM SYSTEM REQUIREMENTS''' 
Windows XP/2000 or Vista 
(Windows 95/NT not supported) 
1.5 Ghz CPU 
512 Mb RAM 
1GB Disk Space 
CD-ROM 
ATI Radeon 8500/NVidia GeForce3 Ti 
(Geforce 4MX not supported) 
Keyboard and mouse

==Main game issues==

===The game will not start, what is happening?===
1. Check that you meet the minimum requirements. 
2. Make sure that you have the latest drivers for your graphics card.

===The graphics have strange artefacts or look weird in some other way.===
1. Make sure that you have the latest drivers for your graphics card. 
2. If you have an ATI card try turning off the A.I. optimisation option in Catalyst Center. 
3. If you have [http://www.stardock.com/products/windowblinds/wb5/ StarDock WindowBlinds 5] installed, try turning it off.

===Why is there no audio?===
1. Make sure you have the latest drivers for your soundcard. 
2. Try resetting the audio settings in the control panel. 
3. Check and make sure your speakers are turned on.

===The game is very slow. How can I make it faster?===
1. Choose a lower resolution in graphics. 
2. Try choosing a lower shader quality in graphics. 
3. Turn off post effects in graphics/advanced. 
4. Turn off shadows in graphics/advanced. 
5. Make sure you have the latest drivers for your graphics card!

===None of these answers help me!===
Go to http://support.frictionalgames.com to get more information, but please keep in mind that offical support has long since ceased for these products. 

==Modding==

===Viewers not scaling===
The HPL1 viewer windows cannot be scaled with the mouse. When you first run one of the viewers HPL Helper will create a little file in your Penumbra root directory called <code>viewer_settings.cfg</code> the file is in the XML format. 
You edit this file to change how the viewers behave. For example, you can change whether or not they will start in fullscreen or a certain resolution and whether or not the viewers framerate should synchronize to your monitor's refresh rate.

Changing the settings affects the following programs:
*HudObjectEditor
*ModelViewer
*ParticleViewer
*SceneViewer

===Game not executing scripts===
If you start the game with your custom map and script and nothing happens then you most likely have one too many errors in your script file that prevents it from being executed. Check the hpl.log file in your Penumbra root directory to see what errors are causing this fuss.

===Custom assets crash the Model Viewer===
1. You most likely forgot to assign a proper material to the model or didn't create a Material (*.mat) file with the accompanying texture. 
2. The Entity (*.ent) file used lacks a collider. All entities must have a body of some kind in order to function in-game. 
3. You're most likely trying to use a modern version of either Maya, 3D Studio or Blender. Unfortunately no modern alternative seems to work as the game uses a very old Collada specification for its models. 
4. You didn't specify the file path your model. use the [[HPL1/Content_Creation_Chapter_5#5.2.1_Resource_Directories|HPL Helper]] program to define the paths and write them to the <code>resources.cfg</code> file.

HPL1/Editors/Particle Editor

2023-03-29T20:27:54Z

Iamrealife: /* 1.3 File */

=HPL1/Content Creation Chapter 6 HPL Particle Editor=

==1 Introduction==
This is the guide for the HPL-Particle editor which is a tool for creating various particle effects. 
===1.1 Min and Max values===
A lot of values in the editor have both a min and max. This means that when the value is set to a particle a value between min and max is randomly selected. 
===1.2 Fading===
Fading can be used to fade in and/or out some property like size or colour. The fading works like this. There are three relative values that are relative to the start value of the particle. The names for these values are start, middle and end and are used in that order. There are also two times that are relative to the life of the particle, for example if a particle has 2 seconds life time and the middle time is 0.5 then this occurs after 1 second (0.5 * 2). The first time is called middle time and this is when the start value is entirely faded from start to middle. The middle length is how long the middle value lasts. After middle time + middle length the middle value is faded to the end value. 
===1.3 File===
*New - Creates a new particle system and resets all the settings to default.
*Save - Saves your settings to the currently opened Particle System (*.ps) file.
*Save as... - Allows you to save your particle under a different name.
*Open - Lets you open particle files. 

===1.4 Emitters===
This section allows you to view a list of all the currently available emitters in your particle file as well as Add, Copy and remove emitters.
The large Save and View Particle System button displays your particle how it will look in-game. 
===1.5 Room===
*Show Room - Here you can choose whether or not the Particle Viewer program should render a small room around the particle that you're currently viewing.
*Room size - This defines how large said room should be. Default settings are 6x6x6 

==2 Parameters==
===2.1. General===
'''Name''' The name of the emitter currently selected. 
'''Max Particles''' The maximum number of particles that can be alive at once. When this limit is reached no more particles willl be created. 
'''Particles per Second''' The number of particles per second that will be created. 
'''Start time offset''' Time offset in seconds before the emitter starts. 
'''Respawn dead particles''' If dead particles should be respawned. 
'''Warm up time''' Time that the emitter gets to warm up. This is useful when doing a a stream of something (like a fire or waterfall) and the particles should not be shown “starting up”. 
'''Pause''' A pause is a break during which no particles are created. Particles are updated though. 
'''Pause Length''' The length of the pauses, 0 and 0 means that there are no pauses. 
'''Pause Interval''' The length between pauses. 0 and 0 means that there are no pauses. 
'''Offset position''' How the emitter is offset relative to its starting positon. 
'''Offset angle''' How to particle system is offset relative to its start angles. 
===2.2 Rendering===
'''Draw Type''' The different ways in which the particles can be draw to screen. Point: The particle is a point and will always be pointing towards the camera. Line: The particle is aligned in the direction in which the particle is travelling. 
'''Multiply RGB with Alpha''' Some materials does not fade out the image when alpha is decreased (for example Additive) in this case it can be good to check this. 
'''Size''' The size of the particle. This is the value used in the fading. 
'''Size Fading''' See 1.2 for instructions on fading. 
===2.3 Collision===
'''Use Collision''' If collision detection should be used. 
'''Update Rate''' How many times a second collision is check for each particle. 
'''Maximum Collisions''' The maximum amount of collions can have before dying. 
'''Bounce Amount''' How much of the speed is retained when bouncing. 0.5 means half of the speed. 2 means that the speed doubles when bouncing. 
===2.4 Beam Specific===
This was meant to create and handle [[HPL1/Content_Creation_Chapter_3#3.13_Beams|Beam]] files, never implemented.

 

===2.5 Rotation===
'''Use Particle Spinning''' 
If enabled, particles will rotate around themselves. 
'''Spin Type''' 
Type for the particle spinning. Can be: 
'''Constant''' 
A value will be picked from the spin velocity range at random. 
'''Movement''' 
The rotation will be linked to how fast the particle is moving. 
'''Particle spin velocity range (rad/s)''' 
Spin velocity for constant spin type. About 6.283 radians is a single spin. 
'''Use Revolution''' 
If enabled, particles will rotate around some axis. 
'''Revolution Velocity (rad/s)''' 
3D Vector that will determine the axis and rotation speed for particles.

 

===2.6 Start===
'''Start type''' Sets what method to use to generate the start position of the particles in the emitter. 
'''Box start''' A box start is created using an x, y and z min and max value. The collection of particles will get the shape of a box. 
'''Sphere start''' The positions are generated using an angle interval and the min and max value for the radius. You can think of it like this; an arrow start pointing up. This arrow is then rotated around the X axis (red) using a value between min and max. After that the arrow is rotated by the y axis (blue). The arrow will now be pointing in a specific direction and in this direction a position is created at a distance from center according to a number generated from min/max radius. [[File:spherestart.jpg]]
 
===2.7 Color===
''NOTE: all of the colour channels have values from 0 -1.'' 
'''Color''' This sets the colour of the particle. 
'''Fading''' Settings for fading the colour. See chapter 1.2 for fading. 
===2.8 Movement===
'''Velocity type''' The way in which the starting velocity is generated. 
'''Box velocity''' The same as box start but with velocity instead. 
'''Sphere Velocity''' The same as sphere start but with velocity instead. 
'''Coord system''' The way in which the particles are related to the world and the object the system is attached to (if any). In world all the particles have an individual postion that does change depending on the parent object. In local however the particle position is dependant on the parent object so if that the particle moves and turns along with the parent. 
'''Uses direction''' If the direction of the start velocity depends on the way the particle system is “facing” (with no rotation it faces up). This is useful for systems like steam where the system has a direction. 
'''Gravity Type''' The type of gravity being applied to the particles. None: No gravity it applied. Vector: The gravity acceleration is applied. Centre: The particles are drawn towards the centre of the particle system with Gravity Acceleration Y as acceleration. 
'''Gravity Acceleration''' Used differently according by the gravity type. 
'''Acceleration''' Accleration applied to all bodies. 
'''Speed multiplier''' How much the speed is multiplied by each second. For example, 0.5 means that the speed halfed each second. 2 means it is doubled each second. 
'''Maximum speed''' The maximum speed that the particles can reach. 
===2.9 Life===
'''Lifespan''' Time in seconds that the particle will live. 
'''Death Type''' Type of death for the particles. Only Age can be selected. 
'''PS created at death''' Particle System to be spawned when the particle dies. Could be used to loop particle creations.
 

===2.10 Material===
'''File''' The material file to use. 
'''Number of Files''' The number of material files used. Normally this should just be one, but in some cases an animation needed is spread out over several material files. When using several material files these must be name “[name]01.mat”, “[name]02.mat”, etc. Also the file text must be just “[name]”. So if the files are called “test01.mat”, “test02.mat”, etc it must say “test” in the file field. 
'''Animation length''' The number of seconds the animation lasts, if the particle lives longer than this time, the animation is looped. 
'''Sub Division''' This is used in order to animate individual particles (when using several files, the material for all particles are changed at the same time). It can also be used for more variety among particles. The sub divisoion is set up by specifying how the texture is to be split and then setting how the particles will be assigned to a sub division. The splitting is like this: [[File:subdiv.jpg]]
 
'''Sub Division Amount''' The number of divisons on each axis. 
'''Sub Division Type''' How the subdivisions are assigned to the particles. Random: A division is randomly picked. Animation: During the life time of an object it has all the subdivisions. Starting in the upper left corning and ending in the lower right. 

==3 Tutorials==
[[HPL1/Tutorials/Particles|See tutorial 4]] \\

HPL1/Tools

2023-03-29T20:15:07Z

Iamrealife: Created page with "{{note|The HPL1 engine did not have a dedicated editor for creating custom maps, you have to create them with a 3D editor like Maya or 3D Studio MAX.}} {| class="wikitable..."

{{note|The HPL1 engine did not have a dedicated editor for creating custom maps, you have to create them with a 3D editor like Maya or 3D Studio MAX.}} 
{| class="wikitable" style="margin:auto"
! colspan="2" scope="row" |Editors
|-
|'''[[HPL1/Content_Creation_Chapter_9|Hud Object Editor]]'''||Should the player weld a glowstick? Or perhaps a lantern? Why not a pickaxe or a crowbar to defend yourself?
|-
|'''[[HPL1/Content_Creation_Chapter_5#5.7_Sound|Sounds]]'''||What's that sound? Oh, it's just the vending machine.
|-
|'''[[HPL1/Editors/Particle_Editor|Particle Editor]]'''||Create Particle Systems to give your levels some life.
|-
|'''[[HPL1/Content_Creation_Chapter_4|Materials]]'''||Defines how a texture should look and sound.
|-
|[[HPL1/Content_Creation_Chapter_5#5.8_Translation|'''Translation''']]||Helper tool to build, edit, and translate language files.
|-
! colspan="2" scope="row" |Viewers
|-
|'''[[HPL1/Content_Creation_Chapter_5#5.4_Scenes|Scene Viewer]]'''||See how your level will look in-game without having to constantly run the game. A useful tool for checking portal optimization.
|-
|'''[[HPL1/Content_Creation_Chapter_5#5.3_Models|Model Viewer]]'''||Play around with your custom entities and get basic in-game interaction with them.
|-
|'''[[HPL1/Editors/Particle_Editor|Particle Viewer]]'''||Lets you view your Particle Systems.
|-
|}

HPL1

2023-03-29T19:58:16Z

Iamrealife:

<div style="text-align:center;">
'''Welcome to the HPL1 documentation hub.''' Here you can find extensive documentation about the engine, including downloads for various tools and tutorials on how to create your own [[HPL1/Getting_started|mods]].
</div>

{{warning|It's difficult to do anything with Penumbra: Overture and Penumbra: Black Plague as it requires using old software and learning a great deal before anything useful can be made. Take the time to read through the documentation and familiarize yourself with the tools.}}
{{note|Overture and Black plague are identical scripting-wise but differ with enemy types. Black Plague introduced the infected character whereas Overture can't load those in-game.}}

<div style="text-align:center;">
[[File:Hpl1:Hpl1_logo_retro.png|250px|link=|HPL1]]
'''[[HPL1/Tools|Development Tools]] | [[HPL1/Troubleshooting|Troubleshooting]]'''</div>

----
<center><gallery mode="nolines" widths="250" heights="250">
File:overture-header.jpg
File:BP-header.jpg
</gallery></center>
{| class="wikitable" style="margin:auto;"
|'''[[HPL1/Getting_started|<center>Getting started</center>]]'''
|Start here, you must also download some important files before anything useful can be made
|-
|'''[[HPL1/Content_Creation|<center>Modding</center>]]'''
|Create various different things, from entities to materials.
|-
|'''[[HPL1/Script_Reference|<center>Script Functions</center>]]'''
|See a list of all available script functions for the Penumbra games
|-
|'''[[HPL1/Content_Creation_Chapter_2|<center>Modeling</center>]]'''
|Import, export, add and modify 3D models for the game
|-
|'''[[HPL1/Content_Creation_Chapter_6|<center>Entities</center>]]'''
|Create your own entity files with the power of Notepad++
|-
|'''[[HPL1/Content_Creation_Chapter_4|<center>Materials</center>]]'''
|Use the Material Editor to combine texture maps to create materials
|-
|'''[[HPL1/Editors/Particle Editor|<center>Effects</center>]]'''
|Create your own visual effects with the HPL1 Particle Editor
|-
|'''[[HPL1/Tutorials|<center>Tutorials</center>]]'''
|Official step-by-step guides on a variety of topics, created by Frictional Games
|-
|'''[[HPL1/Third party tools|<center>Third-Party Tools</center>]]'''
|Useful developer tools
|-
|'''[[HPL1/Glossary|<center>Glossary</center>]]'''
|Explanations for terms you may encounter
|}

[[Category:Entry pages]]
__NOTOC____NOEDITSECTION__

[[Category:Entry pages]]
[[Category:English]]

2023-03-29T09:13:21Z

Iamrealife: /* 5.7 Sound */

==5. HPL Helper==

===5.1 General===
HPL-Helper is a front-end for various programs and an editing tool for various engine purposes. Latest version of the .Net Framework must be installed to get it working. See [[HPL1/Getting started|Getting started]] for details and download location.
 

===5.2 Settings===
Under this tab various settings can be altered.
 
====5.2.1 Resource Directories====
The HPL-Engine doesn’t use paths when searching for files, it only searches after specific filename. The option lets you set what directories the engine will search for the files in.

{| class="wikitable sortable" border="1"
|'''Add:'''||Adds a new directory to the list. This MUST be a subdirectory of the folder that HPL Helper is in!
|-
|'''Remove:'''||Simply just removes a directory from the list.
|-
|'''Save To File:'''||Saves all the directories to a file, this button must be pressed for the resource directories to be used by the applications.
|-
|}
 
===5.3 Models===
This part of the program is used to view and convert model files.
 

====5.3.1 Model File====
Click browse and choose the file you want to work with. ''You can open a .dae file directly or you can use a .ent file to get some/most of the ingame functionality for the model.''
 

====5.3.2 View====
Click this button to open the model viewer. Inside the viewer hold the left mouse button and move the mouse around to change the view. Press middle button and move the mouse up and down to zoom in and out. If the model has colliders use the right mouse button to hook onto the model and then move the mouse while holding the button down to drag it around.

For the time being there are no nice menus so one has to deal with using keys to toggle features.
{| class="wikitable sortable" border="1"
|-
|'''Up arrow:'''||Move camera up.
|-
|'''Down arrow:'''||Move camera down.
|-
|'''1:'''||Turn shadows on /off.
|-
|'''2:'''||Show/hide colliders.
|-
|'''3:'''||Turn physics on /off.
|-
|'''4:'''||Change animation.
|-
|'''5:'''||Start/stop spinning lights.
|-
|'''6:'''||Show/hide bounding box.
|-
|'''B:'''||Bloom on / off
|-
|'''R:'''||Turn ragdoll on/off if present.
|-
|}

====5.3.3 Convert====
Does nothing.
 

===5.4 Scenes===
Under this tab a scene can be loaded and viewed. This works exactly the same way as with models (described the previous chapter) apart from a few small things.

The View button allows you to see your map exactly how it will look in the game.

The StartPos box was meant to be used to define the starting position for the viewer camera, if one of your start areas was called something like "link02" you would input that and the viewer would start from that position. The functionality was never implemented and does nothing no matter what you put into the box.

The following keys are used in side the viewer:
{| class="wikitable sortable" border="1"
|'''W,A,S,D'''||Movement.
|-
|'''Mouse'''||Look around.
|-
|'''1.'''||Toggles shadow modes, on, static only, off
|-
|'''2.'''||Turn room/portal debug graphics on and off. In this mode the rooms are randomly colored according to the order they where created. The portals are colored red and have a normal in the same color to witch the room it belongs to. At the end of the portal normal is a sphere in the same color as the room the portal connects to.
|-
|'''3.'''||Turns light bounding boxes on/off.
|-
|'''4.'''||Turns collision geometry on/off.
|-
|'''5.'''||Turns bounding boxes for entities on and off.
|-
|'''6.'''||Turns sound colliders on / off.
|-
|'''7.'''||Turns line rendering on / off. This is useful for optimizing portals.
|-
|'''8.'''||Turns show areas on / off.
|-
|'''9.'''||Displays Object names.
|-
|'''B'''||Bloom on / off
|-
|}

====5.4.1 Convert====
Does nothing.
 

===5.5 Materials===
There shouldn’t be anything strange in this part, the different settings are all explained in [[HPL1/Content Creation Chapter 4|chapter 4]].

Just remember that the changes aren’t updated until the file is saved!
 

===5.6 Physics Materials===
''Later on there should be an editor for physical material, right now one has to write by hand. In the redist folder you'll find the '''materials.cfg''' file which you can edit and add materials to.''

Physics materials are different from normal materials in that they describe physical properties of a surface/object rather can the visual. They describe what sounds are heard when two objects hit each other, how much they bounce, etc. If no material is set “Default” is used.

There are several properties that need some explanation:

'''Name''' Simply the name of the material, entities and texture refer to this. 
'''Elasticity''' How much of the energy that is conserved when the object hits another object. 0 = all is lost and 1 = no energy loss. This means 1 creates a bouncy surface or object and 0 creates a something that just stops at impact. 
'''StaticFriction''' The amount of energy required to get an object moving. The value can be between 0 and 1 (even up to 2 in special cases) and MUST be larger or equal to kinetic friction. 
'''Priority''' Gives materials different priorities, materials with the same priority will blend together while a higher priority for one material will make it dominant and the only one used. 
'''KineticFriction''' How fast the object stops sliding once it is moving (static describes how hard it is to get it start moving). This is a value between 0 and 1. 
'''ElasticityMode''' When two objects collide this describes how the elasticity values blend. See BlendMode for more information. 
'''FrictionMode''' When two objects collide this describes how the friction values blend. See BlendMode for more information. 
'''BlendModes:''' Each blendmode have a weight and when two objects collide the mode with the highest weight is used. Weight is written in front of the mode.
{| class="wikitable sortable" border="1"
|'''0. Average:'''||The average of the two values is used (r = (x+y)/2
|-
|'''1. Min:'''||The smaller of the two values is used.
|-
|'''2. Multiply'''||The two values are multiplied together. (r = x * y)
|-
|'''3. Max'''||The largest value is used.
|-
|}
 
'''StepType''' A game specific string meant to help specify what step sound to use. There are 3 kinds of steps: sneaking, walking and running. Make sure to name the sound entity files you want to use with the same ending, for example:player_step_sneak_dirt.snt,player_step_walk_dirt.snt,player_step_run_dirt.snt.

This way the game will know what sound to use for the different kinds of steps. In the materials.cfg file make StepType = Last word in the name, meaning StepType = "dirt". This will point the game to the player_step_xxx_dirt.snt files and automatically load them all 3. 
'''Scrape sound properties''' The following properties are used to set what sound is played when an object slides against some other object.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinScrapeSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinScrapeFreq'''||The minimum frequency the sound will have. 0 – 1.
|-
|'''MinScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxScrapeFreq'''||The maximum frequency the sound will have. 0 – infinity.
|-
|'''MaxScrapeFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleScrapeSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''MinScrapeContacts'''||The minimum number of contacts for a the scrape sound to play. 0 – infinity.
|-
|'''ScrapeSoundName'''||The name of the sound entity played.
|-
|}
 
'''Roll sound properties''' The following properties are used to set what sound is played when an object rolls.

Speed is in m/s and frequency is in percent / 100. This means that if frequency is 1 then the sound is played at normal (100%) speed. If it is 0.5 then the sound is played at half speed and 2 means double speed.

{| class="wikitable sortable" border="1"
|'''MinRollSpeed'''||The minimum speed at which the sound is played. 0 – infinity.
|-
|'''MinRollFreq'''||The minimum pitch frequency the sound will have. 0 – 1.
|-
|'''MinRollVolume'''||The minimum volume the sound will have. 0 – 1.
|-
|'''MinRollFreqSpeed'''||The object speed at which the minimum frequency will be used. Frequency never goes lower once this speed is reached. 0 – infinity.
|-
|'''MaxRollFreq'''||The maximum pitch frequency the sound will have. 0 – infinity.
|-
|'''MaxRollVolume'''||The volume the sound will have at maximum. 0 – 1.
|-
|'''MaxRollFreqSpeed'''||The object speed at which the maximum frequency will be used. Frequency never goes higher once this speed is reached. 0 – infinity.
|-
|'''MiddleRollSpeed'''||The object speed at which normal frequency (1) is used
|-
|'''RollSoundName'''||The name of the sound entity played.
|-
|'''RollAxis'''||Along which axis the roll is for, ''X,Y,Z''.
|-
|}
 

'''Impact properties''' The impact properties are used to define effects at impact. They are written like:

<syntaxhighlight lang="xml">
<Impact MinSpeed="2.1" […] />
<Impact MinSpeed="1.1" […] />
[…]
</syntaxhighlight>

The impacts must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}
 
'''Hit properties''' The hit properties are used to define effects from hitting on an object. They are written like:

<syntaxhighlight lang="xml">
<Hit MinSpeed="3" […] />
<Hit MinSpeed="1" […] />
[…]
</syntaxhighlight>

The hits must be written with the highest minimum speed first and then in dropping order.

{| class="wikitable sortable" border="1"
|'''MinSpeed'''||The minimum object speed at which this effect is used.
|-
|'''SoundName'''||The name of the sound entity played.
|-
|'''PSName'''||The name of the particle effect to use.
|-
|'''PSPrio'''||What priority to use on the effect, the same uses all effects for all involved materials and higher uses only the highest.
|-
|}

In closing a physical material entry looks somewhat like this:
<syntaxhighlight lang="c++">
<Material
Name = "Name_Of_Material"
Elasticity = "0"
KineticFriction = "0.2"
StaticFriction = "0.2"

Priority="0"

ElasticityMode = "Min"
FrictionMode = "Min"

StepType="The_Sound_For_Steps"

MinScrapeSpeed = "0.04"
MinScrapeFreq = "0.5"
MinScrapeFreqSpeed = "0.7"
MaxScrapeFreq = "0.8"
MaxScrapeFreqSpeed = "2.5"
MiddleScrapeSpeed = "1.5"
MinScrapeContacts = "3"
ScrapeSoundName = "The_Sound_For_Scrape"

MinRollSpeed = "0.05"
MinRollFreq = "0.5"
MinRollVolume = "1"
MinRollFreqSpeed = "0.5"
MaxRollFreq = "0.8"
MaxRollVolume = "1"
MaxRollFreqSpeed = "1.5"
MiddleRollSpeed = "1"
RollSoundName = "The_Sound_For_Rolling"
RollAxis = "y"
>
<Impact MinSpeed="30" SoundName="Hardest_Impact_Sound"/>
<Impact MinSpeed="20" SoundName="Medium_Impact_Sound"/>
<Impact MinSpeed="10" SoundName="Softest_Impact_Sound"/>

<Hit MinSpeed="3" SoundName="Hit_Sound_Hard" PSName="Hit_Particle_Effect_Hard" PSPrio="10" />
<Hit MinSpeed="1" SoundName="Hit_Sound_Soft" PSName="Hit_Particle_Effect_Soft" PSPrio="10" />
</Material>
</syntaxhighlight>
 

===5.7 Sound===
This will allow you to create sound entity files, .snt. A sound entity file is a XML file that contains properties for a sound you want to play, for example if it should loop, at what volume, the radius and so on. It also contains information of what sound file to actually use, a valid sound file is in either .wav or .ogg.

IMPORTANT: Sound names must be written in special way. The files must be named
[name][number].[extension], for example: “mysound1.wav” and “test_sound1.ogg”. If you have several sounds that you want randomized you name them the same and with an increasing number (9 is maximum though). Example: “testsound1.wav”, “testsound2.wav” and so on.

The names above are written '''without''' the extension and number. So if you have a sound called “testsound1.wav” you would write “testsound”. If there are more sounds named testsound with increasing number then writing “testsound” will take one of these at random.
This part functions pretty much like Material. Below is an overview of the settings:

'''Main Sound''' The main sound played. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Start Sound''' If the sound is looping and interval is set to 0, then this will be played before main sounds start playing. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Stop Sound''' Just like start sound but will be played after the main sound stops. ''Remember delete the number and extension from the sound you choose, "testsound1.wav" should be entered "testsound".''

'''Fade Start / Stop''' If the main sound should fade in/out when start / stop sound is playing. (Not implemented yet).

'''Loop''' If the sound should looped.

'''Use3D''' If the sound is heard in 3d or not affected by the player moving. Example: A sound coming from a leaking steam pipe should Use3D, but the ambient rumble in a level should not Use3D.

'''Stream''' If the sound is streamed.

'''Volume''' The volume of the sound. Valid values are 0 -1.

'''Min Distance''' The distance at which the sound starts getting lower. Valid values are 0 - infinitive.

'''Max Distance''' The distance at which the sound is quiet. Must be larger than min distance.

'''Interval''' If looped the sound is played in intervals. The interval is in seconds. Valid values are 0 -infinitive.

'''Random''' The chance of the sound playing at each interval. Valid values are 0 – 1.

'''Blockable''' This determines if the sound is blocked by sound blockers.

'''Block Volume''' This is the amount the volume is lowered when behind a sound blocker. Valid values are 0 – 1. 1 will not affect the sound and 0 will kill it completely, usually a value of about 0.5 to 0.8 gives a nice result.

'''Priority''' This sets what priority the sounds has in the game. The engine sets it’s own priority depending on where the sounds is. Outside max distance: 0 Outside min distance: 10 Inside min distance: 100 
The priority property is then added to this value. To make some collision sound more important then other collision sound the priority should be set to 0 – 100 depending on you want it to go before sounds inside min dist if it the sound itself is outside. If you have for example a radio message that must be heard and cannot be started over then set the prio to above 200.

Valid values are 0 – 255. Higher value means higher priority.

'''Note:''' When looped sounds are overridden by another, the looped sound is started over once a channel gets free. This shouldn’t be any problem for most sounds though. You have 32 audio channels to work with.
 \\

2023-03-28T14:40:50Z

Iamrealife:

=Third Party Tools=

Here you will find some useful links and tutorials on how to work with the HPL1 engine in terms of modeling, audio editing and even animation.

==COLLADA==

All 3D modeling packages require the option to export in the [http://collada.org/ Collada] format, regardless what program is used.

==3D Programs==

#[https://www.autodesk.com/products/maya/overview?term=1-YEAR&tab=subscription Alias Maya] - The world's most powerful integrated 3D modeling, animation & rendering solution.
#[https://www.autodesk.com/products/3ds-max/overview?term=1-YEAR&tab=subscription Autodesk 3D Studio Max] - A professional 3D computer graphics program for making 3D animations, models, games and images.
#[https://download.blender.org/release/Blender2.49/ Blender - Open-source 3D modeling program that comes with built-in support for Collada.]

==2D Programs==

#[https://www.adobe.com/products/photoshop.html Adobe Photoshop] - Professional image editing software.
#[https://www.gimp.org/ GIMP] - Open-source 2D '''G'''NU '''I'''mage '''M'''anipulation '''P'''rogram.
#[https://www.getpaint.net/ - Closed-source free image editor comparable to GIMP but easier, smaller, faster ]

==Audio Programs==

#[https://www.audacityteam.org/ Audacity] - Multi-channel sound editor.
#[https://www.rarewares.org/ogg-oggdropxpd.php OggDropXPD] - Drag'n Drop your audio files to convert them to .ogg.

==Text/Script coding programs==

#[https://notepad-plus-plus.org/downloads/ notepad++] - Advanced text editor, crucial for script writing.