SetMapName: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function is used to set a map name that will be visible | 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== | ==Syntax== | ||
| Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''mapName:''' The name you wish | *'''mapName:''' The name you wish the server browser to show. | ||
===Returns=== | ===Returns=== | ||
| Line 15: | Line 15: | ||
==Example== | ==Example== | ||
This | This example sets the map name to ''My amazing map!'' when the resource is started. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()), function() setMapName("My amazing map!") end) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ASE functions}} | {{ASE functions}} | ||
Revision as of 14:19, 20 December 2007
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(getThisResource()), function() setMapName("My amazing map!") end)