Skip to main content

PlayerInputModeUtils

Utility methods to track public player input mode

Functions​

getPlayerInputModeType​

</>
PlayerInputModeUtils.getPlayerInputModeType(player: Player) → PlayerInputModeType?

Returns the player input mode type for a player.

observePlayerInputModeType​

</>
PlayerInputModeUtils.observePlayerInputModeType(player: Player) → Observable<PlayerInputModeType?>

Observes the player input mode type for a player.

promisePlayerInputMode​

</>
PlayerInputModeUtils.promisePlayerInputMode(
player: Player,
cancelToken: CancelToken?
) → Promise<string?>

Observes the player input mode type for a player.

isInputModeType​

</>
PlayerInputModeUtils.isInputModeType(playerInputModeType: any) → boolean

Checks if the input mode type is valid.

setPlayerInputModeType​

</>
PlayerInputModeUtils.setPlayerInputModeType(
player: Player,
playerInputModeType: string
) → ()

Sets the player input mode type for a player.

Show raw api
{
    "functions": [
        {
            "name": "getPlayerInputModeType",
            "desc": "Returns the player input mode type for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerInputModeType?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
            }
        },
        {
            "name": "observePlayerInputModeType",
            "desc": "Observes the player input mode type for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<PlayerInputModeType?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
            }
        },
        {
            "name": "promisePlayerInputMode",
            "desc": "Observes the player input mode type for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
            }
        },
        {
            "name": "isInputModeType",
            "desc": "Checks if the input mode type is valid.",
            "params": [
                {
                    "name": "playerInputModeType",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
            }
        },
        {
            "name": "setPlayerInputModeType",
            "desc": "Sets the player input mode type for a player.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "playerInputModeType",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerInputModeUtils",
    "desc": "Utility methods to track public player input mode",
    "source": {
        "line": 6,
        "path": "src/playerinputmode/src/Shared/PlayerInputModeUtils.lua"
    }
}