https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FiScrPlayerState_Interface
HPL3/Amnesia: Rebirth/Scripting/iScrPlayerState Interface - Revision history
2026-05-14T08:29:18Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iScrPlayerState_Interface&diff=6104&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== iScrPlayerState_Interface has no public fi..."
2020-11-15T22:49:42Z
<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== iScrPlayerState_Interface has no public fi..."</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 />
iScrPlayerState_Interface has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|bool|[[#AllowBuoyancy|AllowBuoyancy]]([[../iPhysicsBody|iPhysicsBody@]] apBody)|}}<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|[[../cLuxPlayerState|cLuxPlayerState]]|[[#GetBase|GetBase]]()|}}<br />
{{CodeDocSummaryItem|void|[[#LoadUserConfig|LoadUserConfig]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#OnAction|OnAction]](int alAction, bool abPressed)|}}<br />
{{CodeDocSummaryItem|bool|[[#OnAnalogInput|OnAnalogInput]](int alAnalogId, const [[../cVector3f|cVector3f]] &in avAmount)|}}<br />
{{CodeDocSummaryItem|void|[[#OnEnterState|OnEnterState]](int alPrevStateId)|}}<br />
{{CodeDocSummaryItem|bool|[[#OnExitPressed|OnExitPressed]]()|}}<br />
{{CodeDocSummaryItem|void|[[#OnLeaveState|OnLeaveState]](int alNextStateId)|}}<br />
{{CodeDocSummaryItem|void|[[#OnMapEnter|OnMapEnter]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#OnMapLeave|OnMapLeave]]([[../cLuxMap|cLuxMap@]] apMap)|}}<br />
{{CodeDocSummaryItem|void|[[#PostUpdate|PostUpdate]](float afTimeStep)|}}<br />
{{CodeDocSummaryItem|void|[[#Reset|Reset]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SaveUserConfig|SaveUserConfig]]()|}}<br />
{{CodeDocSummaryItem|void|[[#Update|Update]](float afTimeStep)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|AllowBuoyancy}}<br />
<syntaxhighlight lang="c++">bool AllowBuoyancy(iPhysicsBody@ apBody)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apBody|[[../iPhysicsBody|iPhysicsBody@]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<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++">cLuxPlayerState@ GetBase()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cLuxPlayerState@|}}<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++">bool OnAction(int alAction,<br />
bool abPressed)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alAction|int|}}<br />
{{CodeDocDetailParam|abPressed|bool|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnAnalogInput}}<br />
<syntaxhighlight lang="c++">bool OnAnalogInput(int alAnalogId,<br />
const cVector3f &in avAmount)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alAnalogId|int|}}<br />
{{CodeDocDetailParam|avAmount|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnEnterState}}<br />
<syntaxhighlight lang="c++">void OnEnterState(int alPrevStateId)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alPrevStateId|int|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnExitPressed}}<br />
<syntaxhighlight lang="c++">bool OnExitPressed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|OnLeaveState}}<br />
<syntaxhighlight lang="c++">void OnLeaveState(int alNextStateId)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|alNextStateId|int|}}<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|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|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|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