Home › Overview › Flux

Edit

Types

Selection type

type Selection = { any }

ClassSelector type

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

QuerySelector type

type QuerySelector = (query: string) -> (Type.Map<any>) -> Selection

ParentSelector type

type ParentSelector = () -> (Type.Map<any>) -> Selection

Properties

Defaults Read Only

Edit.Defaults: { [string]: { [string]: unknown } }

Functions

edit

Edit.edit(instance: Instance, properties: Type.Map<any>): Instance

new

Edit.new(className: string, properties: any): Instance

split

Edit.split(props: any, keys: any, ...: any): ...any

Partitions props into one table per keys group plus a final table holding every remaining key, leaving props untouched. Pass a schema table or an annotated key-literal array ({ "label" | "onClick" }) to preserve exact Pick/Omit types on a single group.

local OWN: { "label" | "onClick" } = { "label", "onClick" }
local own, rest = Flux.split(props, OWN)

Open Documentation

Flags

defaults

Edit.Flags.defaults: boolean

Controls whether Flux.new applies the per-class Flux.Defaults table to new instances (true by default). AutoButtonColor = false is still applied to TextButton and ImageButton even when false.

Open Documentation

Find

Ancestor Read Only

Edit.Find.Ancestor: QuerySelector

Selects the first ancestor named name via Instance:FindFirstAncestor and applies the property table to it.

Open Documentation

AncestorClass Read Only

Edit.Find.AncestorClass: ClassSelector

Selects the first ancestor of class className via Instance:FindFirstAncestorOfClass and applies the property table to it.

Open Documentation

AncestorIsA Read Only

Edit.Find.AncestorIsA: ClassSelector

Selects the first ancestor matching IsA(className) via Instance:FindFirstAncestorWhichIsA and applies the property table to it.

Open Documentation

Child Read Only

Edit.Find.Child: QuerySelector

Selects the first direct child named name via Instance:FindFirstChild and applies the property table to it.

Open Documentation

ChildClass Read Only

Edit.Find.ChildClass: ClassSelector

Selects the first direct child of class className via Instance:FindFirstChildOfClass and applies the property table to it.

Open Documentation

ChildIsA Read Only

Edit.Find.ChildIsA: ClassSelector

Selects the first direct child matching IsA(className) via Instance:FindFirstChildWhichIsA and applies the property table to it.

Open Documentation

Descendant Read Only

Edit.Find.Descendant: QuerySelector

Selects the first descendant named name via Instance:FindFirstChild(name, true) and applies the property table to it.

Open Documentation

Parent Read Only

Edit.Find.Parent: ParentSelector

Selects the target's Instance.Parent and applies the property table to it (Find.Parent() { ... }).

Open Documentation

Path Read Only

Edit.Find.Path: QuerySelector

Walks a .-separated child path from the target (Parent or ^ climbs to Instance.Parent) and applies the property table to the final Instance.

Open Documentation

Query Read Only

Edit.Find.Query: QuerySelector

Selects every descendant matching a Roblox query string via Instance:QueryDescendants and applies the property table to each match.

Open Documentation

QueryFirst Read Only

Edit.Find.QueryFirst: QuerySelector

Selects the first descendant matching a Roblox query string via Instance:QueryDescendants and applies the property table to it.

Open Documentation