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() → {string}

Retrieves all the asset ids to preload

GetSprite​

</>
InputImageLibrary:GetSprite(
index: number,--

The sprite index 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

Show raw api
{
    "functions": [
        {
            "name": "GetPreloadAssetIds",
            "desc": "Retrieves all the asset ids to preload",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
            }
        },
        {
            "name": "GetSprite",
            "desc": "Retrieves a sprite from the library",
            "params": [
                {
                    "name": "index",
                    "desc": "The sprite index to get",
                    "lua_type": "number"
                },
                {
                    "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": "method",
            "source": {
                "line": 59,
                "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": 7,
        "path": "src/sprites/src/Shared/InputImageLibrary/init.lua"
    }
}