SetMapName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (add MAX 200 characters according to ASE.h constants)
 
(2 intermediate revisions by one other user not shown)
Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''mapName:''' The name you wish the server browser to show.
*'''mapName:''' The name you wish the server browser to show. '''(MAX 200 characters)'''


===Returns===
===Returns===
Line 15: Line 15:


==Example==  
==Example==  
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!''.  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", getResourceRootElement(), function() setMapName("My amazing map!") end)
setMapName("My amazing map!")
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Announce functions}}
{{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