https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FcAnimationState
HPL3/Amnesia: Rebirth/Scripting/cAnimationState - Revision history
2026-05-01T14:59:59Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cAnimationState&diff=5657&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== cAnimationState has no public fields. ==F..."
2020-11-15T21:00:39Z
<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== cAnimationState has no public fields. ==F..."</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 />
cAnimationState has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|void|[[#AddTimePosition|AddTimePosition]](float afAdd)|}}<br />
{{CodeDocSummaryItem|bool|[[#DataIsInMeshFile|DataIsInMeshFile]]()|}}<br />
{{CodeDocSummaryItem|void|[[#FadeIn|FadeIn]](float afTime)|}}<br />
{{CodeDocSummaryItem|void|[[#FadeOut|FadeOut]](float afTime)|}}<br />
{{CodeDocSummaryItem|void|[[#FadeSpeed|FadeSpeed]](float afSpeed, float afTime)|}}<br />
{{CodeDocSummaryItem|[[../cAnimation|cAnimation]]|[[#GetAnimation|GetAnimation]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetApplyRootMotionToBone|GetApplyRootMotionToBone]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetApplyRootMotionToEntity|GetApplyRootMotionToEntity]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetBaseSpeed|GetBaseSpeed]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetFadeStep|GetFadeStep]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetLength|GetLength]]()|}}<br />
{{CodeDocSummaryItem|[[../tString|tString]]|[[#GetName|GetName]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetPreviousTimePosition|GetPreviousTimePosition]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetRelativeTimePosition|GetRelativeTimePosition]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetSpeed|GetSpeed]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetTimePosition|GetTimePosition]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetWeight|GetWeight]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsActive|IsActive]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsFading|IsFading]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsLooping|IsLooping]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsOver|IsOver]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#IsPaused|IsPaused]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SetActive|SetActive]](bool abActive)|}}<br />
{{CodeDocSummaryItem|void|[[#SetApplyRootMotionToBone|SetApplyRootMotionToBone]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetApplyRootMotionToEntity|SetApplyRootMotionToEntity]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetBaseSpeed|SetBaseSpeed]](float afSpeed)|}}<br />
{{CodeDocSummaryItem|void|[[#SetFadeStep|SetFadeStep]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetLength|SetLength]](float afLength)|}}<br />
{{CodeDocSummaryItem|void|[[#SetLoop|SetLoop]](bool abLoop)|}}<br />
{{CodeDocSummaryItem|void|[[#SetPaused|SetPaused]](bool abPaused)|}}<br />
{{CodeDocSummaryItem|void|[[#SetRelativeTimePosition|SetRelativeTimePosition]](float afPosition)|}}<br />
{{CodeDocSummaryItem|void|[[#SetSpeed|SetSpeed]](float afSpeed)|}}<br />
{{CodeDocSummaryItem|void|[[#SetTimePosition|SetTimePosition]](float afPosition)|}}<br />
{{CodeDocSummaryItem|void|[[#SetWeight|SetWeight]](float afWeight)|}}<br />
{{CodeDocSummaryItem|void|[[#Update|Update]](float afTimeStep)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|AddTimePosition}}<br />
<syntaxhighlight lang="c++">void AddTimePosition(float afAdd)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afAdd|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|DataIsInMeshFile}}<br />
<syntaxhighlight lang="c++">bool DataIsInMeshFile()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|FadeIn}}<br />
<syntaxhighlight lang="c++">void FadeIn(float afTime)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|FadeOut}}<br />
<syntaxhighlight lang="c++">void FadeOut(float afTime)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|FadeSpeed}}<br />
<syntaxhighlight lang="c++">void FadeSpeed(float afSpeed,<br />
float afTime)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afSpeed|float|}}<br />
{{CodeDocDetailParam|afTime|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAnimation}}<br />
<syntaxhighlight lang="c++">cAnimation@ GetAnimation()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cAnimation@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetApplyRootMotionToBone}}<br />
<syntaxhighlight lang="c++">bool GetApplyRootMotionToBone()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetApplyRootMotionToEntity}}<br />
<syntaxhighlight lang="c++">bool GetApplyRootMotionToEntity()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetBaseSpeed}}<br />
<syntaxhighlight lang="c++">float GetBaseSpeed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFadeStep}}<br />
<syntaxhighlight lang="c++">float GetFadeStep()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetLength}}<br />
<syntaxhighlight lang="c++">float GetLength()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetName}}<br />
<syntaxhighlight lang="c++">const tString& GetName()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const tString&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetPreviousTimePosition}}<br />
<syntaxhighlight lang="c++">float GetPreviousTimePosition()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetRelativeTimePosition}}<br />
<syntaxhighlight lang="c++">float GetRelativeTimePosition()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetSpeed}}<br />
<syntaxhighlight lang="c++">float GetSpeed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetTimePosition}}<br />
<syntaxhighlight lang="c++">float GetTimePosition()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetWeight}}<br />
<syntaxhighlight lang="c++">float GetWeight()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsActive}}<br />
<syntaxhighlight lang="c++">bool IsActive()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsFading}}<br />
<syntaxhighlight lang="c++">bool IsFading()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsLooping}}<br />
<syntaxhighlight lang="c++">bool IsLooping()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsOver}}<br />
<syntaxhighlight lang="c++">bool IsOver()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|IsPaused}}<br />
<syntaxhighlight lang="c++">bool IsPaused()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetActive}}<br />
<syntaxhighlight lang="c++">void SetActive(bool abActive)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abActive|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetApplyRootMotionToBone}}<br />
<syntaxhighlight lang="c++">void SetApplyRootMotionToBone(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetApplyRootMotionToEntity}}<br />
<syntaxhighlight lang="c++">void SetApplyRootMotionToEntity(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetBaseSpeed}}<br />
<syntaxhighlight lang="c++">void SetBaseSpeed(float afSpeed)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afSpeed|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetFadeStep}}<br />
<syntaxhighlight lang="c++">void SetFadeStep(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetLength}}<br />
<syntaxhighlight lang="c++">void SetLength(float afLength)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afLength|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetLoop}}<br />
<syntaxhighlight lang="c++">void SetLoop(bool abLoop)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abLoop|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetPaused}}<br />
<syntaxhighlight lang="c++">void SetPaused(bool abPaused)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abPaused|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetRelativeTimePosition}}<br />
<syntaxhighlight lang="c++">void SetRelativeTimePosition(float afPosition)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afPosition|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetSpeed}}<br />
<syntaxhighlight lang="c++">void SetSpeed(float afSpeed)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afSpeed|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetTimePosition}}<br />
<syntaxhighlight lang="c++">void SetTimePosition(float afPosition)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afPosition|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetWeight}}<br />
<syntaxhighlight lang="c++">void SetWeight(float afWeight)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afWeight|float|}}<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 />
{{HPL3SOMAScriptingCategories}}</div>
Abion47