Skip to main content

Streamable

Custom version of Sleitnick's Streamable module to use Maids https://github.com/Sleitnick/RbxUtil/blob/main/modules/streamable/Streamable.lua

Functions​

new​

Constructor
</>
Streamable.new(
parent: Instance,
childName: string
) → Streamable

Constructs a Streamable that watches for a direct child of name childName within the parent Instance. Call Observe to observe the existence of the child within the parent.

primary​

</>
Streamable.primary(model: Model) → Streamable

Constructs a streamable that watches for the PrimaryPart of the given parent Model.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a Streamable that watches for a direct child of name `childName`\nwithin the `parent` Instance. Call `Observe` to observe the existence of\nthe child within the parent.",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "childName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Streamable"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 65,
                "path": "src/shared/modules/Streamable.lua"
            }
        },
        {
            "name": "primary",
            "desc": "Constructs a streamable that watches for the PrimaryPart of the\ngiven `parent` Model.",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Streamable"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/shared/modules/Streamable.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Streamable",
    "desc": "Custom version of Sleitnick's Streamable module to use Maids\nhttps://github.com/Sleitnick/RbxUtil/blob/main/modules/streamable/Streamable.lua",
    "source": {
        "line": 52,
        "path": "src/shared/modules/Streamable.lua"
    }
}