Documentation
XML

XML

All Lua functions and events in the XML category, on the server and the client.

Shared functions 18

xmlCopyFileCopies a node (with its children and attributes) into a new document at a new path. The copied node becomes the root of the new document, which must be saved with xmlSaveFile.
xmlCreateChildAdds a new child node with the given name at the end of the parent's children.
xmlCreateFileCreates a new XML document with a root node of the given name. The document is in memory; it reaches the disk only after xmlSaveFile. An existing file is overwritten on save.
xmlDestroyNodeRemoves a node together with its children. The root node cannot be removed.
xmlFindChildFinds a child with the given tag name. index picks which one (from 0) among children with that name.
xmlLoadFileLoads an XML file and returns its root node, from which you can read children and attributes. On the server the path is relative to the resource folder (you cannot leave it). On the client it reads the script's own files and then <file> files sent by the server; a ":other/file.xml" path points to another resource's file. Remember xmlUnloadFile when the document is no longer needed.
xmlLoadStringLoads an XML document directly from a string (e.g. received with fetchRemote), read-only. Returns the root node.
xmlNodeGetAttributeReturns the value of a node attribute as text (convert numbers with tonumber).
xmlNodeGetAttributesReturns all node attributes as a name → value table.
xmlNodeGetChildrenWithout an index returns a table of all the node's children; with an index (from 0) - one child.
xmlNodeGetNameReturns the node's tag name (e.g. "spawn" for <spawn/>).
xmlNodeGetParentReturns the node's parent.
xmlNodeGetValueReturns the text inside a node (e.g. "Hello" for <msg>Hello</msg>).
xmlNodeSetAttributeSets a node attribute; numbers and other values are converted to text. nil or false removes the attribute.
xmlNodeSetNameChanges the node's tag name.
xmlNodeSetValueSets the text inside a node (replaces the previous one).
xmlSaveFileSaves the whole document (that the node belongs to) to its file. Does not work for read-only documents or those from xmlLoadString.
xmlUnloadFileFrees a document from memory. All its nodes become invalid. Unsaved changes are lost.