getElementZoneName | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getElementZoneName

Client-side
Server-side
Shared

This function allows you to retrieve the zone name of an element (eg. Verdant Bluffs or Ocean Docks).

Note

The same can be achieved (also on client side) by getting element coordinates and using getZoneName.

OOP Syntax Help! I don't understand this!

  • Method:element:getZoneName(...)
  • Variable: .zoneName

Syntax 

​string|false getElementZoneName ( ​element theElement, [ ​bool citiesonly = false ] )
Required Arguments
  • theElement: The element which you'd like to retrieve the zone name from.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • citiesonly (default: false): An optional argument to choose if you want to return the city name (eg Las Venturas).

Returns

  • string|false: zone name

Returns the string of the elements zone name or false if invalid element was passed.

Code Examples

server

This example shows you how to return your own location by doing /loc in the chatbox or just loc in console.

function playerloc(source)
    local playername = getPlayerName(source)
    local location = getElementZoneName(source)
    outputChatBox("* " .. playername .. "'s Location: " .. location, getRootElement(), 0, 255, 255) -- Output the player's name and zone name
end
addCommandHandler("loc", playerloc)

See Also

Element Functions
Element Events
Reference