Skip to main content

RxBinderUtils

Utility methods to observe bound objects on instances. This is what makes the Rx library with binders really good.

INFO

Using this API, you can query most game-state in very efficient ways, and react to the world changing in real-time. This makes programming streaming and other APIs really nice.

Functions​

observeLinkedBoundClassBrio​

</>
RxBinderUtils.observeLinkedBoundClassBrio(
linkName: string,
parent: Instance,
binder: Binder<T>
) → Observable<Brio<T>>

Observes a structure where a parent has object values with linked objects (for example), maybe an AI has a list of linked objectvalue tasks to execute.

observeChildrenBrio​

</>
RxBinderUtils.observeChildrenBrio(
binder: Binder<T>,
instance: Instance
) → Observable<Brio<T>>

Observes bound children classes.

observeBoundChildClassBrio​

</>
RxBinderUtils.observeBoundChildClassBrio(
binder: Binder<T>,
instance: Instance
) → Observable<Brio<T>>

Observes bound children classes.

observeBoundParentClassBrio​

</>
RxBinderUtils.observeBoundParentClassBrio(
binder: Binder<T>,
instance: Instance
) → Observable<Brio<T>>

Observes ainstance's parent class that is bound.

observeBoundParent​

</>
RxBinderUtils.observeBoundParent(
binder: Binder<T>,
instance: Instance
) → Observable<T?>

Observes the bound class on the instance's parent.

observeBoundAncestor​

</>
RxBinderUtils.observeBoundAncestor(
binder: Binder<T>,
instance: Instance
) → Observable<T?>

Observes the closest ancestor of the instance bound to the given binder, starting at the instance's parent. Emits nil whenever no ancestor is bound. The instance itself never counts.

observeBoundChildClassesBrio​

</>
RxBinderUtils.observeBoundChildClassesBrio(
binders: {Binder<T>},
instance: Instance
) → Observable<Brio<T>>

Observes all bound classes that hit that list of binders

observeBoundClass​

</>
RxBinderUtils.observeBoundClass(
binder: Binder<T>,
instance: Instance
) → Observable<T?>

Observes a bound class on a given instance.

observeBoundClassBrio​

</>
RxBinderUtils.observeBoundClassBrio(
binder: Binder<T>,
instance: Instance
) → Observable<Brio<T>>

Observes a bound class on a given instance.

observeBoundClassesBrio​

</>
RxBinderUtils.observeBoundClassesBrio(
binders: {Binder<T>},
instance: Instance
) → Observable<Brio<T>>

Observes all bound classes for a given binder.

observeAllBrio​

</>
RxBinderUtils.observeAllBrio(binder: Binder) → Observable<Brio<T>>

Observes all instances bound to a given binder.

observeAllArrayBrio​

</>
RxBinderUtils.observeAllArrayBrio(binder: Binder) → Observable<Brio<{T}>>

Observes all instances bound to the given binder as an unordered array.

Show raw api
{
    "functions": [
        {
            "name": "observeLinkedBoundClassBrio",
            "desc": "Observes a structure where a parent has object values with linked objects (for example), maybe\nan AI has a list of linked objectvalue tasks to execute.",
            "params": [
                {
                    "name": "linkName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeChildrenBrio",
            "desc": "Observes bound children classes.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundChildClassBrio",
            "desc": "Observes bound children classes.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundParentClassBrio",
            "desc": "Observes ainstance's parent class that is bound.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 96,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundParent",
            "desc": "Observes the bound class on the instance's parent.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 122,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundAncestor",
            "desc": "Observes the closest ancestor of the instance bound to the given binder, starting at the\ninstance's parent. Emits nil whenever no ancestor is bound. The instance itself never counts.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 146,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundChildClassesBrio",
            "desc": "Observes all bound classes that hit that list of binders",
            "params": [
                {
                    "name": "binders",
                    "desc": "",
                    "lua_type": "{ Binder<T> }"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 197,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundClass",
            "desc": "Observes a bound class on a given instance.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 215,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundClassBrio",
            "desc": "Observes a bound class on a given instance.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 238,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeBoundClassesBrio",
            "desc": "Observes all bound classes for a given binder.",
            "params": [
                {
                    "name": "binders",
                    "desc": "",
                    "lua_type": "{ Binder<T> }"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 273,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeAllBrio",
            "desc": "Observes all instances bound to a given binder.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 294,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        },
        {
            "name": "observeAllArrayBrio",
            "desc": "Observes all instances bound to the given binder as an unordered array.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<{ T }>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 326,
                "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxBinderUtils",
    "desc": "Utility methods to observe bound objects on instances. This is what makes the Rx library with\nbinders really good.\n\n:::info\nUsing this API, you can query most game-state in very efficient ways, and react to the world\nchanging in real-time. This makes programming streaming and other APIs really nice.\n:::",
    "source": {
        "line": 13,
        "path": "src/rxbinderutils/src/Shared/RxBinderUtils.lua"
    }
}