HPL3/Amnesia: Rebirth/Scripting/cAnimationState

From Frictional Wiki
Jump to navigation Jump to search

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.

Functions

Return Type Function And Description
void AddTimePosition(float afAdd)
bool DataIsInMeshFile()
void FadeIn(float afTime)
void FadeOut(float afTime)
void FadeSpeed(float afSpeed, float afTime)
cAnimation GetAnimation()
bool GetApplyRootMotionToBone()
bool GetApplyRootMotionToEntity()
float GetBaseSpeed()
float GetFadeStep()
float GetLength()
tString GetName()
float GetPreviousTimePosition()
float GetRelativeTimePosition()
float GetSpeed()
float GetTimePosition()
float GetWeight()
bool IsActive()
bool IsFading()
bool IsLooping()
bool IsOver()
bool IsPaused()
void SetActive(bool abActive)
void SetApplyRootMotionToBone(bool abX)
void SetApplyRootMotionToEntity(bool abX)
void SetBaseSpeed(float afSpeed)
void SetFadeStep(float afX)
void SetLength(float afLength)
void SetLoop(bool abLoop)
void SetPaused(bool abPaused)
void SetRelativeTimePosition(float afPosition)
void SetSpeed(float afSpeed)
void SetTimePosition(float afPosition)
void SetWeight(float afWeight)
void Update(float afTimeStep)

Details

AddTimePosition

void AddTimePosition(float afAdd)


Parameters

  • afAdd (float) —

Returns:

  • void

DataIsInMeshFile

bool DataIsInMeshFile()

Returns:

  • bool

FadeIn

void FadeIn(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

FadeOut

void FadeOut(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

FadeSpeed

void FadeSpeed(float afSpeed,
               float afTime)


Parameters

  • afSpeed (float) —
  • afTime (float) —

Returns:

  • void

GetAnimation

cAnimation@ GetAnimation()

Returns:

  • cAnimation@

GetApplyRootMotionToBone

bool GetApplyRootMotionToBone()

Returns:

  • bool

GetApplyRootMotionToEntity

bool GetApplyRootMotionToEntity()

Returns:

  • bool

GetBaseSpeed

float GetBaseSpeed()

Returns:

  • float

GetFadeStep

float GetFadeStep()

Returns:

  • float

GetLength

float GetLength()

Returns:

  • float

GetName

const tString& GetName()

Returns:

  • const tString&

GetPreviousTimePosition

float GetPreviousTimePosition()

Returns:

  • float

GetRelativeTimePosition

float GetRelativeTimePosition()

Returns:

  • float

GetSpeed

float GetSpeed()

Returns:

  • float

GetTimePosition

float GetTimePosition()

Returns:

  • float

GetWeight

float GetWeight()

Returns:

  • float

IsActive

bool IsActive()

Returns:

  • bool

IsFading

bool IsFading()

Returns:

  • bool

IsLooping

bool IsLooping()

Returns:

  • bool

IsOver

bool IsOver()

Returns:

  • bool

IsPaused

bool IsPaused()

Returns:

  • bool

SetActive

void SetActive(bool abActive)


Parameters

  • abActive (bool) —

Returns:

  • void

SetApplyRootMotionToBone

void SetApplyRootMotionToBone(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetApplyRootMotionToEntity

void SetApplyRootMotionToEntity(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetBaseSpeed

void SetBaseSpeed(float afSpeed)


Parameters

  • afSpeed (float) —

Returns:

  • void

SetFadeStep

void SetFadeStep(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetLength

void SetLength(float afLength)


Parameters

  • afLength (float) —

Returns:

  • void

SetLoop

void SetLoop(bool abLoop)


Parameters

  • abLoop (bool) —

Returns:

  • void

SetPaused

void SetPaused(bool abPaused)


Parameters

  • abPaused (bool) —

Returns:

  • void

SetRelativeTimePosition

void SetRelativeTimePosition(float afPosition)


Parameters

  • afPosition (float) —

Returns:

  • void

SetSpeed

void SetSpeed(float afSpeed)


Parameters

  • afSpeed (float) —

Returns:

  • void

SetTimePosition

void SetTimePosition(float afPosition)


Parameters

  • afPosition (float) —

Returns:

  • void

SetWeight

void SetWeight(float afWeight)


Parameters

  • afWeight (float) —

Returns:

  • void

Update

void Update(float afTimeStep)


Parameters

  • afTimeStep (float) —

Returns:

  • void

References

See all references...