API:Class/Instance/GetDescendants

GetDescendants

Function of Object Icon.pngInstance
array<Instance> GetDescendants ()

Returns: array<Instance>
Description: The GetDescendants function of an object returns an array that contains all of the descendants of that object. Unlike GetChildren, which only returns the immediate children of an object, GetDescendants will find every child of the object, every child of those children, and so on and so forth.


The arrays returned by GetDescendants are arranged so that parents come earlier than their children. For example, let’s look at the following setup:

GetDescendantsExample.png

Here we have a model in the workspace. Inside this model is three parts (C, D, and E) and another model (InnerModel). Inside the inner model are two more parts (A and B). If we use GetDescendants on the first model and print out the contents of the returned array, we can see that the first level of children, InnerModel, C, D, and E, are printed out before A and B.

local descendants = game.Workspace.Model:GetDescendants() 
-- Loop through all of the descendants of the model and
-- print out their name
for index, descendant in pairs(descendants) do
	print(descendant.Name)
end
 
-- Prints:
-- C
-- D
-- E
-- InnerModel
-- A
-- B

Example

GetDescendants is often used to do something to all the descendants that are a particular type of object. The code in this example uses GetDescendants and IsA to find all of the parts in the workspace and turns them green.

local descendants = game.Workspace:GetDescendants() 
-- Loop through all of the descendants of the Workspace. If a
-- BasePart is found, the code changes that part’s color to green
for index, descendant in pairs(descendants) do
	if descendant:IsA("BasePart") then
		descendant.BrickColor = BrickColor.Green()
	end
end