GetElementsWithinRange: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add note about Z argument.)
(Re-add previous note about Z argument.)
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.
}}
}}


Revision as of 13:27, 23 December 2022

This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.

BEFORE VERSION 1.5.9 r21438:
  • Z argument isn't in use currently, but make your scripts like it is for future compatibility reasons.

Z argument is now being taken into consideration when checking for elements.

[[{{{image}}}|link=|]] Note:
  • 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.

Syntax

table getElementsWithinRange ( float x, float y, float z, float range [, string elemType = "", int interior, int dimension ] )

OOP Syntax Help! I don't understand this!

Method: Element.getWithinRange(...)


Required Arguments

  • x: the x coordinate at which to retrieve elements.
  • y: the y 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.

Optional Arguments

  • 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.
    • "ped": A ped.
    • "vehicle": A vehicle.
    • "object": An object.
    • "pickup": A pickup.
    • "marker": A marker.
  • 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.

Returns

Returns a table containing all the elements of the specified type within range. Returns an empty table if there are no elements within range. Returns false if the arguments are invalid.

Example

This example allows admins to destroy all vehicles in close proximity. 

function deleteNearbyVehicles(p)
	local acc = getPlayerAccount(p)
	if not isGuestAccount(acc) and isObjectInACLGroup("user."..getAccountName(acc), aclGetGroup("Admin")) then
		local x, y, z = getElementPosition(p)
		local nearbyVehicles = getElementsWithinRange(x, y, z, 300, "vehicle")
		for i,v in ipairs(nearbyVehicles) do
			if v and isElement(v) then
				destroyElement(v)
			end
		end
	end
end
addCommandHandler ("delnearvehs", deleteNearbyVehicles)

Example

This example retrieves a table of players within range of the 3D coordinates and prints their name to the chat. 

local players = 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
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementsWithinRange?oldid=75748"