Skip to main content

PromptQueue

Queue system for prompts and other UI

Functions​

new​

</>
PromptQueue.new() → PromptQueue

Constructs a new prompt queue

Queue​

</>
PromptQueue.Queue(
self: PromptQueue,
transitionModel: TransitionModel
) → Promise.Promise<()>

Queues a transition model to be shown

HasItems​

</>
PromptQueue.HasItems(self: PromptQueue) → boolean

Returns if the queue has any items

Clear​

</>
PromptQueue.Clear(
self: PromptQueue,
doNotAnimate: boolean?
) → ()

Clears the current queue

HideCurrent​

</>
PromptQueue.HideCurrent(
self: PromptQueue,
doNotAnimate: boolean?
) → Promise

Promises the current prompt to be hidden

IsShowing​

</>
PromptQueue.IsShowing(self: PromptQueue) → boolean

Returns whether or not the PromptQueue is currently showing its contents.

ObserveIsShowing​

</>
PromptQueue.ObserveIsShowing(self: PromptQueue) → Observable<boolean>

Observes the current state of the PromptQueue, emitting true when showing and false if not.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new prompt queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PromptQueue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "Queue",
            "desc": "Queues a transition model to be shown",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                },
                {
                    "name": "transitionModel",
                    "desc": "",
                    "lua_type": "TransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "HasItems",
            "desc": "Returns if the queue has any items",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 158,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "Clear",
            "desc": "Clears the current queue",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 167,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "HideCurrent",
            "desc": "Promises the current prompt to be hidden",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 177,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "IsShowing",
            "desc": "Returns whether or not the PromptQueue is currently showing its contents.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 194,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        },
        {
            "name": "ObserveIsShowing",
            "desc": "Observes the current state of the PromptQueue, emitting true when showing and false if not.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PromptQueue"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 203,
                "path": "src/promptqueue/src/Shared/PromptQueue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PromptQueue",
    "desc": "Queue system for prompts and other UI",
    "source": {
        "line": 7,
        "path": "src/promptqueue/src/Shared/PromptQueue.lua"
    }
}