IsDescendantOf

Function of:

Description:

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.

Parameters

Name	Type	Default	Description
Name ancestor	Type Instance	Default	Summary The ancestor `Instance`.

Returns

Return Type	Summary
Return Type bool	Summary True if the `Instance` is a descendant of the given ancestor.

Code Samples

Instance:IsDescendantOf

				
					Instance:IsDescendantOf
				
					Expected Output
				
					Expand
					
			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
		
				Copy Code
			
				Light Theme

IsDescendantOf

Parameters

ancestor

Returns

bool

Code Samples

Instance:IsDescendantOf