GetElementsWithinRange - Revision history

Srslyyyy: /* Example */

2024-05-03T15:38:42Z

Example

← Older revision		Revision as of 15:38, 3 May 2024
Line 86:		Line 86:
	This example retrieves a table of players within range of the 3D coordinates and prints their name to the chat.		This example retrieves a table of players within range of the 3D coordinates and prints their name to the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~players~~ = getElementsWithinRange( 0, 0, 3, 20, "player" ) -- get all player elements within 20 units of 0, 0, 3		local playersTable = getElementsWithinRange(0, 0, 3, 20, "player") -- get all player elements within 20 units of 0, 0, 3
	for _, ~~player~~ in pairs( ~~players~~ ) do -- use a generic for loop to step through each player
	~~outputChatBox(~~ getPlayerName( player ) .. " is within range" ) -- print their name to the chat		for _, playerElement in pairs(playersTable) do -- use a generic for loop to step through each player
			local playerName = getPlayerName(playerElement) -- get player name

			outputChatBox(playerName.." is within range") -- print their name to the chat
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: /* Example */

2024-05-03T15:36:52Z

Example

← Older revision		Revision as of 15:36, 3 May 2024
Line 43:		Line 43:
	This example allows admins to destroy all vehicles in close proximity.		This example allows admins to destroy all vehicles in close proximity.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function deleteNearbyVehicles(p)		function deleteNearbyVehicles(playerElement)
	local ~~acc~~ = getPlayerAccount(p)		local playerAccount = getPlayerAccount(playerElement)
	if not isGuestAccount(~~acc~~) ~~and isObjectInACLGroup~~("user."..~~getAccountName(acc),~~ aclGetGroup("Admin")) then
	local x, y, z = getElementPosition(p)		if (not playerAccount) then
	local nearbyVehicles = getElementsWithinRange(x, y, z, ~~300~~, "vehicle")		return false
	for i,~~v in ipairs~~(~~nearbyVehicles~~) do		end
	if ~~v and isElement~~(v) then
	destroyElement(v)		local guestAccount = isGuestAccount(playerAccount)
	~~end~~
			if (guestAccount) then
			return false
			end

			local accountName = getAccountName(playerAccount)
			local aclObject = "user."..accountName
			local adminGroup = aclGetGroup("Admin")
			local playerAdmin = isObjectInACLGroup(aclObject, adminGroup)

			if (not playerAdmin) then
			return false
			end

			local playerX, playerY, playerZ = getElementPosition(playerElement)
			local playerInterior = getElementInterior(playerElement)
			local playerDimension = getElementDimension(playerElement)
			local searchRange = 300
			local nearbyVehicles = getElementsWithinRange(playerX, playerY, playerZ, searchRange, "vehicle", playerInterior, playerDimension)

			for vehicleID = 1, #nearbyVehicles do
			local vehicleElement = nearbyVehicles[vehicleID]
			local validElement = isElement(vehicleElement)

			if (validElement) then
			destroyElement(vehicleElement)
	end		end
	end		end
	end		end
	addCommandHandler ("~~delnearvehs~~", deleteNearbyVehicles)		addCommandHandler("deletenearbyvehs", deleteNearbyVehicles)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Improve notes consistency.

2023-01-12T09:11:05Z

Improve notes consistency.

← Older revision		Revision as of 09:11, 12 January 2023
Line 5:		Line 5:
	* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.		* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.
	\|21438}}		\|21438}}
	{{New feature/item\|3.0160\|1.5.9\|21438\| Z argument is now being taken into consideration when checking for elements. }}		{{New feature/item\|3.0160\|1.5.9\|21438\|
			* Z argument is now being taken into consideration when checking for elements.
			}}
	{{Note\|		{{Note\|
	* This function checks if elements are in a box, not in a sphere.		* This function checks if elements are in a box, not in a sphere.

Srslyyyy: Re-add previous note about Z argument.

2022-12-23T13:27:42Z

Re-add previous note about Z argument.

← Older revision		Revision as of 13:27, 23 December 2022
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.		This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.
			{{Deprecated items\|3.0160\|1.5.9\|
			* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.
			\|21438}}
			{{New feature/item\|3.0160\|1.5.9\|21438\| Z argument is now being taken into consideration when checking for elements. }}
	{{Note\|		{{Note\|
	* This function checks if elements are in a box, not in a sphere.		* This function checks if elements are in a box, not in a sphere.
	* This function doesn't work with elements which are created by createElement.		* This function doesn't work with elements which are created by createElement.
	* Starting from version [[https://buildinfo.mtasa.com/?Revision=21438&Branch r21438]] and above Z argument become used. It had no effect in older MTA releases.
	}}		}}

Srslyyyy: Add note about Z argument.

2022-12-12T02:46:29Z

Add note about Z argument.

← Older revision		Revision as of 02:46, 12 December 2022
Line 4:		Line 4:
	{{Note\|		{{Note\|
	* This function checks if elements are in a box, not in a sphere.		* This function checks if elements are in a box, not in a sphere.
	* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.		* This function doesn't work with elements which are created by createElement.
	* This function doesn't work with elements which are created by createElement.}}		* Starting from version [[https://buildinfo.mtasa.com/?Revision=21438&Branch r21438]] and above Z argument become used. It had no effect in older MTA releases.
			}}

	==Syntax==		==Syntax==

Srslyyyy: Fix spelling.

2022-12-12T02:29:12Z

Fix spelling.

← Older revision		Revision as of 02:29, 12 December 2022
Line 5:		Line 5:
	* This function checks if elements are in a box, not in a sphere.		* This function checks if elements are in a box, not in a sphere.
	* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.		* Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.
	* This function doesn't work with elements which is created by createElement.}}		* This function doesn't work with elements which are created by createElement.}}

	==Syntax==		==Syntax==

Lvrent at 21:09, 23 September 2021

2021-09-23T21:09:03Z

← Older revision		Revision as of 21:09, 23 September 2021
Line 26:		Line 26:
	**'''"pickup":''' A pickup.		**'''"pickup":''' A pickup.
	**'''"marker":''' A marker.		**'''"marker":''' A marker.
	{{Added feature/item~~\|3.0160~~\|1.5.9\|1.5.8\|20797\|		{{Added feature/item\|1.5.9\|1.5.8\|20797\|
	*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.		*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.
	*'''dimension:''' The [[dimension]] you want to limit the search to. If not specified, it can return elements in any dimension.		*'''dimension:''' The [[dimension]] you want to limit the search to. If not specified, it can return elements in any dimension.

Lvrent at 13:18, 23 September 2021

2021-09-23T13:18:22Z

← Older revision		Revision as of 13:18, 23 September 2021
Line 13:		Line 13:
	{{OOP\| \|[[Element]].getWithinRange}}		{{OOP\| \|[[Element]].getWithinRange}}
	===Required Arguments===		===Required Arguments===
	*'''x:''' the x coordinate at which to retrieve elements		*'''x:''' the x coordinate at which to retrieve elements.
	*'''y:''' the y coordinate at which to retrieve elements		*'''y:''' the y coordinate at which to retrieve elements.
	*'''z:''' the z coordinate at which to retrieve elements		*'''z:''' the z coordinate at which to retrieve elements.
	*'''range:''' the range at the coordinates in which to retrieve elements		*'''range:''' the range at the coordinates in which to retrieve elements.

	===Optional Arguments===		===Optional Arguments===
	*'''elemType:''' The type of element you want a list of. This can be any element type, such as:		*'''elemType:''' The type of element you want a list of. This can be any element type, such as:
	**'''"player":''' A player connected to the server		**'''"player":''' A player connected to the server.
	**'''"ped":''' A ped		**'''"ped":''' A ped.
	**'''"vehicle":''' A vehicle		**'''"vehicle":''' A vehicle.
	**'''"object":''' An object		**'''"object":''' An object.
	**'''"pickup":''' A pickup		**'''"pickup":''' A pickup.
	**'''"marker":''' A marker		**'''"marker":''' A marker.
	{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20797\|		{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20797\|
	*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.		*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.

Lvrent at 13:18, 23 September 2021

2021-09-23T13:18:07Z

← Older revision		Revision as of 13:18, 23 September 2021
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	~~{{New feature/item\|3.0156\|1.5.5\|13823\|~~This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.}}		This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.
	{{Note\|		{{Note\|
	* This function checks if elements are in a box, not in a sphere.		* This function checks if elements are in a box, not in a sphere.

Lvrent at 13:16, 23 September 2021

2021-09-23T13:16:19Z

← Older revision		Revision as of 13:16, 23 September 2021
Line 26:		Line 26:
	**'''"pickup":''' A pickup		**'''"pickup":''' A pickup
	**'''"marker":''' A marker		**'''"marker":''' A marker
	{{Added feature/item\|3.~~0159~~\|1.5.9\|1.5.8\|20797\|		{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20797\|
	*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.		*'''interior:''' The [[interior]] you want to limit the search to. If not specified, it can return elements in any interior.
	*'''dimension:''' The [[dimension]] you want to limit the search to. If not specified, it can return elements in any dimension.		*'''dimension:''' The [[dimension]] you want to limit the search to. If not specified, it can return elements in any dimension.