Skip to main content

SocialServiceUtils

Utility functions wrapping SocialService with promises

Functions​

promiseCanSendGameInvite​

</>
SocialServiceUtils.promiseCanSendGameInvite(player: Player) → Promise<boolean>

Wraps SocialService:CanSendGameInviteAsync(player)

promisePromptGameInvite​

</>
SocialServiceUtils.promisePromptGameInvite(
player: Player,
) → Promise

Prompts the user to send an in-game invite and resolves once the prompt is closed.

Show raw api
{
    "functions": [
        {
            "name": "promiseCanSendGameInvite",
            "desc": "Wraps SocialService:CanSendGameInviteAsync(player)",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/socialserviceutils/src/Shared/SocialServiceUtils.lua"
            }
        },
        {
            "name": "promisePromptGameInvite",
            "desc": "Prompts the user to send an in-game invite and resolves once the prompt is closed.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "ExperienceInviteOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/socialserviceutils/src/Shared/SocialServiceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SocialServiceUtils",
    "desc": "Utility functions wrapping SocialService with promises",
    "source": {
        "line": 5,
        "path": "src/socialserviceutils/src/Shared/SocialServiceUtils.lua"
    }
}