HPL3/Amnesia: Rebirth/Scripting/iXmlDocument

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

iXmlDocument has no public fields.

Functions

Return Type Function And Description
cXmlElement CreateChildElement(const tString &in asName)
cXmlText CreateChildText(const tString &in asText)
bool CreateFromFile(const tWString &in asPath)
bool GetAttributeBool(const tString &in asName, bool abDefault)
cColor GetAttributeColor(const tString &in asName, const cColor &in aDefault)
float GetAttributeFloat(const tString &in asName, float afDefault)
int GetAttributeInt(const tString &in asName, int alDefault)
tString GetAttributeString(const tString &in asName, const tString &in asDefault)
cVector2f GetAttributeVector2f(const tString &in asName, const cVector2f &in avDefault)
cVector3f GetAttributeVector3f(const tString &in asName, const cVector3f &in avDefault)
cXmlNodeListIterator GetChildIterator()
int GetErrorCol()
int GetErrorRow()
cXmlElement GetFirstElement()
cXmlElement GetFirstElement(const tString &in asName)
cXmlText GetFirstText()
cXmlText GetFirstText(const tString &in asText)
iXmlNode GetParent()
eXmlNodeType GetType()
tString GetValue()
bool Save()
bool SaveToFile(const tWString &in asPath)
void SetAttributeBool(const tString &in asName, bool abVal)
void SetAttributeColor(const tString &in asName, const cColor &in aVal)
void SetAttributeFloat(const tString &in asName, float afVal)
void SetAttributeInt(const tString &in asName, int alVal)
void SetAttributeString(const tString &in asName, const tString &in asVal)
void SetAttributeVector2f(const tString &in asName, const cVector2f &in avVal)
void SetAttributeVector3f(const tString &in asName, const cVector3f &in avVal)
void SetValue(const tString &in asValue)
cXmlElement ToElement()
cXmlText ToText()

Details

CreateChildElement

cXmlElement@ CreateChildElement(const tString &in asName)


Parameters

Returns:

  • cXmlElement@

CreateChildText

cXmlText@ CreateChildText(const tString &in asText)


Parameters

Returns:

  • cXmlText@

CreateFromFile

bool CreateFromFile(const tWString &in asPath)


Parameters

Returns:

  • bool

GetAttributeBool

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


Parameters

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

Returns:

  • bool

GetAttributeColor

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


Parameters

Returns:

  • cColor

GetAttributeFloat

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


Parameters

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

Returns:

  • float

GetAttributeInt

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


Parameters

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

Returns:

  • int

GetAttributeString

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


Parameters

Returns:

  • tString

GetAttributeVector2f

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


Parameters

Returns:

  • cVector2f

GetAttributeVector3f

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


Parameters

Returns:

  • cVector3f

GetChildIterator

cXmlNodeListIterator@ GetChildIterator()

Returns:

  • cXmlNodeListIterator@

GetErrorCol

int GetErrorCol()

Returns:

  • int

GetErrorRow

int GetErrorRow()

Returns:

  • int

GetFirstElement

cXmlElement@ GetFirstElement()

Returns:

  • cXmlElement@

GetFirstElement

cXmlElement@ GetFirstElement(const tString &in asName)


Parameters

Returns:

  • cXmlElement@

GetFirstText

cXmlText@ GetFirstText()

Returns:

  • cXmlText@

GetFirstText

cXmlText@ GetFirstText(const tString &in asText)


Parameters

Returns:

  • cXmlText@

GetParent

iXmlNode@ GetParent()

Returns:

  • iXmlNode@

GetType

eXmlNodeType GetType()

Returns:

  • eXmlNodeType

GetValue

const tString& GetValue()

Returns:

  • const tString&

Save

bool Save()

Returns:

  • bool

SaveToFile

bool SaveToFile(const tWString &in asPath)


Parameters

Returns:

  • bool

SetAttributeBool

void SetAttributeBool(const tString &in asName,
                      bool abVal)


Parameters

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

Returns:

  • void

SetAttributeColor

void SetAttributeColor(const tString &in asName,
                       const cColor &in aVal)


Parameters

Returns:

  • void

SetAttributeFloat

void SetAttributeFloat(const tString &in asName,
                       float afVal)


Parameters

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

Returns:

  • void

SetAttributeInt

void SetAttributeInt(const tString &in asName,
                     int alVal)


Parameters

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

Returns:

  • void

SetAttributeString

void SetAttributeString(const tString &in asName,
                        const tString &in asVal)


Parameters

Returns:

  • void

SetAttributeVector2f

void SetAttributeVector2f(const tString &in asName,
                          const cVector2f &in avVal)


Parameters

Returns:

  • void

SetAttributeVector3f

void SetAttributeVector3f(const tString &in asName,
                          const cVector3f &in avVal)


Parameters

Returns:

  • void

SetValue

void SetValue(const tString &in asValue)


Parameters

Returns:

  • void

ToElement

cXmlElement@ ToElement()

Returns:

  • cXmlElement@

ToText

cXmlText@ ToText()

Returns:

  • cXmlText@

References

See all references...