HPL2/HPL2 Helper Scripts/Math - Revision history

Mrbehemo: Added DistToEntity()

2024-02-11T02:02:11Z

Added DistToEntity()

2023-12-03T16:57:37Z

2023-11-30T19:12:29Z

RotatePropToSpeedVec

2023-11-30T19:11:53Z

Vector uses

2023-11-30T19:11:09Z

Added MovePlayerHeadPosVec()

2023-11-26T16:53:54Z

Changed "units" to "m"

2023-11-26T13:01:23Z

Wrap()

2023-11-25T01:19:47Z

2023-11-25T01:17:40Z

2023-11-24T18:56:39Z

Improved spacing, and fixed outline levels.

@@ Line 536: / Line 536: @@
 if (Math.DistToPlayer("Orb") < 12.0f) SetPlayerSanity(0.0f);
 // When the player is less than 12m away from the orb, they lose all sanity points.
 </syntaxhighlight>

@@ Line 526: / Line 526: @@
 ====DistToPlayer()====
 <syntaxhighlight lang="cpp">
-float Distance(string asEntity, enumLengthType aSquaredOption = lengthFinal)
+float DistToPlayer(string asEntity, enumLengthType aSquaredOption = lengthFinal)
 </syntaxhighlight>
 Returns the distance from an entity to the player.
@@ Line 534: / Line 534: @@
 <syntaxhighlight lang="cpp">
 // Example:
-if (Math.DistanceToPlayer("Orb") < 12.0f) SetPlayerSanity(0.0f);
+if (Math.DistToPlayer("Orb") < 12.0f) SetPlayerSanity(0.0f);
 // When the player is less than 12m away from the orb, they lose all sanity points.
 </syntaxhighlight>

@@ Line 901: / Line 901: @@
-====RotatePropToSpeedVec====
+====RotatePropToSpeedVec()====
 <syntaxhighlight lang="cpp">
 void RotatePropToSpeedVec(string asName, float afAcc, float afGoalSpeed, cVector avAxes, bool abResetSpeed = false, string& asOffsetArea = "")

@@ Line 815: / Line 815: @@
-===Vector uses===
+===Vector replacements===
 The following math methods are intended to replace some of the normal global functions that use separate X, Y and Z floats:
@@ Line 913: / Line 913: @@
 #''string asOffsetArea'' - The area to rotate around. If empty, the center of the body is used. '''(Optional, default = "")'''
 <br>
 ===Randomness===

@@ Line 499: / Line 499: @@
 cVector vMyRectangle = cVector(10.0f, 15.0f);
 float fMyHypotenuse = Math.Length(myRectangle);
-// fMyHypotenuse becomes the length of the diagonal line across a rectangle 10 by 15 units.
+// fMyHypotenuse becomes the length of the diagonal line across a rectangle 10m by 15m.
 // Example 2:
@@ Line 535: / Line 535: @@
 // Example:
 if (Math.DistanceToPlayer("Orb") < 12.0f) SetPlayerSanity(0.0f);
-// When the player is less than 12 units away from the orb, they lose all sanity points.
+// When the player is less than 12m away from the orb, they lose all sanity points.
 </syntaxhighlight>
@@ Line 587: / Line 587: @@
 // Example:
 Math.SetEntityPosVec("anvil", Math.GetPlayerPosVec() + cVector(0.0f, 3.0f, 0.0f));
-// Teleports the entity "anvil" to 3 units above the player.
+// Teleports the entity "anvil" to 3m above the player.
 </syntaxhighlight>
@@ Line 1,047: / Line 1,047: @@
 cVector vA = Math.RandomVectorInBounds(cVector(-5.0f, -5.0f, -5.0f), cVector(5.0f, 5.0f, 5.0f));
 cVector vB = Math.RandomVectorInBounds(cVector(-5.0f, 0.0f, 2.0f), cVector(5.0f, 10.0f, 2.0f));
-// vA becomes random position in a cube centred on 0,0,0, with a size of 10 units.
+// vA becomes random position in a cube centred on 0,0,0, with a size of 10m.
-// vB becomes random position on an x/y plane 2 units forward, -5,0,2...5,10,2.
+// vB becomes random position on an x/y plane 2m forward, -5,0,2...5,10,2.
 // Example 2:

@@ Line 279: / Line 279: @@
 <br>-1.25 wrapped between 0.0 and 1.0 will be 0.75.
 #''float afX, double adX, or int alX'' - The number to be wrapped.
-#''float afMin, double adMin, or int alMin'' - The lower boundary for wrapping. (Optional, float/double default = 0.0, int default = 0)
+#''float afMin, double adMin, or int alMin'' - The inclusive lower boundary for wrapping. (Optional, float/double default = 0.0, int default = 0)
-#''float afMax, double adMax, or int alMax'' - The upper boundary for wrapping. (Optional, float/double default = 1.0, int default = 100)
+#''float afMax, double adMax, or int alMax'' - The exclusive upper boundary for wrapping. (Optional, float/double default = 1.0, int default = 100)
 <syntaxhighlight lang="cpp">
 // Example:
@@ Line 286: / Line 286: @@
 float fB = -1.25f;
 int lC = 125;
 float fA_Wrapped = Math.Wrap(fA, 1.0, 2.0);
 float fB_Wrapped = Math.Wrap(fB);
 int lC_Wrapped = Math.Wrap(lC);
 // The value of fA_Wrapped will be 1.75f.
 // The value of fB_Wrapped will be 0.75f.
 // The value of lC_Wrapped will be 25.
 </syntaxhighlight>
 ===Rounding===