SetMapName: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 17: | Line 17: | ||
This example sets the map name to ''My amazing map!'' when the resource is started. | This example sets the map name to ''My amazing map!'' when the resource is started. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler("onResourceStart", getResourceRootElement( | addEventHandler("onResourceStart", getResourceRootElement(), function() setMapName("My amazing map!") end) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Announce functions}} | {{Announce functions}} | ||
Revision as of 16:41, 11 February 2015
This function is used to set a map name that will be visible in the server browser. In practice you should generally rely on the mapmanager to do this for you.
Syntax
bool setMapName ( string mapName )
Required Arguments
- mapName: The name you wish the server browser to show.
Returns
Returns true if map name was set successfully, false otherwise.
Example
This example sets the map name to My amazing map! when the resource is started.
addEventHandler("onResourceStart", getResourceRootElement(), function() setMapName("My amazing map!") end)
See Also