Skip to content

Find

Types

Fallback type

luau
type Fallback<Name> = index<Type.Editable & { [string]: Instance }, Name>

Selection type

luau
type Selection = { any }

ClassSelector type

luau
type ClassSelector = <T>(className: T | keyof<Type.Editable>) -> (Type.EditProperties<Fallback<T>>) -> Selection

Selector type

luau
type Selector = <T>(name: T & Instance & string) -> (Type.EditProperties<T>) -> Selection

Properties

Symbol Read Only

luau
Find.Symbol: Type.Symbol

Ancestor Read Only

luau
Find.Ancestor: Selector

Selects the first ancestor named name via Instance:FindFirstAncestor, then applies the property table to it. Use to reach an Instance above the hydrated element in the tree.

Open Documentation

AncestorClass Read Only

luau
Find.AncestorClass: ClassSelector

Selects the first ancestor of class className via Instance:FindFirstAncestorOfClass, then applies the property table to that matched Instance. Matches the exact ClassName.

Open Documentation

AncestorIsA Read Only

luau
Find.AncestorIsA: ClassSelector

Selects the first ancestor whose class is or inherits className via Instance:FindFirstAncestorWhichIsA, then applies the property table. Unlike AncestorClass, this honors the Instance inheritance chain.

Open Documentation

Child Read Only

luau
Find.Child: Selector

Selects the first child named name via Instance:FindFirstChild, then applies the property table to it. The most common selector for reaching a named Instance one level down.

Open Documentation

ChildClass Read Only

luau
Find.ChildClass: ClassSelector

Selects the first child of class className via Instance:FindFirstChildOfClass, then applies the property table to that matched Instance. Matches the exact ClassName.

Open Documentation

ChildIsA Read Only

luau
Find.ChildIsA: ClassSelector

Selects the first child whose class is or inherits className via Instance:FindFirstChildWhichIsA, then applies the property table. Unlike ChildClass, this honors the Instance inheritance chain.

Open Documentation

Descendant Read Only

luau
Find.Descendant: Selector

Selects the first descendant named name via Instance:FindFirstDescendant, then applies the property table to it. Searches the entire subtree, not just direct children of the Instance.

Open Documentation

Parent Read Only

luau
Find.Parent: Selector

Selects the hydrated element's Instance.Parent, then applies the property table to it. Use to reach one level up the tree without naming the parent.

Open Documentation

Path Read Only

luau
Find.Path: Selector

Walks a .-separated path from the hydrated element, one Instance:FindFirstChild step per segment, then applies the property table to the final Instance. A Parent or ^ segment climbs to Instance.Parent instead; empty segments are skipped. If any step misses, nothing is applied.

Open Documentation

Query Read Only

luau
Find.Query: Selector

Selects every descendant matching a Roblox path query via Instance:QueryDescendants, applying the property table to each matched Instance. Fan out one property table across many elements at once.

Open Documentation

QueryFirst Read Only

luau
Find.QueryFirst: Selector

Selects only the first descendant matching a Roblox path query via Instance:QueryDescendants, then applies the property table to that single Instance. The single-match counterpart to Query.

Open Documentation

Functions

resolve

luau
Find.resolve(applied: { any }, instance: Instance, apply: (Instance, Type.Map<any>) -> ())