Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function is intended to load data from a loaded XML file into the element tree. This could be used for loading an external map, or part of another map.

Syntax

element loadMapData ( xmlnode node, element parent )

Required Arguments

• node: The node that you wish to load into the element tree .
• parent: The node you wish to be the parent of the new map data.

Returns

• element: value

Returns an element object that corresponds to the root of the new data added, i.e. an element that represents the node xmlnode passed to the function. Returns false if the arguments are invalid.

Code Examples

Example 1 Example 2

shared

Example 1:This example is a function that you could use to load an arbitarymap fileinto theelement tree.

function loadMapFile(fileName)
  local xmlNode = getResourceConfig(fileName)

  if (xmlNode) then -- check if the file was loaded ok
    loadMapData(xmlNode, root) -- load the loaded xml file into the element tree
    xmlUnloadFile(xmlNode) -- Unload the xml file
  end
end

shared

Example 2:This example will destroy the loaded map data after 30 seconds.

function loadMapFile(fileName)
  local xmlNode = getResourceConfig(fileName)

  if (xmlNode) then -- check if the file was loaded ok
      nodeElement = loadMapData(xmlNode, root) -- load the loaded xml file into the element tree
    xmlUnloadFile(xmlNode) -- Unload the xml file
  end
end

setTimer(function()
    destroyElement(nodeElement)
end,30000,1)

See Also

Map Functions

• loadMapData
• resetMapInfo
• saveMapData

Reference

• Scripting Functions