SetMapName: Difference between revisions
Jump to navigation
Jump to search
Black Dragon (talk | contribs) mNo edit summary |
Fernando187 (talk | contribs) m (add MAX 200 characters according to ASE.h constants) |
||
| (8 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function is used to set a map name that will be visible | {{Server function}} | ||
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 8: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''mapName:''' The name you wish | *'''mapName:''' The name you wish the server browser to show. '''(MAX 200 characters)''' | ||
===Returns=== | ===Returns=== | ||
| Line 14: | Line 15: | ||
==Example== | ==Example== | ||
This example sets the map name to ''My amazing map!''. | |||
This example | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
setMapName("My amazing map!") | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Announce functions}} | |||
{{ | |||
Latest revision as of 09:30, 3 October 2024
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. (MAX 200 characters)
Returns
Returns true if map name was set successfully, false otherwise.
Example
This example sets the map name to My amazing map!.
setMapName("My amazing map!")
See Also