Skip to main content

Queue

This item is only intended to be used by the module's authors. Private

Private queue class for loading system.

Functions​

new​

</>
Queue.new() → Queue<T>

Constructs a new queue

new​

</>
Queue.new() → Queue<T>

Constructs a new queue

PushLeft​

</>
Queue:PushLeft(value: T) → ()

Pushes an entry to the left of the queue

PushRight​

</>
Queue:PushRight(value: T) → ()

Pushes an entry to the right of the queue

PopLeft​

</>
Queue:PopLeft() → T

Pops an entry from the left of the queue

PopRight​

</>
Queue:PopRight() → T

Pops an entry from the right of the queue

IsEmpty​

</>
Queue:IsEmpty() → boolean

Returns true if the queue is empty

PushLeft​

</>
Queue:PushLeft(value: T) → ()

Pushes an entry to the left of the queue

PushRight​

</>
Queue:PushRight(value: T) → ()

Pushes an entry to the right of the queue

PopLeft​

</>
Queue:PopLeft() → T

Pops an entry from the left of the queue

PopRight​

</>
Queue:PopRight() → T

Pops an entry from the right of the queue

IsEmpty​

</>
Queue:IsEmpty() → boolean

Returns true if the queue is empty

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Queue<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "PushLeft",
            "desc": "Pushes an entry to the left of the queue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 38,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "PushRight",
            "desc": "Pushes an entry to the right of the queue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "PopLeft",
            "desc": "Pops an entry from the left of the queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 56,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "PopRight",
            "desc": "Pops an entry from the right of the queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "IsEmpty",
            "desc": "Returns true if the queue is empty",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 88,
                "path": "src/queue/src/Shared/Queue.lua"
            }
        },
        {
            "name": "new",
            "desc": "Constructs a new queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Queue<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "src/loader/src/Queue.lua"
            }
        },
        {
            "name": "PushLeft",
            "desc": "Pushes an entry to the left of the queue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 27,
                "path": "src/loader/src/Queue.lua"
            }
        },
        {
            "name": "PushRight",
            "desc": "Pushes an entry to the right of the queue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 36,
                "path": "src/loader/src/Queue.lua"
            }
        },
        {
            "name": "PopLeft",
            "desc": "Pops an entry from the left of the queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/loader/src/Queue.lua"
            }
        },
        {
            "name": "PopRight",
            "desc": "Pops an entry from the right of the queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 61,
                "path": "src/loader/src/Queue.lua"
            }
        },
        {
            "name": "IsEmpty",
            "desc": "Returns true if the queue is empty",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 77,
                "path": "src/loader/src/Queue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Queue",
    "desc": "Private queue class for loading system.",
    "private": true,
    "source": {
        "line": 7,
        "path": "src/loader/src/Queue.lua"
    }
}