GetElementZoneName - Revision history

FileEX: /* See Also */

2024-09-06T22:30:46Z

Qaisjp: fix oop syntax

2015-01-01T22:53:00Z

fix oop syntax

← Older revision		Revision as of 22:53, 1 January 2015
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===

Jaysds: /* Syntax */ OOP

2014-08-16T16:25:54Z

Syntax: OOP

← Older revision		Revision as of 16:25, 16 August 2014
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\|\|}}

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

Funstein at 11:56, 16 February 2013

2013-02-16T11:56:02Z

← Older revision		Revision as of 11:56, 16 February 2013
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==

Awwu: /* Example */

2009-08-27T12:27:39Z

Example

← Older revision		Revision as of 12:27, 27 August 2009
Line 22:		Line 22:
	<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

Arc at 19:28, 19 August 2007

2007-08-19T19:28:56Z

← Older revision		Revision as of 19:28, 19 August 2007
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}}

Arc at 15:09, 15 August 2007

2007-08-15T15:09:26Z

← Older revision		Revision as of 15:09, 15 August 2007
Line 20:		Line 20:
	This example shows you how to return your own location by doing /loc in the chatbox or just loc in console		This example shows you how to return your own location by doing /loc in the chatbox or just loc in console
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addCommandHandler("loc", "playerloc")~~
	function playerloc ( source )		function playerloc ( source )
	local playername = getClientName ( source )		local playername = getClientName ( source )
Line 26:		Line 25:
	outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name		outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name
	end		end
			addCommandHandler("loc", playerloc)
	</syntaxhighlight>		</syntaxhighlight>

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

Talidan: optional arg in syntax

2006-11-18T16:30:30Z

optional arg in syntax

← Older revision		Revision as of 16:30, 18 November 2006
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getElementZoneName ( element theElement, bool citiesonly )		string getElementZoneName ( element theElement, [bool citiesonly=false] )
	</syntaxhighlight>		</syntaxhighlight>

BrophY: /* Example */

2006-11-18T14:21:31Z

Example

← Older revision		Revision as of 14:21, 18 November 2006
Line 24:		Line 24:
	local playername = getClientName ( source )		local playername = getClientName ( source )
	local location = getElementZoneName ( source )		local location = getElementZoneName ( source )
	~~if ( source ) then -- if the player is found~~		outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name
	outputChatBox ( "* " ..playername.. "'s Location: " ..location, root, 0, 255, 255 ) -- Output the player's name and zone name
	~~else~~
	~~outputChatBox ( "* " ..playername.. "'s Location not found.", root, 0, 255, 255 ) -- Output error message if not found~~
	~~end~~
	end		end
	</syntaxhighlight>		</syntaxhighlight>

BrophY: /* Syntax */

2006-11-18T14:02:12Z

Syntax

← Older revision		Revision as of 14:02, 18 November 2006
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getElementZoneName ( element theElement )		string getElementZoneName ( element theElement, bool citiesonly )
	</syntaxhighlight>		</syntaxhighlight>

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

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

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

← Older revision		Revision as of 22:30, 6 September 2024
Line 33:		Line 33:

	==See Also==		==See Also==
	{{~~Element functions~~}}		{{Element_functions\|server}}