HPL1/Script Reference - Revision history

Iamrealife at 12:38, 8 April 2023

2023-04-08T12:38:38Z

Iamrealife: /* Game scripts */

2023-03-27T07:31:10Z

Game scripts

Iamrealife: /* Script Reference document */

2023-03-27T07:26:59Z

Script Reference document

Iamrealife: /* Script Reference document */

2023-03-27T07:21:21Z

Script Reference document

Iamrealife: /* General */

2023-03-27T07:17:09Z

General

Show changes

Iamrealife: /* General */

2023-03-27T07:07:55Z

General

Show changes

Mudbill: Mudbill moved page Hpl1:Documentation:script reference to HPL1/Script Reference without leaving a redirect

2020-07-19T18:50:44Z

Mudbill moved page Hpl1:Documentation:script reference to HPL1/Script Reference without leaving a redirect

Maintenance script: Upload from wiki

2020-07-09T13:47:27Z

Upload from wiki

Show changes

@@ Line 1: / Line 1: @@
 = 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.<br /><br /><br /><br /><br /><br />
+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.<br /><br />
 == Engine scripts ==

@@ Line 276: / Line 276: @@
 Sets a callback that is called (and removed) when the last message as been shown.<br />asFunction The function to be called, syntax “MyFunc()“<br /><syntaxhighlight lang="c++">
-AddSubTitleTrans(string asTransCat,string asTransName, float afTime);
+void AddSubTitleTrans(string asTransCat,string asTransName, float afTime);
 </syntaxhighlight>
 Adds a onscreen message at the bottom, that does not interrupt the gameplay.<br />asTransCat The translation files category.<br />asTransName The translation files name of the entry to be displayed.<br />afTime the length of time it should be displayed.<br /><syntaxhighlight lang="c++">
-AddSubTitle(string asMessage, float afTime);
+void AddSubTitle(string asMessage, float afTime);
 </syntaxhighlight>
@@ Line 288: / Line 288: @@
 Makes the onscreen text invert colours to be easier to read on bright backgrounds.<br />abX enable or disabled the function.<br /><syntaxhighlight lang="c++">
-void AddRadioMessage(    string asTransCat,string asTransName,
+void AddRadioMessage(string asTransCat,string asTransName,string asSound);
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
 = Script Reference document =
-This document is not perfectly structured, sometimes a certain script function is perhaps not in the most logical position and so forth. It's recommended you search with the browser for what you need. Almost all scripts are used in Penumbra/Penumbra: Overture so it's always a good idea to locate a script in an actual level .hps file to see how it is used.<br /><br /><br /><br /><br /><br />
+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.<br /><br /><br /><br /><br /><br />
 == Engine scripts ==

@@ Line 1: / Line 1: @@
 = Script Reference document =
-This document is not perfectly structured, sometimes a certain script function is perhaps not in the most logical position and so forth. It's recommended you search with the browser for what you need. Almost all scripts are used in Penumbra/Penumbra: Overture so it's always a good idea to locate a script in an actual level .hps file to see how it is used.<br /><br /><br /><br /><br /><br />== Engine scripts ==
+This document is not perfectly structured, sometimes a certain script function is perhaps not in the most logical position and so forth. It's recommended you search with the browser for what you need. Almost all scripts are used in Penumbra/Penumbra: Overture so it's always a good idea to locate a script in an actual level .hps file to see how it is used.<br /><br /><br /><br /><br /><br />
 === General ===
@@ Line 29: / Line 30: @@
 </syntaxhighlight>
-Checks what a string contains.<br />asString what string to check<br />asSubString what to check the string against<br /><br />=== Resources ===
+Checks what a string contains.<br />asString what string to check<br />asSubString what to check the string against<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 43: / Line 45: @@
 </syntaxhighlight>
-Resync screen frames to logic timer.<br /><br />=== Particle Systems ===
+Resync screen frames to logic timer.<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 61: / Line 64: @@
 </syntaxhighlight>
-Kill a particle system<br />asName The name of the particle system.<br /><br />=== Beams ===
+Kill a particle system<br />asName The name of the particle system.<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 71: / Line 75: @@
 </syntaxhighlight>
-Destroy a beam<br />asName name of the beam to destory<br /><br />=== Lights ===
+Destroy a beam<br />asName name of the beam to destory<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 111: / Line 116: @@
 </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.<br />asName The light name<br />abX if it should only affect the sector or not.<br /><br />=== Audio ===
+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.<br />asName The light name<br />abX if it should only affect the sector or not.<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 157: / Line 163: @@
 </syntaxhighlight>
-Play a sound gui sound, with out any position.<br />asName The sound name<br />afVol Volume of the sound<br /><br />=== Physics ===
+Play a sound gui sound, with out any position.<br />asName The sound name<br />afVol Volume of the sound<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 203: / Line 210: @@
 </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.<br />asBodyName The body name<br />asCoordType The coordinate system type. “World” or “Local”.<br />afX velocity in the x direction. (in m/s)<br />afY velocity in the y direction. (in m/s)<br />afZ velocity in the z direction. (in m/s)<br /><br />=== Local Variables ===
+Adds an impule (a change in velocity) to the body. This can either be in the bodies local coord system or the world's.<br />asBodyName The body name<br />asCoordType The coordinate system type. “World” or “Local”.<br />afX velocity in the x direction. (in m/s)<br />afY velocity in the y direction. (in m/s)<br />afZ velocity in the z direction. (in m/s)<br /><br />
 <syntaxhighlight lang="c++">
@@ Line 218: / Line 226: @@
 </syntaxhighlight>
-<br />=== Global Variables ===
+<br />
 <syntaxhighlight lang="c++">
@@ Line 233: / Line 242: @@
 </syntaxhighlight>
-<br /><br />== Game scripts ==
+<br /><br />
 === General ===