HPL3/Amnesia: Rebirth/Scripting/cLuxStateMachine

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:39, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cLuxStateMachine has no public fields. ==...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

cLuxStateMachine has no public fields.

Functions

Return Type Function And Description
void AddState(const tString &in asName, int alId)
void AddSubState(const tString &in asName, int alId)
void AddTimer(uint64 alId, float afTime)
void AddTimer(const tString &in asId, float afTime)
void ChangeState(int alState)
void ChangeSubState(int alState)
cLuxEntityMessageData GetCurrentMessageData()
int GetCurrentState()
tString GetCurrentStateName()
int GetCurrentSubState()
tString GetCurrentSubStateName()
iLuxEntity GetEntity()
int GetNextState()
int GetNextSubState()
int GetPrevState()
int GetPrevSubState()
int GetType()
void StopTimer(uint64 alId)
void StopTimer(const tString &in asId)
bool TimerExists(uint64 alId)
bool TimerExists(const tString &in asId)

Details

AddState

void AddState(const tString &in asName,
              int alId)


Parameters

  • asName (tString) —
  • alId (int) —

Returns:

  • void

AddSubState

void AddSubState(const tString &in asName,
                 int alId)


Parameters

  • asName (tString) —
  • alId (int) —

Returns:

  • void

AddTimer

void AddTimer(uint64 alId,
              float afTime)


Parameters

  • alId (uint64) —
  • afTime (float) —

Returns:

  • void

AddTimer

void AddTimer(const tString &in asId,
              float afTime)


Parameters

  • asId (tString) —
  • afTime (float) —

Returns:

  • void

ChangeState

void ChangeState(int alState)


Parameters

  • alState (int) —

Returns:

  • void

ChangeSubState

void ChangeSubState(int alState)


Parameters

  • alState (int) —

Returns:

  • void

GetCurrentMessageData

cLuxEntityMessageData@ GetCurrentMessageData()

Returns:

  • cLuxEntityMessageData@

GetCurrentState

int GetCurrentState()

Returns:

  • int

GetCurrentStateName

tString GetCurrentStateName()

Returns:

  • tString

GetCurrentSubState

int GetCurrentSubState()

Returns:

  • int

GetCurrentSubStateName

tString GetCurrentSubStateName()

Returns:

  • tString

GetEntity

iLuxEntity@ GetEntity()

Returns:

  • iLuxEntity@

GetNextState

int GetNextState()

Returns:

  • int

GetNextSubState

int GetNextSubState()

Returns:

  • int

GetPrevState

int GetPrevState()

Returns:

  • int

GetPrevSubState

int GetPrevSubState()

Returns:

  • int

GetType

int GetType()

Returns:

  • int

StopTimer

void StopTimer(uint64 alId)


Parameters

  • alId (uint64) —

Returns:

  • void

StopTimer

void StopTimer(const tString &in asId)


Parameters

Returns:

  • void

TimerExists

bool TimerExists(uint64 alId)


Parameters

  • alId (uint64) —

Returns:

  • bool

TimerExists

bool TimerExists(const tString &in asId)


Parameters

Returns:

  • bool

References

See all references...