PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. apireference
  2. instance

IsDescendantOf

Instance

Returns true if an Instance is a descendant of the given ancestor.

An Instance is considered the descendant of an object if the Instance’s parent or one of its parent’s parent is set to the object.

Note, DataModel is a descendant of nil. This means IsDescendantOf cannot be used with a parameter of nil to check if an object has been removed.

See also, Instance/IsAncestorOf.

Parameters

Name Type Default Description

ancestor

Instance

The ancestor Instance.

Returns

Return Type Summary

bool

True if the Instance is a descendant of the given ancestor.

Code Samples

Instance:IsDescendantOf

local part = Instance.new("Part")
print(part:IsDescendantOf(game))
--> false

part.Parent = game.Workspace
print(part:IsDescendantOf(game))
--> true

part.Parent = game
print(part:IsDescendantOf(game))
--> true