Skip to main content

RxAttributeUtils

Utility functions involving attributes.

Functions​

observeAttribute​

</>
RxAttributeUtils.observeAttribute(
instance: Instance,
attributeName: string,
defaultValue: any?
) → Observable<any>

Observes an attribute on an instance.

observeAttributeKeysBrio​

</>
RxAttributeUtils.observeAttributeKeysBrio(instance: Instance) → Observable<Brio<string>>

Observes all the attribute keys that

observeAttributeKeys​

</>
RxAttributeUtils.observeAttributeKeys(instance: Instance) → Observable<string>

Observes all the attribute keys for an instance

observeAttributeBrio​

</>
RxAttributeUtils.observeAttributeBrio(
instance: Instance,
attributeName: string,
condition: function | nil
) → Observable<Brio<any>>

Observes an attribute on an instance with a conditional statement.

Show raw api
{
    "functions": [
        {
            "name": "observeAttribute",
            "desc": "Observes an attribute on an instance.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "attributeName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultValue",
                    "desc": "",
                    "lua_type": "any?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<any>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/attributeutils/src/Shared/RxAttributeUtils.lua"
            }
        },
        {
            "name": "observeAttributeKeysBrio",
            "desc": "Observes all the attribute keys that",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<string>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/attributeutils/src/Shared/RxAttributeUtils.lua"
            }
        },
        {
            "name": "observeAttributeKeys",
            "desc": "Observes all the attribute keys for an instance",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "path": "src/attributeutils/src/Shared/RxAttributeUtils.lua"
            }
        },
        {
            "name": "observeAttributeBrio",
            "desc": "Observes an attribute on an instance with a conditional statement.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "attributeName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "condition",
                    "desc": "",
                    "lua_type": "function | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<any>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "src/attributeutils/src/Shared/RxAttributeUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxAttributeUtils",
    "desc": "Utility functions involving attributes.",
    "source": {
        "line": 5,
        "path": "src/attributeutils/src/Shared/RxAttributeUtils.lua"
    }
}