Skip to main content

InputImageLibrary

InputImageLibrary with a variety of dark and light themed icons for inputs on keyboard, xbox, touched events, mouse, and more.

Functions​

GetPreloadAssetIds​

</>
InputImageLibrary.GetPreloadAssetIds(self: InputImageLibrary) → {string}

Retrieves all the asset ids to preload

GetSprite​

</>
InputImageLibrary.GetSprite(
keyCode: any,--

The sprite keyCode to get

preferredStyle: string?,--

The preferred style type to retrieve this in

preferredPlatform: string?--

The preferred platform to get the sprite for

) → Sprite

Retrieves a sprite from the library

StyleImage​

</>
InputImageLibrary.StyleImage(
keyCode: any,--

The sprite keyCode to get

preferredStyle: string?,--

The preferred style type to retrieve this in

preferredPlatform: string?--

The preferred platform to get the sprite for

) → Sprite

Styles a GUI for a specific keycode

local InputImageLibrary = require("InputImageLibrary")
InputImageLibrary:StyleImage(script.Parent, Enum.KeyCode.ButtonA)
Show raw api
{
    "functions": [
        {
            "name": "GetPreloadAssetIds",
            "desc": "Retrieves all the asset ids to preload",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputImageLibrary"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
            }
        },
        {
            "name": "GetSprite",
            "desc": "Retrieves a sprite from the library",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputImageLibrary"
                },
                {
                    "name": "keyCode",
                    "desc": "The sprite keyCode to get",
                    "lua_type": "any"
                },
                {
                    "name": "preferredStyle",
                    "desc": "The preferred style type to retrieve this in",
                    "lua_type": "string?"
                },
                {
                    "name": "preferredPlatform",
                    "desc": "The preferred platform to get the sprite for",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Sprite"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
            }
        },
        {
            "name": "StyleImage",
            "desc": "Styles a GUI for a specific keycode\n\n```lua\nlocal InputImageLibrary = require(\"InputImageLibrary\")\nInputImageLibrary:StyleImage(script.Parent, Enum.KeyCode.ButtonA)\n```",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputImageLibrary"
                },
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "ImageLabel | ImageButton"
                },
                {
                    "name": "keyCode",
                    "desc": "The sprite keyCode to get",
                    "lua_type": "any"
                },
                {
                    "name": "preferredStyle",
                    "desc": "The preferred style type to retrieve this in",
                    "lua_type": "string?"
                },
                {
                    "name": "preferredPlatform",
                    "desc": "The preferred platform to get the sprite for",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Sprite"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InputImageLibrary",
    "desc": "InputImageLibrary with a variety of dark and light themed icons for inputs on keyboard, xbox, touched events,\nmouse, and more.",
    "source": {
        "line": 8,
        "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
    }
}