AddResourceMap: Difference between revisions

Latest revision as of 22:45, 6 September 2024

This function adds a new empty mapfile to an existing resource.

[[{{{image}}}\|link=\|]]	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

This example just adds a map to a gamemode resource called "cdm".

addResourceMap(":cdm/[maps]/New.map",0)

@@ Line 1: / Line 1: @@
 {{Server function}}
 __NOTOC__
-This function retrieves a table of all the resources that exist on the server.
+This function adds a new empty mapfile to an existing resource.
+{{Note| You can't add a map to a running resource.}}
 ==Syntax==
 <syntaxhighlight lang="lua">
-xmlnode addResourceMap ( resource, name, [ dimension = 0 ] )
+xmlnode addResourceMap ( string filePath, [ int dimension = 0 ] )
 </syntaxhighlight>
+===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===
+{{OptionalArg}}
+*'''dimension:''' the [[dimension]] in which the map's objects will be placed.
 ===Returns===
-Returns a table of resources.
+Returns the new map's root [[xmlnode]] if the map was added successfully, ''false'' otherwise.
 ==Example==
-This function lists all loaded resources in the console.
+This example just adds a map to a gamemode resource called "cdm".
-<syntaxhighlight lang="lua">
+<syntaxhighlight lang="lua">addResourceMap(":cdm/[maps]/New.map",0)</syntaxhighlight>
-function blabla ()
-     --this does blabla
-end
-</syntaxhighlight>
 ==See Also==
-{{Resource_functions}}
+{{Resource_functions|server}}