GetMapName

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This function retrieves the current mapname as set by setMapName.

Syntax

string getMapName ()

Returns

Returns the mapname as a string. If no mapname is set it returns nil.

Example

This example adds a checkmap command with which you can check what map you are currently playing.

function checkMap ( thePlayer )
    local mapName = getMapName() -- get the maps name
	if mapName and mapName ~= "None" then -- if map name was set and it isn't "None" (default map name)
        outputChatBox( "You're playing map called \"" .. mapName .. "\"", thePlayer ) -- print out the map name
    else -- there was no name so tell that to player
        outputChatBox( "You're playing an unnamed map.", thePlayer ) -- print out the message
    end
end
addCommandHandler ( "checkmap", checkMap )

See Also