HPL3/Amnesia: Rebirth/Scripting/cConfigFile

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

cConfigFile has no public fields.

Functions

Return Type Function And Description
void EraseAll()
void EraseSetting(const tString &in asLevel)
void EraseValue(const tString &in asLevel, const tString &in asName)
bool GetBool(const tString &in asLevel, const tString &in asName, bool abDefault)
cColor GetColor(const tString &in asLevel, const tString &in asName, const cColor &in aDefault)
tWString GetFileLocation()
float GetFloat(const tString &in asLevel, const tString &in asName, float afDefault)
int GetInt(const tString &in asLevel, const tString &in asName, int alDefault)
tString GetString(const tString &in asLevel, const tString &in asName, const tString &in asDefault)
tWString GetStringW(const tString &in asLevel, const tString &in asName, const tWString &in asDefault)
cVector2f GetVector2f(const tString &in asLevel, const tString &in asName, const cVector2f &in avDefault)
cVector2l GetVector2l(const tString &in asLevel, const tString &in asName, const cVector2l &in avDefault)
cVector3f GetVector3f(const tString &in asLevel, const tString &in asName, const cVector3f &in avDefault)
cVector3l GetVector3l(const tString &in asLevel, const tString &in asName, const cVector3l &in avDefault)
bool Load()
bool Save()
void SetBool(const tString &in asLevel, const tString &in asName, bool abVal)
void SetColor(const tString &in asLevel, const tString &in asName, const cColor &in aVal)
void SetFileLocation(const tWString &in asFile)
void SetFloat(const tString &in asLevel, const tString &in asName, float afVal)
void SetInt(const tString &in asLevel, const tString &in asName, int alVal)
void SetString(const tString &in asLevel, const tString &in asName, const tString &in asVal)
void SetVector2f(const tString &in asLevel, const tString &in asName, const cVector2f &in avVal)
void SetVector2l(const tString &in asLevel, const tString &in asName, const cVector2l &in avVal)
void SetVector3f(const tString &in asLevel, const tString &in asName, const cVector3f &in avVal)
void SetVector3l(const tString &in asLevel, const tString &in asName, const cVector3l &in avVal)

Details

EraseAll

void EraseAll()

Returns:

  • void

EraseSetting

void EraseSetting(const tString &in asLevel)


Parameters

Returns:

  • void

EraseValue

void EraseValue(const tString &in asLevel,
                const tString &in asName)


Parameters

Returns:

  • void

GetBool

bool GetBool(const tString &in asLevel,
             const tString &in asName,
             bool abDefault)


Parameters

Returns:

  • bool

GetColor

cColor GetColor(const tString &in asLevel,
                const tString &in asName,
                const cColor &in aDefault)


Parameters

Returns:

  • cColor

GetFileLocation

const tWString& GetFileLocation()

Returns:

  • const tWString&

GetFloat

float GetFloat(const tString &in asLevel,
               const tString &in asName,
               float afDefault)


Parameters

Returns:

  • float

GetInt

int GetInt(const tString &in asLevel,
           const tString &in asName,
           int alDefault)


Parameters

Returns:

  • int

GetString

tString GetString(const tString &in asLevel,
                  const tString &in asName,
                  const tString &in asDefault)


Parameters

Returns:

  • tString

GetStringW

tWString GetStringW(const tString &in asLevel,
                    const tString &in asName,
                    const tWString &in asDefault)


Parameters

Returns:

  • tWString

GetVector2f

cVector2f GetVector2f(const tString &in asLevel,
                      const tString &in asName,
                      const cVector2f &in avDefault)


Parameters

Returns:

  • cVector2f

GetVector2l

cVector2l GetVector2l(const tString &in asLevel,
                      const tString &in asName,
                      const cVector2l &in avDefault)


Parameters

Returns:

  • cVector2l

GetVector3f

cVector3f GetVector3f(const tString &in asLevel,
                      const tString &in asName,
                      const cVector3f &in avDefault)


Parameters

Returns:

  • cVector3f

GetVector3l

cVector3l GetVector3l(const tString &in asLevel,
                      const tString &in asName,
                      const cVector3l &in avDefault)


Parameters

Returns:

  • cVector3l

Load

bool Load()

Returns:

  • bool

Save

bool Save()

Returns:

  • bool

SetBool

void SetBool(const tString &in asLevel,
             const tString &in asName,
             bool abVal)


Parameters

Returns:

  • void

SetColor

void SetColor(const tString &in asLevel,
              const tString &in asName,
              const cColor &in aVal)


Parameters

Returns:

  • void

SetFileLocation

void SetFileLocation(const tWString &in asFile)


Parameters

Returns:

  • void

SetFloat

void SetFloat(const tString &in asLevel,
              const tString &in asName,
              float afVal)


Parameters

Returns:

  • void

SetInt

void SetInt(const tString &in asLevel,
            const tString &in asName,
            int alVal)


Parameters

Returns:

  • void

SetString

void SetString(const tString &in asLevel,
               const tString &in asName,
               const tString &in asVal)


Parameters

Returns:

  • void

SetVector2f

void SetVector2f(const tString &in asLevel,
                 const tString &in asName,
                 const cVector2f &in avVal)


Parameters

Returns:

  • void

SetVector2l

void SetVector2l(const tString &in asLevel,
                 const tString &in asName,
                 const cVector2l &in avVal)


Parameters

Returns:

  • void

SetVector3f

void SetVector3f(const tString &in asLevel,
                 const tString &in asName,
                 const cVector3f &in avVal)


Parameters

Returns:

  • void

SetVector3l

void SetVector3l(const tString &in asLevel,
                 const tString &in asName,
                 const cVector3l &in avVal)


Parameters

Returns:

  • void

References

See all references...