LoadMapData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 15: Line 15:


==Example==  
==Example==  
This example is a function that you could use to load an arbitary [[map file]] into the [[element tree]].
This example is a function that you could use to load an arbitary [[map files|map file]] into the [[element tree]].
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function loadMapFile ( filename )
function loadMapFile ( filename )

Revision as of 20:19, 24 May 2006

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

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.

Example

This example is a function that you could use to load an arbitary map file into the element tree.

function loadMapFile ( filename )
	node = xmlLoadFile ( filename )
	-- Check if the file was loaded ok
	if ( node ) then
		-- Load the loaded xml file into the element tree
		loadMapData ( node, getRootNode )
		-- Unload the xml file again
		xmlUnloadFile ( node )
	end
end

See Also