Skip to main content

RxPlayerUtils

Utilities for observing players

Functions​

observePlayersBrio​

</>
RxPlayerUtils.observePlayersBrio(predicate: ((Player) → boolean)?) → Observable<Brio<Player>>

Observe players for the lifetime they exist

observeCharactersBrio​

</>
RxPlayerUtils.observeCharactersBrio() → Observable.Observable<Brio.Brio<Model>>

Observes the character model for the player

observeHumanoidsBrio​

</>
RxPlayerUtils.observeHumanoidsBrio() → Observable.Observable<Brio.Brio<Humanoid>>

Observes the character model for the player

observeLocalPlayerBrio​

</>
RxPlayerUtils.observeLocalPlayerBrio() → Observable<Brio<Player>>

Observes the current local player

observeLocalPlayerHumanoidBrio​

</>
RxPlayerUtils.observeLocalPlayerHumanoidBrio() → Observable.Observable<Brio.Brio<Player>>

Observes the current local player's humanoid

observePlayers​

</>
RxPlayerUtils.observePlayers(predicate: ((Player) → boolean)?) → Observable<Player>

Observe players as they're added, and as they are.

observeFirstAppearanceLoaded​

</>
RxPlayerUtils.observeFirstAppearanceLoaded(player: Player) → Observable<()>

Observes the first time the character appearance is loaded

Show raw api
{
    "functions": [
        {
            "name": "observePlayersBrio",
            "desc": "Observe players for the lifetime they exist",
            "params": [
                {
                    "name": "predicate",
                    "desc": "",
                    "lua_type": "((Player) -> boolean)?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Player>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observeCharactersBrio",
            "desc": "Observes the character model for the player",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Brio.Brio<Model>>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observeHumanoidsBrio",
            "desc": "Observes the character model for the player",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Brio.Brio<Humanoid>>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observeLocalPlayerBrio",
            "desc": "Observes the current local player",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Player>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 84,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observeLocalPlayerHumanoidBrio",
            "desc": "Observes the current local player's humanoid",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Brio.Brio<Player>>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observePlayers",
            "desc": "Observe players as they're added, and as they are.",
            "params": [
                {
                    "name": "predicate",
                    "desc": "",
                    "lua_type": "((Player) -> boolean)?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Player>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 106,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        },
        {
            "name": "observeFirstAppearanceLoaded",
            "desc": "Observes the first time the character appearance is loaded",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 136,
                "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxPlayerUtils",
    "desc": "Utilities for observing players",
    "source": {
        "line": 6,
        "path": "src/playerutils/src/Shared/RxPlayerUtils.lua"
    }
}