Skip to main content

FunctionQueue

A queue that executes functions in order of arrival.

Inherits from Queue.

Functions​

new​

</>
FunctionQueue.new() → FnQueue

Creates a new FnQueue

Destroy​

</>
FunctionQueue:Destroy() → ()

Pauses and marks queue to be unusable

Process​

</>
FunctionQueue:Process(
fn: (() → ())?--

The function to append to the queue

) → ()

Begins executing the functions in the queue. If a function is passed in, it will be appended to the queue.

IsProcessing​

</>
FunctionQueue:IsProcessing() → boolean

Checks to see if the queue is currently processing

GetCurrentProcessingFn​

</>
FunctionQueue:GetCurrentProcessingFn() → (() → ())?

Returns the function that is currently being processed

Stop​

</>
FunctionQueue:Stop() → ()

Stops the current processing thread if one is running

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new FnQueue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FnQueue\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Pauses and marks queue to be unusable",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 44,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        },
        {
            "name": "Process",
            "desc": "Begins executing the functions in the queue. If a function is passed in, it will be appended to the queue.",
            "params": [
                {
                    "name": "fn",
                    "desc": "The function to append to the queue",
                    "lua_type": "(() -> ())?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        },
        {
            "name": "IsProcessing",
            "desc": "Checks to see if the queue is currently processing",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 78,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        },
        {
            "name": "GetCurrentProcessingFn",
            "desc": "Returns the function that is currently being processed",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(() -> ())?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 87,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        },
        {
            "name": "Stop",
            "desc": "Stops the current processing thread if one is running",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 95,
                "path": "src/functionqueue/src/FunctionQueue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FunctionQueue",
    "desc": "A queue that executes functions in order of arrival.\n\nInherits from Queue.",
    "source": {
        "line": 11,
        "path": "src/functionqueue/src/FunctionQueue.lua"
    }
}