Skip to main content

PreferredParentUtils

Handles logic for creating a "preferred" parent container or erroring if it already exists.

Functions​

createPreferredParentRetriever​

</>
PreferredParentUtils.createPreferredParentRetriever(
parent: Instance,
name: string,
forceCreate: boolean
) → () → Instance

getPreferredParent​

</>
PreferredParentUtils.getPreferredParent(
parent: Instance,
name: string,
forceCreate: boolean
) → Instance
Show raw api
{
    "functions": [
        {
            "name": "createPreferredParentRetriever",
            "desc": "",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "forceCreate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 17,
                "path": "src/preferredparentutils/src/Shared/PreferredParentUtils.lua"
            }
        },
        {
            "name": "getPreferredParent",
            "desc": "",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "forceCreate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/preferredparentutils/src/Shared/PreferredParentUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PreferredParentUtils",
    "desc": "Handles logic for creating a \"preferred\" parent container or erroring if\nit already exists.",
    "source": {
        "line": 7,
        "path": "src/preferredparentutils/src/Shared/PreferredParentUtils.lua"
    }
}