GetZoneName - Revision history

LordHenry: /* Returns */

2022-08-29T21:50:42Z

Returns

← Older revision		Revision as of 21:50, 29 August 2022
Line 26:		Line 26:

	===Returns===		===Returns===
	Returns the string of the zone name		Returns the string of the zone name.
			{{ZoneNames}}

	==Example==		==Example==

2021-02-01T22:36:22Z

Removed old info and added city names

← Older revision		Revision as of 22:36, 1 February 2021
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	This function allows you to retrieve the zone name of a certain location.		This function allows you to retrieve the zone name of a certain location.

	''Note that between versions 1.1 and 1.3.0-3749 the default value for '''citiesonly''' was incorrect when called the client side. The work around for clients before 1.3.0-3749 is to always declare a value for '''citiesonly'''. Server side getZoneName was unaffected.''

	==Syntax==		==Syntax==
Line 17:		Line 15:
	===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 one of the following city names:
			** Tierra Robada
			** Bone County
			** Las Venturas
			** San Fierro
			** Red County
			** Whetstone
			** Flint County
			** Los Santos

	===Returns===		===Returns===

2020-01-01T15:57:13Z

← Older revision		Revision as of 15:57, 1 January 2020
Line 44:		Line 44:
	local thePlayer = getPlayerFromName ( playername ) --get the player from nickname		local thePlayer = getPlayerFromName ( playername ) --get the player from nickname
	if ( thePlayer ~= false ) then --if there is a player from the nickname		if ( thePlayer ~= false ) then --if there is a player from the nickname
	local x, y, z = getElementPosition ( ~~player~~ )		local x, y, z = getElementPosition ( thePlayer )
	local location = getZoneName ( x, y, z )		local location = getZoneName ( x, y, z )
	local city = getZoneName ( x, y, z, true )		local city = getZoneName ( x, y, z, true )

2019-09-20T22:02:00Z

Example

← Older revision		Revision as of 22:02, 20 September 2019
Line 24:		Line 24:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	'''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 )~~		'''Example 1:''' This example returns the player's City & Zone.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~playerLoc~~ ( ~~source~~, ~~command~~, x, y, z )		function outputPlayerZone(thePlayer)
	~~local location~~ = getZoneName ( x, y, z )		-- get the player position
	outputChatBox ( "* Location: " .. ~~location, getRootElement(), 0~~, ~~255, 255~~ ) ~~-- Output the zone name~~		x, y, z = getElementPosition(thePlayer)
			-- get the player zone
			zone = getZoneName(x, y, z)
			-- get the player city (citiesonly as true)
			city = getZoneName(x, y, z, true)
			-- output to local player's chatbox
			outputChatBox("City: ".. city .." / Zone: ".. zone, thePlayer)
	end		end
	addCommandHandler( "~~loc~~", ~~playerLoc~~ )		addCommandHandler("getloc", outputPlayerZone)
	</syntaxhighlight>		</syntaxhighlight>

2012-01-30T05:50:13Z

← Older revision		Revision as of 05:50, 30 January 2012
Line 3:		Line 3:
	This function allows you to retrieve the zone name of a certain location.		This function allows you to retrieve the zone name of a certain location.

	''Note that between versions 1.1 and 1.3.0-3749 ~~then~~ default value for '''citiesonly''' was incorrect when called the client side. The work around for clients before 1.3.0-3749 is to always declare a value for '''citiesonly'''. Server side getZoneName was unaffected.''		''Note that between versions 1.1 and 1.3.0-3749 the default value for '''citiesonly''' was incorrect when called the client side. The work around for clients before 1.3.0-3749 is to always declare a value for '''citiesonly'''. Server side getZoneName was unaffected.''

	==Syntax==		==Syntax==

2012-01-26T23:21:04Z

← Older revision		Revision as of 23:21, 26 January 2012
Line 3:		Line 3:
	This function allows you to retrieve the zone name of a certain location.		This function allows you to retrieve the zone name of a certain location.

			''Note that between versions 1.1 and 1.3.0-3749 then default value for '''citiesonly''' was incorrect when called the client side. The work around for clients before 1.3.0-3749 is to always declare a value for '''citiesonly'''. Server side getZoneName was unaffected.''

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2011-11-22T16:16:56Z

← Older revision		Revision as of 16:16, 22 November 2011
Line 34:		Line 34:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function scriptGetLoc ( source, command, playername ) --when getloc is called		function scriptGetLoc ( source, command, playername ) --when getloc is called
	local thePlayer = ~~getPlayerFromNick~~ ( playername ) --get the player from nickname		local thePlayer = getPlayerFromName ( playername ) --get the player from nickname
	if ( thePlayer ~= false ) then --if there is a player from the nickname		if ( thePlayer ~= false ) then --if there is a player from the nickname
	local x, y, z = getElementPosition ( player )		local x, y, z = getElementPosition ( player )

2010-03-07T09:58:11Z

Undo revision 22568 by PoliticalOrel (Talk)

← Older revision		Revision as of 09:58, 7 March 2010
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~RU/~~Server client function}}		{{Server client function}}
	This function allows you to retrieve the zone name of a certain location.		This function allows you to retrieve the zone name of a certain location.

	==~~Использование~~==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getZoneName ( float x, float y, float z, [bool citiesonly=false] )		string getZoneName ( float x, float y, float z, [bool citiesonly=false] )
Line 47:		Line 47:
	</section>		</section>

	==~~Примечание~~==		==See Also==
	{{~~RU/~~World functions}}		{{World functions}}

	[[ru:getZoneName]]		[[ru:getZoneName]]

2010-03-07T09:57:53Z

← Older revision		Revision as of 09:57, 7 March 2010
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{RU/Server client function}}
	This function allows you to retrieve the zone name of a certain location.		This function allows you to retrieve the zone name of a certain location.

	==~~Syntax~~==		==Использование==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getZoneName ( float x, float y, float z, [bool citiesonly=false] )		string getZoneName ( float x, float y, float z, [bool citiesonly=false] )
Line 47:		Line 47:
	</section>		</section>

	==~~See Also~~==		==Примечание==
	{{World functions}}		{{RU/World functions}}

	[[ru:getZoneName]]		[[ru:getZoneName]]

2010-03-07T09:56:59Z