GetElementZoneName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{Server function}}
__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)
Line 8: Line 9:


===Required Arguments===
===Required Arguments===
*'''theElement:''' The element in which you'd like to retrieve the zone name from
*'''theElement:''' The element which you'd like to retrieve the zone name from


===Optional Arguments===
===Optional Arguments===
{{OptionalArg}}
{{OptionalArg}}
* '''citiesonly''': An optional argument to choose if you want to return the city name (eg Las Venturas)
*'''citiesonly''': An optional argument to choose if you want to return the city name (eg Las Venturas)


===Returns===
===Returns===
Returns the string of the elements zone name
Returns the string of the elements zone name.


==Example==
==Example==
Line 21: Line 22:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function playerloc ( source )
function playerloc ( source )
  local playername = getClientName ( source )
    local playername = getClientName ( source )
  local location = getElementZoneName ( source )
    local location = getElementZoneName ( source )
  outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 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
end
end
addCommandHandler("loc", playerloc)
addCommandHandler ( "loc", playerloc )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Element functions}}
{{Element functions}}

Revision as of 19:28, 19 August 2007

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

Syntax

string 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. 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 = getClientName ( 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=10736"