Skip to main content

InputKeyMapSettingUtils

Helper methods for encoding and decoding input lists into network storage

Functions​

getSettingName​

</>
InputKeyMapSettingUtils.getSettingName(
inputKeyMapList: InputKeyMapList,
inputModeType: InputModeType
) → string

Returns the canonical setting name for this input key map list.

encodeInputTypeList​

</>
InputKeyMapSettingUtils.encodeInputTypeList(list: {InputType}) → string

Encodes the list into a string which can be decoded later.

decodeInputTypeList​

</>
InputKeyMapSettingUtils.decodeInputTypeList(encoded: string?) → string

Decodes the list from a string into a safe value.

Show raw api
{
    "functions": [
        {
            "name": "getSettingName",
            "desc": "Returns the canonical setting name for this input key map list.",
            "params": [
                {
                    "name": "inputKeyMapList",
                    "desc": "",
                    "lua_type": "InputKeyMapList"
                },
                {
                    "name": "inputModeType",
                    "desc": "",
                    "lua_type": "InputModeType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/settings-inputkeymap/src/Shared/InputKeyMapSettingUtils.lua"
            }
        },
        {
            "name": "encodeInputTypeList",
            "desc": "Encodes the list into a string which can be decoded later.",
            "params": [
                {
                    "name": "list",
                    "desc": "",
                    "lua_type": "{ InputType }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/settings-inputkeymap/src/Shared/InputKeyMapSettingUtils.lua"
            }
        },
        {
            "name": "decodeInputTypeList",
            "desc": "Decodes the list from a string into a safe value.",
            "params": [
                {
                    "name": "encoded",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/settings-inputkeymap/src/Shared/InputKeyMapSettingUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InputKeyMapSettingUtils",
    "desc": "Helper methods for encoding and decoding input lists into network storage",
    "source": {
        "line": 5,
        "path": "src/settings-inputkeymap/src/Shared/InputKeyMapSettingUtils.lua"
    }
}