Skip to main content

RxFriendUtils

Utilities for observing the local player's friends.

Functions​

observeFriendsInServerAsBrios​

</>
RxFriendUtils.observeFriendsInServerAsBrios(player: Player?) → Observable<Brio<Player>>

Observe friends in the current server (not including the LocalPlayer!), useful for social GUIs. The lifetimes exist for the whole duration another player is a friend and in your server. This means if a player is unfriended + friended multiple times per session, they will have emitted multiple friend lifetimes.

Works against PlayerMock players on either side: mocks in the DataModel are enumerated alongside real players, friendship resolves from the mock's "Player.IsFriendsWithAsync" lookup domain, and a mid-test PlayerMock.writeLookup to that domain stands in for the CoreGui friended/unfriended events -- the observable re-reads and emits/kills lifetimes accordingly.

Show raw api
{
    "functions": [
        {
            "name": "observeFriendsInServerAsBrios",
            "desc": "Observe friends in the current server (not including the LocalPlayer!), useful for social GUIs.\nThe lifetimes exist for the whole duration another player is a friend and in your server.\nThis means if a player is unfriended + friended multiple times per session, they will have emitted multiple friend lifetimes.\n\nWorks against [PlayerMock] players on either side: mocks in the DataModel are enumerated\nalongside real players, friendship resolves from the mock's \"Player.IsFriendsWithAsync\" lookup\ndomain, and a mid-test [PlayerMock.writeLookup] to that domain stands in for the CoreGui\nfriended/unfriended events -- the observable re-reads and emits/kills lifetimes accordingly.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Player>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/friendutils/src/Shared/RxFriendUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxFriendUtils",
    "desc": "Utilities for observing the local player's friends.",
    "source": {
        "line": 7,
        "path": "src/friendutils/src/Shared/RxFriendUtils.lua"
    }
}