Skip to main content

RxSelectionUtils

Functions​

observeFirstSelectionWhichIsA​

</>
RxSelectionUtils.observeFirstSelectionWhichIsA(className: string) → Observable<Instance?>

Observes first selection in the selection list which is of a class

RxSelectionUtils.observeFirstSelectionWhichIsA("BasePart"):Subscribe(function(part)
	print("part", part)
end)

observeFirstSelectionWhichIsABrio​

</>
RxSelectionUtils.observeFirstSelectionWhichIsABrio(className: string) → Observable<Brio<Instance>>

Observes first selection in the selection list which is of a class wrapped in a brio

RxSelectionUtils.observeFirstSelectionWhichIsA("BasePart"):Subscribe(function(brio)
	if brio:IsDead() then
		return
	end

	print("part", brio:GetValue())
end)

observeFirstAdornee​

</>
RxSelectionUtils.observeFirstAdornee() → Observable<Instance?>

Observes first selection in the selection list which is an "Adornee"

observeAdorneesBrio​

</>
RxSelectionUtils.observeAdorneesBrio() → Observable<Brio<Instance>>

Observes selection in which are an "Adornee"

observeFirstSelection​

</>
RxSelectionUtils.observeFirstSelection(where: callback) → Observable<Instance?>

Observes first selection which meets condition

RxSelectionUtils.observeFirstSelection(function(instance)
	return instance:IsA("BasePart")
end):Subscribe(function(part)
	print("part", part)
end)

observeFirstSelectionBrio​

</>
RxSelectionUtils.observeFirstSelectionBrio(where: callback) → Observable<Brio<Instance>>

Observes first selection which meets condition

observeSelectionList​

</>
RxSelectionUtils.observeSelectionList() → Observable<{Instance}>

Observes the current selection table.

observeSelectionItemsBrio​

</>
RxSelectionUtils.observeSelectionItemsBrio() → Observable<Brio<Instance>>

Observes selection items by brio. De-duplicates changed events.

Show raw api
{
    "functions": [
        {
            "name": "observeFirstSelectionWhichIsA",
            "desc": "Observes first selection in the selection list which is of a class\n\n```lua\nRxSelectionUtils.observeFirstSelectionWhichIsA(\"BasePart\"):Subscribe(function(part)\n\tprint(\"part\", part)\nend)\n```",
            "params": [
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Instance?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeFirstSelectionWhichIsABrio",
            "desc": "Observes first selection in the selection list which is of a class wrapped in a brio\n\n```lua\nRxSelectionUtils.observeFirstSelectionWhichIsA(\"BasePart\"):Subscribe(function(brio)\n\tif brio:IsDead() then\n\t\treturn\n\tend\n\n\tprint(\"part\", brio:GetValue())\nend)\n```",
            "params": [
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Instance>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeFirstAdornee",
            "desc": "Observes first selection in the selection list which is an \"Adornee\"",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Instance?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeAdorneesBrio",
            "desc": "Observes selection in which are an \"Adornee\"",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Instance>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 78,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeFirstSelection",
            "desc": "Observes first selection which meets condition\n\n```lua\nRxSelectionUtils.observeFirstSelection(function(instance)\n\treturn instance:IsA(\"BasePart\")\nend):Subscribe(function(part)\n\tprint(\"part\", part)\nend)\n```",
            "params": [
                {
                    "name": "where",
                    "desc": "",
                    "lua_type": "callback"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Instance?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 101,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeFirstSelectionBrio",
            "desc": "Observes first selection which meets condition",
            "params": [
                {
                    "name": "where",
                    "desc": "",
                    "lua_type": "callback"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Instance>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 140,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeSelectionList",
            "desc": "Observes the current selection table.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<{ Instance }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 158,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        },
        {
            "name": "observeSelectionItemsBrio",
            "desc": "Observes selection items by brio. De-duplicates changed events.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Instance>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 178,
                "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxSelectionUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/selectionutils/src/Shared/RxSelectionUtils.lua"
    }
}