https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FiScrPlayer_Interface
HPL3/Amnesia: Rebirth/Scripting/iScrPlayer Interface - Revision history
2026-05-14T06:38:55Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iScrPlayer_Interface&diff=6103&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! ==Fields== iScrPlayer_Interface has no public fields...."
2020-11-15T22:49:32Z
<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== iScrPlayer_Interface has no public fields...."</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 />
==Fields==<br />
iScrPlayer_Interface has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|void|[[#CharBody_GravityCollide|CharBody_GravityCollide]]([[../iCharacterBody|iCharacterBody@]] apCharBody, [[../iPhysicsBody|iPhysicsBody@]] apBody, [[../cCollideData|cCollideData@]] apCollideData)|}}<br />
{{CodeDocSummaryItem|void|[[#CharBody_HitGround|CharBody_HitGround]]([[../iCharacterBody|iCharacterBody@]] apCharBody, const [[../cVector3f|cVector3f]] &in avVel)|}}<br />
{{CodeDocSummaryItem|void|[[#CreateWorldEntities|CreateWorldEntities]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#DestroyWorldEntities|DestroyWorldEntities]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|float|[[#DrawDebugOutput|DrawDebugOutput]]([[../cGuiSet|cGuiSet@]] apSet, [[../iFontData|iFontData@]] apFont, float afStartY)|}}<br />
{{CodeDocSummaryItem|[[../cLuxPlayer|cLuxPlayer]]|[[#GetBase|GetBase]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetCharacterState|GetCharacterState]]()|}}<br />
{{CodeDocSummaryItem|void|[[#LoadUserConfig|LoadUserConfig]]()|}}<br />
{{CodeDocSummaryItem|void|[[#OnAction|OnAction]](int alAction, bool abPressed)|}}<br />
{{CodeDocSummaryItem|void|[[#OnAnalogInput|OnAnalogInput]](int alAnalogId, const [[../cVector3f|cVector3f]] &in avAmount)|}}<br />
{{CodeDocSummaryItem|void|[[#OnDraw|OnDraw]](float afFrameTime)|}}<br />
{{CodeDocSummaryItem|void|[[#OnEnterContainer|OnEnterContainer]](const [[../tString|tString]] &in asOldContainer)|}}<br />
{{CodeDocSummaryItem|void|[[#OnExitPressed|OnExitPressed]]()|}}<br />
{{CodeDocSummaryItem|void|[[#OnLeaveContainer|OnLeaveContainer]](const [[../tString|tString]] &in asNewContainer)|}}<br />
{{CodeDocSummaryItem|void|[[#OnMapEnter|OnMapEnter]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#OnMapLeave|OnMapLeave]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#OnUnderwaterEffectActive|OnUnderwaterEffectActive]](bool abX, bool abUseStartAndEndEffects)|}}<br />
{{CodeDocSummaryItem|void|[[#PostUpdate|PostUpdate]](float afTimeStep)|}}<br />
{{CodeDocSummaryItem|void|[[#PreloadData|PreloadData]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#Reset|Reset]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SaveUserConfig|SaveUserConfig]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SetCharacterState|SetCharacterState]](int alState)|}}<br />
{{CodeDocSummaryItem|void|[[#SetupStartPos|SetupStartPos]](const [[../cVector3f|cVector3f]] &in avPos, float afAngle, bool abCrouching)|}}<br />
{{CodeDocSummaryItem|void|[[#Update|Update]](float afTimeStep)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|CharBody_GravityCollide}}<br />
<syntaxhighlight lang="c++">void CharBody_GravityCollide(iCharacterBody@ apCharBody,<br />
iPhysicsBody@ apBody,<br />
cCollideData@ apCollideData)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apCharBody|[[../iCharacterBody|iCharacterBody@]]|}}<br />
{{CodeDocDetailParam|apBody|[[../iPhysicsBody|iPhysicsBody@]]|}}<br />
{{CodeDocDetailParam|apCollideData|[[../cCollideData|cCollideData@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CharBody_HitGround}}<br />
<syntaxhighlight lang="c++">void CharBody_HitGround(iCharacterBody@ apCharBody,<br />
const cVector3f &in avVel)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apCharBody|[[../iCharacterBody|iCharacterBody@]]|}}<br />
{{CodeDocDetailParam|avVel|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CreateWorldEntities}}<br />
<syntaxhighlight lang="c++">void CreateWorldEntities(cLuxMap@ apMap)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apMap|[[../cLuxMap|cLuxMap@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|DestroyWorldEntities}}<br />
<syntaxhighlight lang="c++">void DestroyWorldEntities(cLuxMap@ apMap)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apMap|[[../cLuxMap|cLuxMap@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|DrawDebugOutput}}<br />
<syntaxhighlight lang="c++">float DrawDebugOutput(cGuiSet@ apSet,<br />
iFontData@ apFont,<br />
float afStartY)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apSet|[[../cGuiSet|cGuiSet@]]|}}<br />
{{CodeDocDetailParam|apFont|[[../iFontData|iFontData@]]|}}<br />
{{CodeDocDetailParam|afStartY|float|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetBase}}<br />
<syntaxhighlight lang="c++">cLuxPlayer@ GetBase()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cLuxPlayer@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetCharacterState}}<br />
<syntaxhighlight lang="c++">int GetCharacterState()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|LoadUserConfig}}<br />
<syntaxhighlight lang="c++">void LoadUserConfig()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnAction}}<br />
<syntaxhighlight lang="c++">void OnAction(int alAction,<br />
bool abPressed)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alAction|int|}}<br />
{{CodeDocDetailParam|abPressed|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnAnalogInput}}<br />
<syntaxhighlight lang="c++">void OnAnalogInput(int alAnalogId,<br />
const cVector3f &in avAmount)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alAnalogId|int|}}<br />
{{CodeDocDetailParam|avAmount|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnDraw}}<br />
<syntaxhighlight lang="c++">void OnDraw(float afFrameTime)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afFrameTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnEnterContainer}}<br />
<syntaxhighlight lang="c++">void OnEnterContainer(const tString &in asOldContainer)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asOldContainer|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnExitPressed}}<br />
<syntaxhighlight lang="c++">void OnExitPressed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnLeaveContainer}}<br />
<syntaxhighlight lang="c++">void OnLeaveContainer(const tString &in asNewContainer)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asNewContainer|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnMapEnter}}<br />
<syntaxhighlight lang="c++">void OnMapEnter(cLuxMap@ apMap)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apMap|[[../cLuxMap|cLuxMap@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnMapLeave}}<br />
<syntaxhighlight lang="c++">void OnMapLeave(cLuxMap@ apMap)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apMap|[[../cLuxMap|cLuxMap@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnUnderwaterEffectActive}}<br />
<syntaxhighlight lang="c++">void OnUnderwaterEffectActive(bool abX,<br />
bool abUseStartAndEndEffects)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailParam|abUseStartAndEndEffects|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|PostUpdate}}<br />
<syntaxhighlight lang="c++">void PostUpdate(float afTimeStep)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afTimeStep|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|PreloadData}}<br />
<syntaxhighlight lang="c++">void PreloadData(cLuxMap@ apMap)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apMap|[[../cLuxMap|cLuxMap@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Reset}}<br />
<syntaxhighlight lang="c++">void Reset()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SaveUserConfig}}<br />
<syntaxhighlight lang="c++">void SaveUserConfig()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetCharacterState}}<br />
<syntaxhighlight lang="c++">void SetCharacterState(int alState)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alState|int|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetupStartPos}}<br />
<syntaxhighlight lang="c++">void SetupStartPos(const cVector3f &in avPos,<br />
float afAngle,<br />
bool abCrouching)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avPos|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailParam|afAngle|float|}}<br />
{{CodeDocDetailParam|abCrouching|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Update}}<br />
<syntaxhighlight lang="c++">void Update(float afTimeStep)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afTimeStep|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3RebirthScriptingCategories}}</div>
Abion47