This function is used to retrieve a list of the child elements of a given parent element. Note that it will only return direct children and not elements that are further down the element tree.

OOP Syntax Help! I don't understand this!

• Method:element:getChildren(...)

Syntax

​table|false getElementChildren ( ​element parent, [ ​string theType = nil ] )

Required arguments

• parent: Supply this argument with the parent of the children you want returned.

Optional arguments

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

• theType (default: nil): The type of element you want a list of. This is the same as the tag name in the .map file, so this can be used with a custom element type if desired. See element types.

Returns

This function returns a table that contains a list of elements that the parent has. If the element has no children, it will return an empy table. It will return false if the parent element does not exist.

• table|false: childrens

Code Examples

Example 1 (OOP) Example 2

shared

OOP Required

local object = Object(1337, 0, 0, 0)
object.id = "Trash 1"

local object2 = Object(1337, 2, 2, 2)
object2.id = "Trash 2"

object2.parent = object

local childs = object:getChildren()
if (childs[1]) then
    print(childs[1].id) -- Trash 2
end

server

With this map file:

<team1 id="red">
  <base name="Mountain Top" />
  <base name="Docks" />
  <base name="Airport" />
  <anything name="no base" />
</team1>

This example outputs the child elements of the element with id red, when the player enters the teamElements command. At a later point you could loop through all the elements and process their contents any way you wish. Remember to make sure you only have the current list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use getElementChildren again.

function showTeamElements(thePlayer, command)
    local theTeam = getElementByID("red") -- get the team element
    local elements = getElementChildren(theTeam) -- the child elements
    for k, v in ipairs(elements) do
        outputChatBox(getElementType(v) .. ": " .. getElementData(v, "name")) -- print the type and name of each child
    end
end
addCommandHandler("teamElements", showTeamElements)

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