HPL3/Amnesia: Rebirth/Scripting/cConfigFile

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

• asLevel (tString) —

Returns:

• void

EraseValue

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

Parameters

• asLevel (tString) —
• asName (tString) —

Returns:

• void

GetBool

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

Parameters

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

Returns:

• bool—

GetColor

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

Parameters

• asLevel (tString) —
• asName (tString) —
• aDefault (cColor) —

Returns:

• cColor—

GetFileLocation

const tWString& GetFileLocation()

Returns:

• const tWString&—

GetFloat

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

Parameters

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

Returns:

• float—

GetInt

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

Parameters

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

Returns:

• int—

GetString

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

Parameters

• asLevel (tString) —
• asName (tString) —
• asDefault (tString) —

Returns:

• tString—

GetStringW

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

Parameters

• asLevel (tString) —
• asName (tString) —
• asDefault (tWString) —

Returns:

• tWString—

GetVector2f

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avDefault (cVector2f) —

Returns:

• cVector2f—

GetVector2l

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avDefault (cVector2l) —

Returns:

• cVector2l—

GetVector3f

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avDefault (cVector3f) —

Returns:

• cVector3f—

GetVector3l

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avDefault (cVector3l) —

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

• asLevel (tString) —
• asName (tString) —
• abVal (bool) —

Returns:

• void

SetColor

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

Parameters

• asLevel (tString) —
• asName (tString) —
• aVal (cColor) —

Returns:

• void

SetFileLocation

void SetFileLocation(const tWString &in asFile)

Parameters

• asFile (tWString) —

Returns:

• void

SetFloat

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

Parameters

• asLevel (tString) —
• asName (tString) —
• afVal (float) —

Returns:

• void

SetInt

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

Parameters

• asLevel (tString) —
• asName (tString) —
• alVal (int) —

Returns:

• void

SetString

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

Parameters

• asLevel (tString) —
• asName (tString) —
• asVal (tString) —

Returns:

• void

SetVector2f

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avVal (cVector2f) —

Returns:

• void

SetVector2l

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avVal (cVector2l) —

Returns:

• void

SetVector3f

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avVal (cVector3f) —

Returns:

• void

SetVector3l

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

Parameters

• asLevel (tString) —
• asName (tString) —
• avVal (cVector3l) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrInputHandler Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...