AddResourceMap: Difference between revisions
Jump to navigation
Jump to search
(Fixed syntax, added argument descriptions, return info, added categories) |
No edit summary |
||
| (8 intermediate revisions by 6 users not shown) | |||
| 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== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
xmlnode addResourceMap ( | xmlnode addResourceMap ( string filePath, [ int dimension = 0 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===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=== | ===Optional Arguments=== | ||
| Line 20: | Line 22: | ||
==Example== | ==Example== | ||
[ | This example just adds a map to a gamemode resource called "cdm". | ||
<syntaxhighlight lang="lua">addResourceMap(":cdm/[maps]/New.map",0)</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions}} | ||
Latest revision as of 05:04, 11 August 2019
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
This example just adds a map to a gamemode resource called "cdm".
addResourceMap(":cdm/[maps]/New.map",0)
See Also
- abortRemoteRequest
- addResourceConfig
- addResourceMap
- call
- callRemote
- copyResource
- createResource
- deleteResource
- fetchRemote
- getRemoteRequestInfo
- getRemoteRequests
- getResourceACLRequests
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceName
- getResourceOrganizationalPath
- getResourceRootElement
- getResources
- getResourceState
- getThisResource
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest