This function is used to retrieve a list of all elements in a colshape, of the specified type.

Note

• For legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move.
• This function doesn't verify whether elements are in the same dimension and interior, additional checks could be implemented manually if they are needed.

OOP Syntax Help! I don't understand this!

• Method:colshape:getElementsWithin(...)
• Variable: .elementsWithin

Syntax

​table|false getElementsWithinColShape ( ​colshape theShape, [ ​string elemType = nil ] )

Required Arguments

• theShape: The colshape you want to get the elements from.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• elemType (default: nil): The type of element you want a list of. This can be any element type.

Returns

• table|false: elements

Returns a table containing all the elements inside the colshape, of the specified type. Returns an empty table if there are no elements inside. Returns false if the colshape is invalid.

Code Examples

Example 1 Example 2 (OOP) Example 3 (OOP)

shared

This example retrieves a table of players inside a colshape and prints their name to the chat.

local newColShape = createColSphere(1, 2, 3, 4) -- create our new colshape
local players = getElementsWithinColShape(newColShape, "player") -- get all the players inside the sphere

for _, thePlayer in ipairs(players) do -- use a generic for loop to step through each player
    outputChatBox(getPlayerName(thePlayer) .. " is in our new sphere") -- print their name to the chat
end

shared

OOP Required

This example retrieves a table of players inside a colshape and prints their name to the chat.

local newColShape = ColShape.Sphere(1, 2, 3, 4) -- create our new colshape
local players = newColShape.getElementsWithin("player") -- get all the players inside the sphere

for _, thePlayer in ipairs(players) do -- use a generic for loop to step through each player
    outputChatBox(thePlayer.name .. " is in our new sphere") -- print their name to the chat
end

shared

OOP Required

This example retrieves a table of players inside a colshape and prints their name to the chat.

local newColShape = ColShape.Sphere(1, 2, 3, 4) -- create our new colshape
local elems = newColShape.elementsWithin -- get all elements within colshape

for _, elem in ipairs(elems) do -- use a generic for loop to step through each element
    if (elem.type == 'player') then -- check if this is a player
        outputChatBox(thePlayer.name .. " is in our new sphere") -- print their name to the chat
    end
end

Changelog

1.5.5-3.12286

Added .elementsWithin OOP variable.

See Also

Element Functions

• addElementDataSubscriber
• attachElements
• clearElementVisibleTo
• cloneElement
• createElement
• destroyElement
• detachElements
• getAllElementDataUpdated
• getAttachedElements
• getElementAlpha
• getElementAngularVelocity
• getElementAttachedOffsets
• getElementAttachedTo
• getElementBonePosition
• getElementBoneQuaternionNew
• getElementBoneRotation
• getElementBoundingBox
• getElementByID
• getElementByIndex
• getElementChild
• getElementChildren
• getElementChildrenCount
• getElementCollisionsEnabled
• getElementColShape
• getElementData
• getElementDimension
• getElementDistanceFromCentreOfMassToBaseOfModel
• getElementHealth
• getElementID
• getElementInterior
• getElementLighting
• getElementMatrix
• getElementModel
• getElementParent
• getElementPosition
• getElementRadius
• getElementRotation
• getElementsByType
• getElementsWithinColShape
• getElementsWithinRange
• getElementSyncer
• getElementType
• getElementVelocity
• getElementZoneName
• getLowLODElement
• getRootElement
• hasElementData
• hasElementDataSubscriber
• isElement
• isElementAttached
• isElementCallPropagationEnabled
• isElementCollidableWith
• isElementDoubleSided
• isElementFrozen
• isElementInWater
• isElementLocal
• isElementLowLOD
• isElementOnFireNew
• isElementOnScreen
• isElementStreamable
• isElementStreamedIn
• isElementSyncer
• isElementVisibleTo
• isElementWaitingForGroundToLoad
• isElementWithinColShape
• isElementWithinMarker
• removeElementData
• removeElementDataSubscriber
• setElementAlpha
• setElementAngularVelocity
• setElementAttachedOffsets
• setElementBonePosition
• setElementBoneQuaternionNew
• setElementBoneRotation
• setElementCallPropagationEnabled
• setElementCollidableWith
• setElementCollisionsEnabled
• setElementDataUpdated
• setElementDimension
• setElementDoubleSided
• setElementFrozen
• setElementHealth
• setElementID
• setElementInterior
• setElementLightingNew
• setElementMatrix
• setElementModel
• setElementOnFireNew
• setElementParent
• setElementPosition
• setElementRotation
• setElementStreamable
• setElementSyncer
• setElementVelocity
• setElementVisibleTo
• setLowLODElement
• updateElementRpHAnim

Element Events

• onClientElementColShapeHit
• onClientElementColShapeLeave
• onClientElementDataChange
• onClientElementDestroy
• onClientElementDimensionChange
• onClientElementInteriorChange
• onClientElementModelChange
• onClientElementStreamIn
• onClientElementStreamOut
• onElementClicked
• onElementColShapeHit
• onElementColShapeLeave
• onElementDataChange
• onElementDestroy
• onElementDimensionChange
• onElementInteriorChange
• onElementModelChange
• onElementStartSync
• onElementStopSync

Reference

• Scripting Functions