Skip to main content

Sprite

A single image on a spritesheet.

Types​

SpriteData​

</>
interface SpriteData {
Texture: string
Size: Vector2
Position: Vector2
Name: string
}

Data used to construct a sprite.

Functions​

new​

</>
Sprite.new(data: SpriteData) → Sprite

Constructs a new sprite

Style​

</>
Sprite:Style(gui: ImageLabel | ImageButton) → Instance

Applies the styling to the gui

Get​

</>
Sprite:Get(instanceType: "ImageLabel" | "ImageButton") → ImageLabel | ImageButton

Returns a new sprite with the specified instanceType

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new sprite",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "SpriteData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Sprite"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/sprites/src/Shared/Sprite/Sprite.lua"
            }
        },
        {
            "name": "Style",
            "desc": "Applies the styling to the gui",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "ImageLabel | ImageButton"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 41,
                "path": "src/sprites/src/Shared/Sprite/Sprite.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Returns a new sprite with the specified `instanceType`",
            "params": [
                {
                    "name": "instanceType",
                    "desc": "",
                    "lua_type": "\"ImageLabel\" | \"ImageButton\""
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ImageLabel | ImageButton"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 56,
                "path": "src/sprites/src/Shared/Sprite/Sprite.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "SpriteData",
            "desc": "Data used to construct a sprite.",
            "fields": [
                {
                    "name": "Texture",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "Size",
                    "lua_type": "Vector2",
                    "desc": ""
                },
                {
                    "name": "Position",
                    "lua_type": "Vector2",
                    "desc": ""
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                }
            ],
            "source": {
                "line": 19,
                "path": "src/sprites/src/Shared/Sprite/Sprite.lua"
            }
        }
    ],
    "name": "Sprite",
    "desc": "A single image on a spritesheet.",
    "source": {
        "line": 5,
        "path": "src/sprites/src/Shared/Sprite/Sprite.lua"
    }
}