Skip to main content

RxValueBaseUtils

Functions​

observe​

</>
RxValueBaseUtils.observe(
parent: Instance,
className: string,
name: string
) → Observable<any>
warning

This caches the last value seen, and may memory leak.

:::

observeBrio​

</>
RxValueBaseUtils.observeBrio(
parent: Instance,
className: string,
name: string
) → Observable<Brio<any>>

Observes a value base underneath a parent (last named child).

observeValue​

</>
RxValueBaseUtils.observeValue(valueObject: Instance) → Observable<T>

Observables a given value object's value

Show raw api
{
    "functions": [
        {
            "name": "observe",
            "desc": ":::warning\nThis caches the last value seen, and may memory leak.\n:::\n\n:::",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<any>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/valuebaseutils/src/Shared/RxValueBaseUtils.lua"
            }
        },
        {
            "name": "observeBrio",
            "desc": "Observes a value base underneath a parent (last named child).",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<any>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/valuebaseutils/src/Shared/RxValueBaseUtils.lua"
            }
        },
        {
            "name": "observeValue",
            "desc": "Observables a given value object's value",
            "params": [
                {
                    "name": "valueObject",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/valuebaseutils/src/Shared/RxValueBaseUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxValueBaseUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/valuebaseutils/src/Shared/RxValueBaseUtils.lua"
    }
}