Skip to main content

PlayerInputModeService

This item only works when running on the server. Server

Reports back the player input mode to the server which allows for displaying what mode the uesr is using.

Functions​

GetPlayerInputModeType​

</>
PlayerInputModeService:GetPlayerInputModeType(player: Player) → PlayerInputModeType

Gets the player input mode type from the player

PromisePlayerInputMode​

</>
PlayerInputModeService:PromisePlayerInputMode(
player: Player,
cancelToken: CancelToken
) → Promise<PlayerInputModeType>

Promises the player input mode type from the player

ObservePlayerInputType​

</>
PlayerInputModeService:ObservePlayerInputType(player: Player) → Observable<PlayerInputModeType>

Observes the player input mode type from the player

Show raw api
{
    "functions": [
        {
            "name": "GetPlayerInputModeType",
            "desc": "Gets the player input mode type from the player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerInputModeType"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 40,
                "path": "src/playerinputmode/src/Server/PlayerInputModeService.lua"
            }
        },
        {
            "name": "PromisePlayerInputMode",
            "desc": "Promises the player input mode type from the player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<PlayerInputModeType>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/playerinputmode/src/Server/PlayerInputModeService.lua"
            }
        },
        {
            "name": "ObservePlayerInputType",
            "desc": "Observes the player input mode type from the player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<PlayerInputModeType>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 65,
                "path": "src/playerinputmode/src/Server/PlayerInputModeService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerInputModeService",
    "desc": "Reports back the player input mode to the server which allows for displaying what\nmode the uesr is using.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/playerinputmode/src/Server/PlayerInputModeService.lua"
    }
}