Skip to main content

InputKeyMapListUtils

Client side utility helpers for observing input modes for the current client.

Functions​

getNewInputModeTypeSelector​

</>
InputKeyMapListUtils.getNewInputModeTypeSelector(
inputKeyMapList: InputKeyMapList,
serviceBag: ServiceBag
) → InputModeTypeSelector

Observes the input enums list

observeActiveInputKeyMap​

</>
InputKeyMapListUtils.observeActiveInputKeyMap(
inputKeyMapList: InputKeyMapList,
serviceBag: ServiceBag
) → Observable<InputKeyMap>

Observes the input types for the active input map

observeActiveInputTypesList​

</>
InputKeyMapListUtils.observeActiveInputTypesList(
inputKeyMapList: InputKeyMapList,
serviceBag: ServiceBag
) → Observable<{InputType}?>

Observes the input types for the active input map.

warning

This should be used for hinting inputs, but it's preferred to bind inputs for all modes. See InputKeyMapList.ObserveInputEnumsList

observeActiveInputModeType​

</>
InputKeyMapListUtils.observeActiveInputModeType(
inputKeyMapList: InputKeyMapList,
serviceBag: ServiceBag
) → Observable<InputModeType?>

Observes the active input mode currently selected.

Show raw api
{
    "functions": [
        {
            "name": "getNewInputModeTypeSelector",
            "desc": "Observes the input enums list",
            "params": [
                {
                    "name": "inputKeyMapList",
                    "desc": "",
                    "lua_type": "InputKeyMapList"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InputModeTypeSelector"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/inputkeymaputils/src/Client/InputKeyMapListUtils.lua"
            }
        },
        {
            "name": "observeActiveInputKeyMap",
            "desc": "Observes the input types for the active input map",
            "params": [
                {
                    "name": "inputKeyMapList",
                    "desc": "",
                    "lua_type": "InputKeyMapList"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<InputKeyMap>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/inputkeymaputils/src/Client/InputKeyMapListUtils.lua"
            }
        },
        {
            "name": "observeActiveInputTypesList",
            "desc": "Observes the input types for the active input map.\n\n:::warning\nThis should be used for hinting inputs, but it's preferred to\nbind inputs for all modes. See [InputKeyMapList.ObserveInputEnumsList]\n:::",
            "params": [
                {
                    "name": "inputKeyMapList",
                    "desc": "",
                    "lua_type": "InputKeyMapList"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<{ InputType }?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/inputkeymaputils/src/Client/InputKeyMapListUtils.lua"
            }
        },
        {
            "name": "observeActiveInputModeType",
            "desc": "Observes the active input mode currently selected.",
            "params": [
                {
                    "name": "inputKeyMapList",
                    "desc": "",
                    "lua_type": "InputKeyMapList"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<InputModeType?>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 89,
                "path": "src/inputkeymaputils/src/Client/InputKeyMapListUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InputKeyMapListUtils",
    "desc": "Client side utility helpers for observing input modes for the current client.",
    "source": {
        "line": 6,
        "path": "src/inputkeymaputils/src/Client/InputKeyMapListUtils.lua"
    }
}