GetZoneName: Difference between revisions

Revision as of 09:57, 7 March 2010

This function allows you to retrieve the zone name of a certain location.

Использование

string getZoneName ( float x, float y, float z, [bool citiesonly=false] )

Required Arguments

x: The X axis position
y: The Y axis position
z: The Z axis position

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 zone name

Example

Click to collapse [-]

Server

Example 1: This example shows you how to return a zone name by doing /loc x y z in the chatbox or just loc x y z in console ( replace x, y and z with the co-ords you wanna check, eg /loc 1200 523 12.3 )

function playerLoc ( source, command, x, y, z )
  local location = getZoneName ( x, y, z )
  outputChatBox ( "* Location: " .. location, getRootElement(), 0, 255, 255 ) -- Output the zone name
end
addCommandHandler( "loc", playerLoc )

Example 2: This example will tell you what zone a specified player is in when the "getloc" console command is used.

function scriptGetLoc ( source, command, playername ) --when getloc is called
  local thePlayer = getPlayerFromNick ( playername ) --get the player from nickname
  if ( thePlayer ~= false ) then --if there is a player from the nickname
    local x, y, z = getElementPosition ( player )
    local location = getZoneName ( x, y, z )
	local city = getZoneName ( x, y, z, true )
    outputChatBox ( playername .. " is at " .. location .. " (" .. city .. ")", source ) --announce his zone
  else outputChatBox ( "Player does not exist" )
  end
end
addCommandHandler( "getloc", scriptGetLoc ) -- add a command "getloc" which initiates "scriptGetloc" function

Примечание

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Server client function}}
+{{RU/Server client function}}
 This function allows you to retrieve the zone name of a certain location.
-==Syntax==
+==Использование==
 <syntaxhighlight lang="lua">
 string getZoneName ( float x, float y, float z, [bool citiesonly=false] )
@@ Line 47: / Line 47: @@
 </section>
-==See Also==
+==Примечание==
-{{World functions}}
+{{RU/World functions}}
 [[ru:getZoneName]]