https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FiXmlDocument
HPL3/Amnesia: Rebirth/Scripting/iXmlDocument - Revision history
2026-05-02T20:47:15Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iXmlDocument&diff=6124&oldid=prev
Abion47: Created page with "{{ScriptingStub}} 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. ==Func..."
2020-11-15T22:53:37Z
<p>Created page with "{{ScriptingStub}} 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. ==Func..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Fields==<br />
iXmlDocument has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|[[../cXmlElement|cXmlElement]]|[[#CreateChildElement|CreateChildElement]](const [[../tString|tString]] &in asName)|}}<br />
{{CodeDocSummaryItem|[[../cXmlText|cXmlText]]|[[#CreateChildText|CreateChildText]](const [[../tString|tString]] &in asText)|}}<br />
{{CodeDocSummaryItem|bool|[[#CreateFromFile|CreateFromFile]](const [[../tWString|tWString]] &in asPath)|}}<br />
{{CodeDocSummaryItem|bool|[[#GetAttributeBool|GetAttributeBool]](const [[../tString|tString]] &in asName, bool abDefault)|}}<br />
{{CodeDocSummaryItem|[[../cColor|cColor]]|[[#GetAttributeColor|GetAttributeColor]](const [[../tString|tString]] &in asName, const [[../cColor|cColor]] &in aDefault)|}}<br />
{{CodeDocSummaryItem|float|[[#GetAttributeFloat|GetAttributeFloat]](const [[../tString|tString]] &in asName, float afDefault)|}}<br />
{{CodeDocSummaryItem|int|[[#GetAttributeInt|GetAttributeInt]](const [[../tString|tString]] &in asName, int alDefault)|}}<br />
{{CodeDocSummaryItem|[[../tString|tString]]|[[#GetAttributeString|GetAttributeString]](const [[../tString|tString]] &in asName, const [[../tString|tString]] &in asDefault)|}}<br />
{{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#GetAttributeVector2f|GetAttributeVector2f]](const [[../tString|tString]] &in asName, const [[../cVector2f|cVector2f]] &in avDefault)|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetAttributeVector3f|GetAttributeVector3f]](const [[../tString|tString]] &in asName, const [[../cVector3f|cVector3f]] &in avDefault)|}}<br />
{{CodeDocSummaryItem|[[../cXmlNodeListIterator|cXmlNodeListIterator]]|[[#GetChildIterator|GetChildIterator]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetErrorCol|GetErrorCol]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetErrorRow|GetErrorRow]]()|}}<br />
{{CodeDocSummaryItem|[[../cXmlElement|cXmlElement]]|[[#GetFirstElement|GetFirstElement]]()|}}<br />
{{CodeDocSummaryItem|[[../cXmlElement|cXmlElement]]|[[#GetFirstElement|GetFirstElement]](const [[../tString|tString]] &in asName)|}}<br />
{{CodeDocSummaryItem|[[../cXmlText|cXmlText]]|[[#GetFirstText|GetFirstText]]()|}}<br />
{{CodeDocSummaryItem|[[../cXmlText|cXmlText]]|[[#GetFirstText|GetFirstText]](const [[../tString|tString]] &in asText)|}}<br />
{{CodeDocSummaryItem|[[../iXmlNode|iXmlNode]]|[[#GetParent|GetParent]]()|}}<br />
{{CodeDocSummaryItem|[[../eXmlNodeType|eXmlNodeType]]|[[#GetType|GetType]]()|}}<br />
{{CodeDocSummaryItem|[[../tString|tString]]|[[#GetValue|GetValue]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#Save|Save]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#SaveToFile|SaveToFile]](const [[../tWString|tWString]] &in asPath)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeBool|SetAttributeBool]](const [[../tString|tString]] &in asName, bool abVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeColor|SetAttributeColor]](const [[../tString|tString]] &in asName, const [[../cColor|cColor]] &in aVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeFloat|SetAttributeFloat]](const [[../tString|tString]] &in asName, float afVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeInt|SetAttributeInt]](const [[../tString|tString]] &in asName, int alVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeString|SetAttributeString]](const [[../tString|tString]] &in asName, const [[../tString|tString]] &in asVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeVector2f|SetAttributeVector2f]](const [[../tString|tString]] &in asName, const [[../cVector2f|cVector2f]] &in avVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetAttributeVector3f|SetAttributeVector3f]](const [[../tString|tString]] &in asName, const [[../cVector3f|cVector3f]] &in avVal)|}}<br />
{{CodeDocSummaryItem|void|[[#SetValue|SetValue]](const [[../tString|tString]] &in asValue)|}}<br />
{{CodeDocSummaryItem|[[../cXmlElement|cXmlElement]]|[[#ToElement|ToElement]]()|}}<br />
{{CodeDocSummaryItem|[[../cXmlText|cXmlText]]|[[#ToText|ToText]]()|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|CreateChildElement}}<br />
<syntaxhighlight lang="c++">cXmlElement@ CreateChildElement(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|cXmlElement@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CreateChildText}}<br />
<syntaxhighlight lang="c++">cXmlText@ CreateChildText(const tString &in asText)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asText|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|cXmlText@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|CreateFromFile}}<br />
<syntaxhighlight lang="c++">bool CreateFromFile(const tWString &in asPath)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPath|[[../tWString|tWString]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeBool}}<br />
<syntaxhighlight lang="c++">bool GetAttributeBool(const tString &in asName,<br />
bool abDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|abDefault|bool|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeColor}}<br />
<syntaxhighlight lang="c++">cColor GetAttributeColor(const tString &in asName,<br />
const cColor &in aDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|aDefault|[[../cColor|cColor]]|}}<br />
{{CodeDocDetailReturn|cColor|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeFloat}}<br />
<syntaxhighlight lang="c++">float GetAttributeFloat(const tString &in asName,<br />
float afDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|afDefault|float|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeInt}}<br />
<syntaxhighlight lang="c++">int GetAttributeInt(const tString &in asName,<br />
int alDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|alDefault|int|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeString}}<br />
<syntaxhighlight lang="c++">tString GetAttributeString(const tString &in asName,<br />
const tString &in asDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|asDefault|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|tString|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeVector2f}}<br />
<syntaxhighlight lang="c++">cVector2f GetAttributeVector2f(const tString &in asName,<br />
const cVector2f &in avDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|avDefault|[[../cVector2f|cVector2f]]|}}<br />
{{CodeDocDetailReturn|cVector2f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAttributeVector3f}}<br />
<syntaxhighlight lang="c++">cVector3f GetAttributeVector3f(const tString &in asName,<br />
const cVector3f &in avDefault)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|avDefault|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|cVector3f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetChildIterator}}<br />
<syntaxhighlight lang="c++">cXmlNodeListIterator@ GetChildIterator()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cXmlNodeListIterator@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetErrorCol}}<br />
<syntaxhighlight lang="c++">int GetErrorCol()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetErrorRow}}<br />
<syntaxhighlight lang="c++">int GetErrorRow()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFirstElement}}<br />
<syntaxhighlight lang="c++">cXmlElement@ GetFirstElement()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cXmlElement@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFirstElement}}<br />
<syntaxhighlight lang="c++">cXmlElement@ GetFirstElement(const tString &in asName)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|cXmlElement@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFirstText}}<br />
<syntaxhighlight lang="c++">cXmlText@ GetFirstText()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cXmlText@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetFirstText}}<br />
<syntaxhighlight lang="c++">cXmlText@ GetFirstText(const tString &in asText)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asText|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|cXmlText@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetParent}}<br />
<syntaxhighlight lang="c++">iXmlNode@ GetParent()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|iXmlNode@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetType}}<br />
<syntaxhighlight lang="c++">eXmlNodeType GetType()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|eXmlNodeType|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetValue}}<br />
<syntaxhighlight lang="c++">const tString& GetValue()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const tString&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|Save}}<br />
<syntaxhighlight lang="c++">bool Save()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SaveToFile}}<br />
<syntaxhighlight lang="c++">bool SaveToFile(const tWString &in asPath)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPath|[[../tWString|tWString]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeBool}}<br />
<syntaxhighlight lang="c++">void SetAttributeBool(const tString &in asName,<br />
bool abVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|abVal|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeColor}}<br />
<syntaxhighlight lang="c++">void SetAttributeColor(const tString &in asName,<br />
const cColor &in aVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|aVal|[[../cColor|cColor]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeFloat}}<br />
<syntaxhighlight lang="c++">void SetAttributeFloat(const tString &in asName,<br />
float afVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|afVal|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeInt}}<br />
<syntaxhighlight lang="c++">void SetAttributeInt(const tString &in asName,<br />
int alVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|alVal|int|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeString}}<br />
<syntaxhighlight lang="c++">void SetAttributeString(const tString &in asName,<br />
const tString &in asVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|asVal|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeVector2f}}<br />
<syntaxhighlight lang="c++">void SetAttributeVector2f(const tString &in asName,<br />
const cVector2f &in avVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|avVal|[[../cVector2f|cVector2f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAttributeVector3f}}<br />
<syntaxhighlight lang="c++">void SetAttributeVector3f(const tString &in asName,<br />
const cVector3f &in avVal)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br />
{{CodeDocDetailParam|avVal|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetValue}}<br />
<syntaxhighlight lang="c++">void SetValue(const tString &in asValue)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asValue|[[../tString|tString]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ToElement}}<br />
<syntaxhighlight lang="c++">cXmlElement@ ToElement()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cXmlElement@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ToText}}<br />
<syntaxhighlight lang="c++">cXmlText@ ToText()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cXmlText@|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3RebirthScriptingCategories}}</div>
Abion47