Skip to main content

AnimatedSpritesheet

A spritesheet that is animated. See AnimatedSpritesheetPlayer for playback.

Functions​

new​

</>
AnimatedSpritesheet.new(options: AnimatedSpritesheetOptions) → AnimatedSpritesheet

Types

​

interface AnimatedSpritesheetOptions {
texture: string
frames: number
spritesPerRow: number
spriteSize: Vector2
framesPerSecond: number
}

Constructs a new AnimatedSpritesheet

GetSpriteSize​

</>
AnimatedSpritesheet:GetSpriteSize() → Vector2

Gets the sprite size

GetFramesPerSecond​

</>
AnimatedSpritesheet:GetFramesPerSecond() → number

Gets the frames per a second

GetPlayTime​

</>
AnimatedSpritesheet:GetPlayTime() → number

Gets the play time for the animated sheet

GetFrames​

</>
AnimatedSpritesheet:GetFrames() → frames

Retrieves the frames for the sprite sheet.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new AnimatedSpritesheet",
            "params": [
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "AnimatedSpritesheetOptions"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimatedSpritesheet"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        },
        {
            "name": "GetSpriteSize",
            "desc": "Gets the sprite size",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        },
        {
            "name": "GetFramesPerSecond",
            "desc": "Gets the frames per a second",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 62,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        },
        {
            "name": "GetPlayTime",
            "desc": "Gets the play time for the animated sheet",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        },
        {
            "name": "GetFrames",
            "desc": "Retrieves the frames for the sprite sheet.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "frames"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 78,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "AnimatedSpritesheetOptions",
            "desc": "",
            "fields": [
                {
                    "name": "texture",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "frames",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "spritesPerRow",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "spriteSize",
                    "lua_type": "Vector2",
                    "desc": ""
                },
                {
                    "name": "framesPerSecond",
                    "lua_type": "number",
                    "desc": ""
                }
            ],
            "source": {
                "line": 23,
                "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
            }
        }
    ],
    "name": "AnimatedSpritesheet",
    "desc": "A spritesheet that is animated. See [AnimatedSpritesheetPlayer] for playback.",
    "source": {
        "line": 5,
        "path": "src/sprites/src/Shared/Sprite/AnimatedSpritesheet.lua"
    }
}