Skip to main content

Group

Class

Properties​

kind​

This item is read only and cannot be modified. Read Only
</>
Group.kind: "Group"

name​

</>
Group.name: string

The name of this node.

parent​

</>
Group.parent: Group?

What Group this node belongs to. When the parent runs, this node also runs (with the proper order).

enabled​

</>
Group.enabled: boolean

If the node is enabled or not. While disabled, this node won't run itself or any of it's children.

Functions​

new​

</>
Group.new(name: string) → Group

Creates a new Group with the given name.

Before​

</>
Group:Before(dependent: Node) → Group

A reference to node.insertBefore.

After​

</>
Group:After(dependency: Node) → Group

A reference to node.insertAfter.

In​

</>
Group:In(parent: Group) → Group

A reference to node.insertIn.

Resolve​

</>
Group:Resolve() → Group

A reference to node.resolve.

SetEnabled​

</>
Group:SetEnabled(enabled: boolean) → ()

A reference to node.setEnabled.

Add​

</>
Group:Add(child: Node) → ()

Adds the given Node to this group.

Run​

</>
Group:Run(dt: number) → ()

Runs all descendant systems in their sorted order.

GetChildren​

</>
Group:GetChildren() → {Node}

Returns a sorted list of this group's children.

GetFlattened​

</>
Group:GetFlattened() → {SystemCallback}

Returns a sorted list of all descendant system callbacks. This is the list that Group:Run iterates over.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new [Group] with the given name.",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Group\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/group.luau"
            }
        },
        {
            "name": "Before",
            "desc": "A reference to [node.insertBefore].",
            "params": [
                {
                    "name": "dependent",
                    "desc": "",
                    "lua_type": "Node"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Group"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 187,
                "path": "src/group.luau"
            }
        },
        {
            "name": "After",
            "desc": "A reference to [node.insertAfter].",
            "params": [
                {
                    "name": "dependency",
                    "desc": "",
                    "lua_type": "Node"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Group"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 198,
                "path": "src/group.luau"
            }
        },
        {
            "name": "In",
            "desc": "A reference to [node.insertIn].",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Group"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Group"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 209,
                "path": "src/group.luau"
            }
        },
        {
            "name": "Resolve",
            "desc": "A reference to [node.resolve].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Group"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 219,
                "path": "src/group.luau"
            }
        },
        {
            "name": "SetEnabled",
            "desc": "A reference to [node.setEnabled].",
            "params": [
                {
                    "name": "enabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 229,
                "path": "src/group.luau"
            }
        },
        {
            "name": "Add",
            "desc": "Adds the given [Node] to this group.",
            "params": [
                {
                    "name": "child",
                    "desc": "",
                    "lua_type": "Node"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 239,
                "path": "src/group.luau"
            }
        },
        {
            "name": "Run",
            "desc": "Runs all descendant [systems](System) in their sorted order.",
            "params": [
                {
                    "name": "dt",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 257,
                "path": "src/group.luau"
            }
        },
        {
            "name": "GetChildren",
            "desc": "Returns a sorted list of this group's children.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Node }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 275,
                "path": "src/group.luau"
            }
        },
        {
            "name": "GetFlattened",
            "desc": "Returns a sorted list of all descendant [system callbacks](System#callback).\nThis is the list that [Group:Run] iterates over.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ SystemCallback }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 292,
                "path": "src/group.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "kind",
            "desc": "\t",
            "lua_type": "\"Group\"",
            "readonly": true,
            "source": {
                "line": 126,
                "path": "src/group.luau"
            }
        },
        {
            "name": "_children",
            "desc": "\t",
            "lua_type": "{ Node }",
            "private": true,
            "source": {
                "line": 133,
                "path": "src/group.luau"
            }
        },
        {
            "name": "_flattened",
            "desc": "\t",
            "lua_type": "{ SystemCallback }",
            "private": true,
            "source": {
                "line": 140,
                "path": "src/group.luau"
            }
        },
        {
            "name": "_childrenOrderDirty",
            "desc": "While true, [_children](Group#_children) needs to be sorted.\n[Group:GetChildren] will automatically resolve this.\n\n\t",
            "lua_type": "boolean",
            "private": true,
            "source": {
                "line": 150,
                "path": "src/group.luau"
            }
        },
        {
            "name": "_flattenedDirty",
            "desc": "While true, [_flattened](Group#_flattened) is not longer accurate and needs to be rebuilt.\n[Group:GetFlattened] will automatically resolve this.\n\n\t",
            "lua_type": "boolean",
            "private": true,
            "source": {
                "line": 160,
                "path": "src/group.luau"
            }
        },
        {
            "name": "name",
            "desc": "The name of this node.",
            "lua_type": "string",
            "source": {
                "line": 10,
                "path": "src/types.luau"
            }
        },
        {
            "name": "parent",
            "desc": "What [Group] this node belongs to. When the parent runs, this node also runs (with the proper order).",
            "lua_type": "Group?",
            "source": {
                "line": 25,
                "path": "src/types.luau"
            }
        },
        {
            "name": "enabled",
            "desc": "If the node is enabled or not. While disabled, this node won't run itself or any of it's children.",
            "lua_type": "boolean",
            "source": {
                "line": 40,
                "path": "src/types.luau"
            }
        },
        {
            "name": "_dependencies",
            "desc": "A set of [Nodes](Node) that should run before this one.",
            "lua_type": "{ [Node]: true }",
            "private": true,
            "source": {
                "line": 56,
                "path": "src/types.luau"
            }
        },
        {
            "name": "_dependents",
            "desc": "A set of [Nodes](Node) that should run after this one.",
            "lua_type": "{ [Node]: true }",
            "private": true,
            "source": {
                "line": 73,
                "path": "src/types.luau"
            }
        }
    ],
    "types": [],
    "name": "Group",
    "desc": "",
    "tags": [
        "Class"
    ],
    "source": {
        "line": 5,
        "path": "src/group.luau"
    }
}