HPL2/Engine Scripts - Revision history

BoxFigs: /* Sounds & Music */

2025-10-17T01:54:56Z

Sounds & Music

2025-10-16T18:47:30Z

Levers, wheels and buttons

2025-10-16T18:46:44Z

Levers, wheels and buttons

2025-10-16T18:41:48Z

Props

2025-10-16T18:39:21Z

Props

2025-10-16T18:38:44Z

Props

2025-10-16T18:32:16Z

Player

2025-10-16T18:31:26Z

Player

2025-09-25T02:35:09Z

Props

2025-09-25T02:34:45Z

Props

@@ Line 437: / Line 437: @@
 #''afFadeTime ''- time in seconds until music stops
 #''alPrio ''- the priority of the music that should stop
 <syntaxhighlight lang="c++">

@@ Line 1,925: / Line 1,925: @@
 #''asName'' - internal name
 #''afAngle'' - angle
-#''abAutoMove'' - true: wheel physically moves to the new angle; false: angle is changed without moving the wheel
+#''abAutoMove'' - true = wheel physically moves to the new angle; false = angle is changed without moving the wheel
 <syntaxhighlight lang="cpp">

@@ Line 1,925: / Line 1,925: @@
 #''asName'' - internal name
 #''afAngle'' - angle
-#''abAutoMove'' - determines whether the wheel should move on its own
+#''abAutoMove'' - true: wheel physically moves to the new angle; false: angle is changed without moving the wheel
 <syntaxhighlight lang="cpp">

@@ Line 1,712: / Line 1,712: @@
 </syntaxhighlight>
-Makes the prop play an animation and calls a function. <br />Callback syntax: <code>void MyFunc(string &in asProp)</code>
+Makes the prop play an animation and calls a function when it stops. <br />Callback syntax: <code>void MyFunc(string &in asProp)</code>
 #''asProp ''- internal name of the prop
@@ Line 1,718: / Line 1,718: @@
 #''afFadeTime ''- Fade time between current and new animations
 #''abLoop ''- determines whether the animation loops
-#''asCallback ''- function to call
+#''asCallback ''- function to call when the animation ends
 <syntaxhighlight lang="cpp">

@@ Line 1,684: / Line 1,684: @@
 #''afRotX ''- rotation around X axis of the attach
 #''afRotY ''- rotation around Y axis of the attach
-#''afRotZ ''- rotation around ZX axis of the attach Note: for the purposes of <code>AddEntityCollideCallback</code>, attached props will not call the callback function if they collide with a "static_object" or a "StaticProp" entity type!
+#''afRotZ ''- rotation around ZX axis of the attach
 <syntaxhighlight lang="cpp">

@@ Line 1,120: / Line 1,120: @@
 #''asTextCategory'' - the category in the .lang file
 #''asTextEntry'' - the entry in the .lang file
-#''afTime'' - determines how long the message is displayed. If time is < =0 then the life time is calculated based on string length.
+#''afTime'' - determines how long the message is displayed. If time is <= 0 then the life time is calculated based on string length.
 <syntaxhighlight lang="c++">

@@ Line 1,128: / Line 1,128: @@
 Sets the message that appears when the player dies.
-#''asTextCategory'' - the category in the .lang file
+#''asTextCategory'' - the category in the .lang file, usually "Hints"
-#''asTextEntry'' - the entry in the .lang file, usually "Hints"
+#''asTextEntry'' - the entry in the .lang file
 <syntaxhighlight lang="c++">

@@ Line 1,601: / Line 1,601: @@
 #''asName'' - internal name
 #''abActive'' - active state
-#''afFadeAndPlaySounds'' - if all effects should fade in/out or not
+#''abFadeAndPlaySounds'' - if all effects should fade in/out or not
 <syntaxhighlight lang="c">

@@ Line 1,594: / Line 1,594: @@
 void SetPropEffectActive(string &in asName, bool abActive, bool abFadeAndPlaySounds);
 </syntaxhighlight>
 Can be used on coal to give it the black color it should have.
 <syntaxhighlight lang="c">