GetElementsWithinRange
From Multi Theft Auto: Wiki
This function is used to retrieve a list of all elements of specified type within a range of 3D coordinates.
Note:
|
Syntax
table getElementsWithinRange ( float x, float y, float z, float range [, string elemType = "" ] )
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
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
- attachElements
- clearElementVisibleTo
- cloneElement
- createElement
- destroyElement
- detachElements
- getAllElementData
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementCollisionsEnabled
- getElementByID
- getElementByIndex
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementColShape
- getElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementSyncer
- getElementType
- getElementVelocity
- getElementZoneName
- getElementsByType
- getElementsWithinColShape
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementVisibleTo
- isElementWithinColShape
- isElementWithinMarker
- removeElementData
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementSyncer
- setElementVelocity
- setElementVisibleTo
- setLowLODElement