AddResourceMap: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added a note.)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function adds a new empty mapfile to an existing resource.
This function adds a new empty mapfile to an existing resource.
'''NOTE:''' You can't add a map to a running resource.


==Syntax==  
==Syntax==  

Revision as of 17:27, 22 December 2010

This function adds a new empty mapfile to an existing resource. NOTE: You can't add a map to a running resource.

Syntax

xmlnode addResourceMap ( string filePath, [ int dimension = 0 ] )

Required Arguments

  • filePath: The filepath of the resource map in the following format: ":resourceName/path". 'resourceName' is the name of the resource the map file will be in, and 'path' is the path from the root directory of the resource to the file.
For example, if you want to create a map file named 'manycars.map' in the resource 'cdm', it can be created from another resource this way: addResourceMap(":cdm/manycars.map").
If you want to create the map file in the current resource, only the file path is necessary, e.g. addResourceMap("manycars.map").

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • dimension: the dimension in which the map's objects will be placed.

Returns

Returns the new map's root xmlnode if the map was added successfully, false otherwise.

Example

See Also