HPL3/Amnesia: Rebirth/Scripting/cLuxUserModule

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:40, 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== {{CodeDocSummaryTop|Field Type|Field Name...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

Field Type Field Name And Description
int mlId

Functions

Return Type Function And Description
void CheckLineOfSight(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avEnd, bool abCheckOnlyShadowCasters, bool abCheckStaticOnly, int alUserValue = 0, iLuxEntity@ apSkipEntity = null)
void Fader_ClearAll()
void Fader_FadeTo(uint alID, float afGoal, float afTime, bool abReverseAtEnd = false, bool abSkipIfExists = false)
void Fader_FadeTo(const tString &in asName, float afGoal, float afTime, bool abReverseAtEnd = false, bool abSkipIfExists = false)
float Fader_GetValue(uint alID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
float Fader_GetValue(const tString &in asName, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
void Fader_Set(uint alID, float afX, bool abSkipIfExists = false)
void Fader_Set(const tString &in asName, float afX, bool abSkipIfExists = false)
void Fader_SetPaused(uint alID, bool abPaused)
void Fader_SetPaused(const tString &in asName, bool abPaused)
void SetScriptableIsSaved(bool abX)
void Timer_Add(uint64 alID, float afTime, const tString &in asFunc = "", bool abCreateIfExist = true, bool abRepeat = false)
void Timer_Add(const tString &in asID, float afTime, const tString &in asFunc = "", bool abCreateIfExist = true, bool abRepeat = false)
void Timer_ClearAll()
bool Timer_Exists(uint64 alID)
bool Timer_Exists(const tString &in asID)
float Timer_GetTimeLeft(uint64 alID)
float Timer_GetTimeLeft(const tString &in asID)
float Timer_GetValue(uint64 alID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
float Timer_GetValue(const tString &in asID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
void Timer_Remove(uint64 alID)
void Timer_Remove(const tString &in asID)
void Timer_SetPaused(uint64 alID, bool abX)
void Timer_SetPaused(const tString &in asID, bool abX)
bool Timer_TimeHasPassed(uint64 alID, float afLength)
bool Timer_TimeHasPassed(const tString &in asID, float afLength)

Details

CheckLineOfSight

void CheckLineOfSight(const tString &in asCallbackFunc,
                      const cVector3f &in avStart,
                      const cVector3f &in avEnd,
                      bool abCheckOnlyShadowCasters,
                      bool abCheckStaticOnly,
                      int alUserValue = 0,
                      iLuxEntity@ apSkipEntity = null)


Parameters

  • asCallbackFunc (tString) —
  • avStart (cVector3f) —
  • avEnd (cVector3f) —
  • abCheckOnlyShadowCasters (bool) —
  • abCheckStaticOnly (bool) —
  • alUserValue (int) —
  • apSkipEntity (iLuxEntity@) —

Returns:

  • void

Fader_ClearAll

void Fader_ClearAll()

Returns:

  • void

Fader_FadeTo

void Fader_FadeTo(uint alID,
                  float afGoal,
                  float afTime,
                  bool abReverseAtEnd = false,
                  bool abSkipIfExists = false)


Parameters

  • alID (uint) —
  • afGoal (float) —
  • afTime (float) —
  • abReverseAtEnd (bool) —
  • abSkipIfExists (bool) —

Returns:

  • void

Fader_FadeTo

void Fader_FadeTo(const tString &in asName,
                  float afGoal,
                  float afTime,
                  bool abReverseAtEnd = false,
                  bool abSkipIfExists = false)


Parameters

  • asName (tString) —
  • afGoal (float) —
  • afTime (float) —
  • abReverseAtEnd (bool) —
  • abSkipIfExists (bool) —

Returns:

  • void

Fader_GetValue

float Fader_GetValue(uint alID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)


Parameters

  • alID (uint) —
  • afMin (float) —
  • afMax (float) —
  • aEasing (eEasing) —
  • abAbsValue (bool) —

Returns:

  • float—

Fader_GetValue

float Fader_GetValue(const tString &in asName,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)


Parameters

  • asName (tString) —
  • afMin (float) —
  • afMax (float) —
  • aEasing (eEasing) —
  • abAbsValue (bool) —

Returns:

  • float—

Fader_Set

void Fader_Set(uint alID,
               float afX,
               bool abSkipIfExists = false)


Parameters

  • alID (uint) —
  • afX (float) —
  • abSkipIfExists (bool) —

Returns:

  • void

Fader_Set

void Fader_Set(const tString &in asName,
               float afX,
               bool abSkipIfExists = false)


Parameters

  • asName (tString) —
  • afX (float) —
  • abSkipIfExists (bool) —

Returns:

  • void

Fader_SetPaused

void Fader_SetPaused(uint alID,
                     bool abPaused)


Parameters

  • alID (uint) —
  • abPaused (bool) —

Returns:

  • void

Fader_SetPaused

void Fader_SetPaused(const tString &in asName,
                     bool abPaused)


Parameters

  • asName (tString) —
  • abPaused (bool) —

Returns:

  • void

mlId

int mlId

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

Timer_Add

void Timer_Add(uint64 alID,
               float afTime,
               const tString &in asFunc = "",
               bool abCreateIfExist = true,
               bool abRepeat = false)


Parameters

  • alID (uint64) —
  • afTime (float) —
  • asFunc (tString) —
  • abCreateIfExist (bool) —
  • abRepeat (bool) —

Returns:

  • void

Timer_Add

void Timer_Add(const tString &in asID,
               float afTime,
               const tString &in asFunc = "",
               bool abCreateIfExist = true,
               bool abRepeat = false)


Parameters

  • asID (tString) —
  • afTime (float) —
  • asFunc (tString) —
  • abCreateIfExist (bool) —
  • abRepeat (bool) —

Returns:

  • void

Timer_ClearAll

void Timer_ClearAll()

Returns:

  • void

Timer_Exists

bool Timer_Exists(uint64 alID)


Parameters

  • alID (uint64) —

Returns:

  • bool—

Timer_Exists

bool Timer_Exists(const tString &in asID)


Parameters

Returns:

  • bool—

Timer_GetTimeLeft

float Timer_GetTimeLeft(uint64 alID)


Parameters

  • alID (uint64) —

Returns:

  • float—

Timer_GetTimeLeft

float Timer_GetTimeLeft(const tString &in asID)


Parameters

Returns:

  • float—

Timer_GetValue

float Timer_GetValue(uint64 alID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)


Parameters

  • alID (uint64) —
  • afMin (float) —
  • afMax (float) —
  • aEasing (eEasing) —
  • abAbsValue (bool) —

Returns:

  • float—

Timer_GetValue

float Timer_GetValue(const tString &in asID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)


Parameters

  • asID (tString) —
  • afMin (float) —
  • afMax (float) —
  • aEasing (eEasing) —
  • abAbsValue (bool) —

Returns:

  • float—

Timer_Remove

void Timer_Remove(uint64 alID)


Parameters

  • alID (uint64) —

Returns:

  • void

Timer_Remove

void Timer_Remove(const tString &in asID)


Parameters

Returns:

  • void

Timer_SetPaused

void Timer_SetPaused(uint64 alID,
                     bool abX)


Parameters

  • alID (uint64) —
  • abX (bool) —

Returns:

  • void

Timer_SetPaused

void Timer_SetPaused(const tString &in asID,
                     bool abX)


Parameters

Returns:

  • void

Timer_TimeHasPassed

bool Timer_TimeHasPassed(uint64 alID,
                         float afLength)


Parameters

  • alID (uint64) —
  • afLength (float) —

Returns:

  • bool—

Timer_TimeHasPassed

bool Timer_TimeHasPassed(const tString &in asID,
                         float afLength)


Parameters

  • asID (tString) —
  • afLength (float) —

Returns:

  • bool—

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cLuxUserModule&oldid=5816"