https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FScripting_Api%2FConstants
HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Constants - Revision history
2026-05-24T16:14:22Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Constants&diff=6129&oldid=prev
Abion47: Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Constant Summary== {{CodeDocSummaryTop}} {{CodeDoc..."
2020-11-15T22:56:14Z
<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Constant Summary== {{CodeDocSummaryTop}} {{CodeDoc..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Constant Summary==<br />
<br />
{{CodeDocSummaryTop}}<br />
{{CodeDocSummaryItem|[[../../cColor|cColor]]|[[#cColor_Blue|cColor_Blue]]|The RGBA value of blue.}}<br />
{{CodeDocSummaryItem|[[../../cColor|cColor]]|[[#cColor_Green|cColor_Green]]|The RGBA value of green.}}<br />
{{CodeDocSummaryItem|[[../../cColor|cColor]]|[[#cColor_Red|cColor_Red]]|The RGBA value of red.}}<br />
{{CodeDocSummaryItem|[[../../cColor|cColor]]|[[#cColor_White|cColor_White]]|The RGBA value of white.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_Epsilon|cMath_Epsilon]]|The value of correction for small floating point numbers.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_Pi|cMath_Pi]]|Approximate value of pi.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_PiDiv2|cMath_PiDiv2]]|Approximate value of pi divided by 2.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_PiDiv4|cMath_PiDiv4]]|Approximate value of pi divided by 4.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_PiMul2|cMath_PiMul2]]|Approximate value of pi multiplied by 2.}}<br />
{{CodeDocSummaryItem|float|[[#cMath_Sqrt2|cMath_Sqrt2]]|Approximate value of the square root of 2}}<br />
{{CodeDocSummaryItem|[[../../cMatrixf|cMatrixf]]|[[#cMatrixf_Identity|cMatrixf_Identity]]|The identity matrix.}}<br />
{{CodeDocSummaryItem|[[../../cMatrixf|cMatrixf]]|[[#cMatrixf_Zero|cMatrixf_Zero]]|A zero-filled matrix.}}<br />
{{CodeDocSummaryItem|[[../../cQuaternion|cQuaternion]]|[[#cQuaternion_Identity|cQuaternion_Identity]]|The quaternion identity.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_Down|cVector2f_Down]]|The down-facing 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_Left|cVector2f_Left]]|The left-facing 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_MinusOne|cVector2f_MinusOne]]|A negative-one-filled 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_One|cVector2f_One]]|A one-filled 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_Right|cVector2f_Right]]|The right-facing 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_Up|cVector2f_Up]]|The up-facing 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2f|cVector2f]]|[[#cVector2f_Zero|cVector2f_Zero]]|A zero-filled 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector2l|cVector2l]]|[[#cVector2l_MinusOne|cVector2l_MinusOne]]|A negative-one-filled 2D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Back|cVector3f_Back]]|The backward-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Down|cVector3f_Down]]|The down-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Forward|cVector3f_Forward]]|The forward-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Left|cVector3f_Left]]|The left-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_MinusOne|cVector3f_MinusOne]]|A negative-one-filled 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_One|cVector3f_One]]|A one-filled 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Right|cVector3f_Right]]|The right-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Up|cVector3f_Up]]|The up-facing 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector3f|cVector3f]]|[[#cVector3f_Zero|cVector3f_Zero]]|A zero-filled 3D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector4f|cVector4f]]|[[#cVector4f_MinusOne|cVector4f_MinusOne]]|A negative-one-filled 4D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector4f|cVector4f]]|[[#cVector4f_One|cVector4f_One]]|A one-filled 4D vector.}}<br />
{{CodeDocSummaryItem|[[../../cVector4f|cVector4f]]|[[#cVector4f_Zero|cVector4f_Zero]]|A zero-filled 4D vector.}}<br />
{{CodeDocSummaryItem|[[../../tID|tID]]|[[#tID_Invalid|tID_Invalid]]|The static value of an invalid tID.}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Constant Detail==<br />
<br />
{{CodeDocDetailTop|cColor_Blue}}<br />
<syntaxhighlight lang="c++">const cColor cColor_Blue = cColor(0.0, 0.0, 1.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The RGBA value of blue.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cColor_Green}}<br />
<syntaxhighlight lang="c++">const cColor cColor_Green = cColor(0.0, 1.0, 0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The RGBA value of green.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cColor_Red}}<br />
<syntaxhighlight lang="c++">const cColor cColor_Red = cColor(1.0, 0.0, 0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The RGBA value of red.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cColor_White}}<br />
<syntaxhighlight lang="c++">const cColor cColor_White = cColor(1.0, 1.0, 1.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The RGBA value of white.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_Epsilon}}<br />
<syntaxhighlight lang="c++">const float cMath_Epsilon = 0.0001</syntaxhighlight><br />
{{CodeDocDetailBody|<nowiki>The value of correction for small floating point numbers.</nowiki><br />
<br />
<nowiki>When two floats are subtracted, floating point errors can make the result not exact. (i.e. 3.0 - 2.0 == 1.0 may not strictly be true.) As such, if the difference between two floats is less than the value of cMath_Epsilon, those two floats can be considered equal.</nowiki>}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_Pi}}<br />
<syntaxhighlight lang="c++">const float cMath_Pi = 3.141593</syntaxhighlight><br />
{{CodeDocDetailBody|Approximate value of pi.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_PiDiv2}}<br />
<syntaxhighlight lang="c++">const float cMath_PiDiv2</syntaxhighlight><br />
{{CodeDocDetailBody|Approximate value of pi divided by 2.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_PiDiv4}}<br />
<syntaxhighlight lang="c++">const float cMath_PiDiv4</syntaxhighlight><br />
{{CodeDocDetailBody|Approximate value of pi divided by 4.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_PiMul2}}<br />
<syntaxhighlight lang="c++">const float cMath_PiMul2</syntaxhighlight><br />
{{CodeDocDetailBody|Approximate value of pi multiplied by 2.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMath_Sqrt2}}<br />
<syntaxhighlight lang="c++">const float cMath_Sqrt2</syntaxhighlight><br />
{{CodeDocDetailBody|Approximate value of the square root of 2.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMatrixf_Identity}}<br />
<syntaxhighlight lang="c++">const cMatrixf cMatrixf_Identity = cMatrixf(1.0, 0.0, 0.0, 0.0,<br />
0.0, 1.0, 0.0, 0.0,<br />
0.0, 0.0, 1.0, 0.0,<br />
0.0, 0.0, 0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The identity matrix.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cMatrixf_Zero}}<br />
<syntaxhighlight lang="c++">const cMatrixf cMatrixf_Zero = cMatrixf(0.0, 0.0, 0.0, 0.0,<br />
0.0, 0.0, 0.0, 0.0,<br />
0.0, 0.0, 0.0, 0.0,<br />
0.0, 0.0, 0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A zero-filled matrix.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cQuaternion_Identity}}<br />
<syntaxhighlight lang="c++">const cQuaternion cQuaternion_Identity = cQuaternion(0.0, 0.0, 0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The quaternion identity.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_Down}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_Down = cVector2f(0.0, -1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The down-facing 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_Left}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_Left = cVector2f(-1.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The left-facing 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_MinusOne}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_MinusOne = cVector2f(-1.0, -1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A negative-one-filled 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_One}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_One = cVector2f(1.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A one-filled 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_Right}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_Right = cVector2f(1.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The right-facing 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_Up}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_Up = cVector2f(0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The up-facing 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2f_Zero}}<br />
<syntaxhighlight lang="c++">const cVector2f cVector2f_Zero = cVector2f(0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A zero-filled 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector2l_MinusOne}}<br />
<syntaxhighlight lang="c++">const cVector2l cVector2l_MinusOne = cVector2l(-1, -1)</syntaxhighlight><br />
{{CodeDocDetailBody|A negative-one-filled 2D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Back}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Back = cVector3f(0.0, 0.0, -1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The backward-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Down}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Down = cVector3f(0.0, -1.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The down-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Forward}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Forward = cVector3f(0.0, 0.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The forward-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Left}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Left = cVector3f(-1.0, 0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The left-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_MinusOne}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_MinusOne = cVector3f(-1.0, -1.0, -1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A negative-one-filled 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_One}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_One = cVector3f(1.0, 1.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A one-filled 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Right}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Right = cVector3f(1.0, 0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The right-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Up}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Up = cVector3f(0.0, 1.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|The up-facing 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector3f_Zero}}<br />
<syntaxhighlight lang="c++">const cVector3f cVector3f_Zero = cVector3f(0.0, 0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A zero-filled 3D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector4f_MinusOne}}<br />
<syntaxhighlight lang="c++">const cVector4f cVector4f_MinusOne = cVector4f(-1.0, -1.0, -1.0, -1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A negative-one-filled 4D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector4f_One}}<br />
<syntaxhighlight lang="c++">const cVector4f cVector4f_One = cVector4f(1.0, 1.0, 1.0, 1.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A one-filled 4D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|cVector4f_Zero}}<br />
<syntaxhighlight lang="c++">const cVector4f cVector4f_Zero = cVector4f(0.0, 0.0, 0.0, 0.0)</syntaxhighlight><br />
{{CodeDocDetailBody|A zero-filled 4D vector.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|tID_Invalid}}<br />
<syntaxhighlight lang="c++">const tID tID_Invalid</syntaxhighlight><br />
{{CodeDocDetailBody|The static value of an invalid tID.}}<br />
{{CodeDocDetailBottom}}</div>
Abion47