GetElementZoneName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (fix oop syntax)
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function allows you to retrieve the zone name of an element (eg. Verdant Bluffs or Ocean Docks)
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==
==Syntax==
Line 7: Line 9:
string getElementZoneName ( element theElement, [bool citiesonly=false] )
string getElementZoneName ( element theElement, [bool citiesonly=false] )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:getZoneName||}}


===Required Arguments===
===Required Arguments===
Line 22: Line 25:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function playerloc ( source )
function playerloc ( source )
     local playername = getClientName ( source )
     local playername = getPlayerName ( source )
     local location = getElementZoneName ( source )
     local location = getElementZoneName ( source )
     outputChatBox ( "* " .. playername .. "'s Location: " .. location, getRootElement(), 0, 255, 255 ) -- Output the player's name and zone name
     outputChatBox ( "* " .. playername .. "'s Location: " .. location, getRootElement(), 0, 255, 255 ) -- Output the player's name and zone name

Latest 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

Shared


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