Skip to main content

PlayerInputModeServiceClient

This item only works when running on the client. Client

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

Functions​

ObservePlayerInputType​

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

Observes the player input mode type from the player

GetPlayerInputModeType​

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

Gets the player input mode type from the player

Show raw api
{
    "functions": [
        {
            "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": 74,
                "path": "src/playerinputmode/src/Client/PlayerInputModeServiceClient.lua"
            }
        },
        {
            "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": 86,
                "path": "src/playerinputmode/src/Client/PlayerInputModeServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerInputModeServiceClient",
    "desc": "Reports back the player input mode to the server which allows for displaying what\nmode the uesr is using.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "src/playerinputmode/src/Client/PlayerInputModeServiceClient.lua"
    }
}