HPL3/Amnesia: Rebirth/Scripting/cResourceVarsObject

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

cResourceVarsObject has no public fields.

Functions

Return Type Function And Description
void AddVarBool(const tString &in asName, bool abDefault)
void AddVarColor(const tString &in asName, const cColor &in aDefault)
void AddVarFloat(const tString &in asName, float afDefault = 0)
void AddVarInt(const tString &in asName, int alDefault)
void AddVarString(const tString &in asName, const tString &in alDefault)
void AddVarVector2f(const tString &in asName, const cVector2f &in avDefault)
void AddVarVector3f(const tString &in asName, const cVector3f &in avDefault)
bool GetVarBool(const tString &in asName, bool abDefault)
cColor GetVarColor(const tString &in asName, const cColor &in aDefault)
float GetVarFloat(const tString &in asName, float afDefault)
int GetVarInt(const tString &in asName, int alDefault)
tString GetVarString(const tString &in asName, const tString &in asDefault)
cVector2f GetVarVector2f(const tString &in asName, const cVector2f &in avDefault)
cVector3f GetVarVector3f(const tString &in asName, const cVector3f &in avDefault)

Details

AddVarBool

void AddVarBool(const tString &in asName,
                bool abDefault)


Parameters

  • asName (tString) —
  • abDefault (bool) —

Returns:

  • void

AddVarColor

void AddVarColor(const tString &in asName,
                 const cColor &in aDefault)


Parameters

Returns:

  • void

AddVarFloat

void AddVarFloat(const tString &in asName,
                 float afDefault = 0)


Parameters

  • asName (tString) —
  • afDefault (float) —

Returns:

  • void

AddVarInt

void AddVarInt(const tString &in asName,
               int alDefault)


Parameters

  • asName (tString) —
  • alDefault (int) —

Returns:

  • void

AddVarString

void AddVarString(const tString &in asName,
                  const tString &in alDefault)


Parameters

Returns:

  • void

AddVarVector2f

void AddVarVector2f(const tString &in asName,
                    const cVector2f &in avDefault)


Parameters

Returns:

  • void

AddVarVector3f

void AddVarVector3f(const tString &in asName,
                    const cVector3f &in avDefault)


Parameters

Returns:

  • void

GetVarBool

bool GetVarBool(const tString &in asName,
                bool abDefault)


Parameters

  • asName (tString) —
  • abDefault (bool) —

Returns:

  • bool

GetVarColor

cColor GetVarColor(const tString &in asName,
                   const cColor &in aDefault)


Parameters

Returns:

  • cColor

GetVarFloat

float GetVarFloat(const tString &in asName,
                  float afDefault)


Parameters

  • asName (tString) —
  • afDefault (float) —

Returns:

  • float

GetVarInt

int GetVarInt(const tString &in asName,
              int alDefault)


Parameters

  • asName (tString) —
  • alDefault (int) —

Returns:

  • int

GetVarString

tString GetVarString(const tString &in asName,
                     const tString &in asDefault)


Parameters

Returns:

  • tString

GetVarVector2f

cVector2f GetVarVector2f(const tString &in asName,
                         const cVector2f &in avDefault)


Parameters

Returns:

  • cVector2f

GetVarVector3f

cVector3f GetVarVector3f(const tString &in asName,
                         const cVector3f &in avDefault)


Parameters

Returns:

  • cVector3f

References

See all references...