Skip to main content

Flipbook

A spritesheet that is animated. See FlipbookPlayer for playback.

Functions​

new​

</>
Flipbook.new(data: FlipbookData) → Flipbook

Types

​

interface FlipbookData {
image: string
frameCount: number
rows: number
columns: number
imageRectSize: Vector2
frameRate: number
restFrame: number | nil--

Optional reset frame

}

Constructs a new Flipbook

GetImageRectSize​

</>
Flipbook:GetImageRectSize() → Vector2

Gets the sprite size

GetFrameRate​

</>
Flipbook:GetFrameRate() → number

Gets the frames per a second

GetPlayTime​

</>
Flipbook:GetPlayTime() → number

Gets the play time for the animated sheet

GetFrameCount​

</>
Flipbook:GetFrameCount() → frames

Retrieves the frames for the sprite sheet.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new Flipbook",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "FlipbookData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Flipbook"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        },
        {
            "name": "GetImageRectSize",
            "desc": "Gets the sprite size",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 141,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        },
        {
            "name": "GetFrameRate",
            "desc": "Gets the frames per a second",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 149,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        },
        {
            "name": "GetPlayTime",
            "desc": "Gets the play time for the animated sheet",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 157,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        },
        {
            "name": "GetFrameCount",
            "desc": "Retrieves the frames for the sprite sheet.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "frames"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 165,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "FlipbookData",
            "desc": "",
            "fields": [
                {
                    "name": "image",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "frameCount",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "rows",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "columns",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "imageRectSize",
                    "lua_type": "Vector2",
                    "desc": ""
                },
                {
                    "name": "frameRate",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "restFrame",
                    "lua_type": "number | nil",
                    "desc": "Optional reset frame"
                }
            ],
            "source": {
                "line": 22,
                "path": "src/flipbook/src/Client/Flipbook.lua"
            }
        }
    ],
    "name": "Flipbook",
    "desc": "A spritesheet that is animated. See [FlipbookPlayer] for playback.",
    "source": {
        "line": 5,
        "path": "src/flipbook/src/Client/Flipbook.lua"
    }
}