Show raw api
{
"functions": [
{
"name": "markAncestorsFlattenedDirty",
"desc": "",
"params": [
{
"name": "group",
"desc": "",
"lua_type": "Group"
}
],
"returns": [],
"function_type": "static",
"private": true,
"source": {
"line": 19,
"path": "src/node.luau"
}
},
{
"name": "markChildrenOrderDirty",
"desc": "",
"params": [
{
"name": "group",
"desc": "",
"lua_type": "Group"
}
],
"returns": [],
"function_type": "static",
"private": true,
"source": {
"line": 31,
"path": "src/node.luau"
}
},
{
"name": "getNodeDebugPathName",
"desc": "Returns a debug name for the given node that show's it's name and the name of all its ancestors.\nIf the node is nil it returns \"(nil)\" instead.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string\n"
}
],
"function_type": "static",
"source": {
"line": 42,
"path": "src/node.luau"
}
},
{
"name": "insertBefore",
"desc": "Inserts the given [Node] before another one, guaranteeing that it'll be called before the other node when their parent [Group] runs.\nIf the given node doesn't have a parent, it'll implicitly set it to the other node's parent.\n\nReturns the given node to allow chaining.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node"
},
{
"name": "dependent",
"desc": "",
"lua_type": "Node"
}
],
"returns": [
{
"desc": "",
"lua_type": "Node\n"
}
],
"function_type": "static",
"source": {
"line": 82,
"path": "src/node.luau"
}
},
{
"name": "insertAfter",
"desc": "Inserts the given [Node] after another one, guaranteeing that it'll be called after the other node when their parent [Group] runs.\nIf the given node doesn't have a parent, it'll implicitly set it to the other node's parent.\n\nReturns the given node to allow chaining.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node"
},
{
"name": "dependency",
"desc": "",
"lua_type": "Node"
}
],
"returns": [
{
"desc": "",
"lua_type": "Node\n"
}
],
"function_type": "static",
"source": {
"line": 99,
"path": "src/node.luau"
}
},
{
"name": "insertIn",
"desc": "Sets the given [Node]'s parent to the given [Group].\n\nReturns the given node to allow chaining.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node"
},
{
"name": "parent",
"desc": "",
"lua_type": "Group"
}
],
"returns": [
{
"desc": "",
"lua_type": "Node\n"
}
],
"function_type": "static",
"source": {
"line": 115,
"path": "src/node.luau"
}
},
{
"name": "resolve",
"desc": "Resolves the given [Node], clearing any internal dirty flags.\n\nThis ensures the given node won't have to do any extra work when running later.\n[Group:Run] automatically resolves any unresolved nodes.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node"
}
],
"returns": [
{
"desc": "",
"lua_type": "Node\n"
}
],
"function_type": "static",
"source": {
"line": 128,
"path": "src/node.luau"
}
},
{
"name": "setEnabled",
"desc": "Changes if the given [Node] should be enabled or not.\nWhen a node is disabled it and all of its descendants wont run.",
"params": [
{
"name": "node",
"desc": "",
"lua_type": "Node"
},
{
"name": "enabled",
"desc": "",
"lua_type": "boolean"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 142,
"path": "src/node.luau"
}
}
],
"properties": [],
"types": [
{
"name": "Node",
"desc": "",
"lua_type": "System | Group",
"source": {
"line": 9,
"path": "src/node.luau"
}
}
],
"name": "node",
"desc": "",
"source": {
"line": 4,
"path": "src/node.luau"
}
}