Skip to main content

FlipbookPlayer

Plays an Flipbook on a given imagelabel.

Functions​

new​

</>
FlipbookPlayer.new(imageLabel: ImageLabel) → FlipbookPlayer

Constructs a new FlipbookPlayer

SetFlipbook​

</>
FlipbookPlayer:SetFlipbook(flipbook: Flipbook) → ()

Sets the current sheet and starts play if needed

GetFlipbook​

</>
FlipbookPlayer:GetFlipbook() → Flipbook?

Gets the current flipbook

PromisePlayOnce​

</>
FlipbookPlayer:PromisePlayOnce() → Promise

Plays the flipbook once

PromisePlayRepeat​

</>
FlipbookPlayer:PromisePlayRepeat(times: number) → Promise

Plays the flipbook the number of times specified and then stops.

SetIsBoomarang​

</>
FlipbookPlayer:SetIsBoomarang(isBoomarang: boolean) → ()

Sets whether play should boomarang

Play​

</>
FlipbookPlayer:Play() → ()

Plays the flipbook indefinitely

Stop​

</>
FlipbookPlayer:Stop() → ()

Stops the flipbook

IsPlaying​

</>
FlipbookPlayer:IsPlaying() → boolean

Returns true if the flipbook is playing

ObserveIsPlaying​

</>
FlipbookPlayer:ObserveIsPlaying() → Observable<boolean>

Observes if the flipbook is playing

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new FlipbookPlayer",
            "params": [
                {
                    "name": "imageLabel",
                    "desc": "",
                    "lua_type": "ImageLabel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FlipbookPlayer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "SetFlipbook",
            "desc": "Sets the current sheet and starts play if needed",
            "params": [
                {
                    "name": "flipbook",
                    "desc": "",
                    "lua_type": "Flipbook"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 84,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "GetFlipbook",
            "desc": "Gets the current flipbook",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Flipbook?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 94,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "PromisePlayOnce",
            "desc": "Plays the flipbook once",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 103,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "PromisePlayRepeat",
            "desc": "Plays the flipbook the number of times specified and then stops.",
            "params": [
                {
                    "name": "times",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 113,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "SetIsBoomarang",
            "desc": "Sets whether play should boomarang",
            "params": [
                {
                    "name": "isBoomarang",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 131,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "Play",
            "desc": "Plays the flipbook indefinitely",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 140,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "Stop",
            "desc": "Stops the flipbook",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "IsPlaying",
            "desc": "Returns true if the flipbook is playing",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 158,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        },
        {
            "name": "ObserveIsPlaying",
            "desc": "Observes if the flipbook is playing",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 166,
                "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FlipbookPlayer",
    "desc": "Plays an [Flipbook] on a given imagelabel.",
    "source": {
        "line": 5,
        "path": "src/flipbook/src/Client/Player/FlipbookPlayer.lua"
    }
}