GetElementZoneName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
m (fix oop syntax)
Line 9: Line 9:
string getElementZoneName ( element theElement, [bool citiesonly=false] )
string getElementZoneName ( element theElement, [bool citiesonly=false] )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getZoneName||}}
{{OOP||[[element]]:getZoneName||}}


===Required Arguments===
===Required Arguments===

Revision as of 22:53, 1 January 2015

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

The same can be achieved client side by getting element coordinates and using GetZoneName.

Syntax

string getElementZoneName ( element theElement, [bool citiesonly=false] )

OOP Syntax Help! I don't understand this!

Method: element:getZoneName(...)


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. For more information on optional arguments, see optional arguments.

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

Returns

Returns the string of the elements zone name.

Example

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementZoneName?oldid=43749"