Skip to main content

ProcessQueue

Enables processing of a queue of items with an optional delay between each item.

Functions​

new​

</>
ProcessQueue.new(
callback: (any) → any,--

The function to call for each item in the queue.

delay: number?--

Optional delay in seconds between processing each item.

) → ProcessQueue

Creates a new ProcessQueue.

IsProcessing​

</>
ProcessQueue:IsProcessing() → boolean

Checks if the queue is currently being processed.

Add​

</>
ProcessQueue:Add(
item: any--

The item to add to the queue.

) → ()

Adds an item to the queue and begins processing if not already in progress.

Clear​

</>
ProcessQueue:Clear() → ()

Clears all current items in the queue.

Destroy​

</>
ProcessQueue:Destroy() → ()

Clears the queue and references.

Show raw api
{
    "functions": [
        {
            "name": "IsProcessing",
            "desc": "Checks if the queue is currently being processed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 55,
                "path": "src/shared/core/lib/ProcessQueue.luau"
            }
        },
        {
            "name": "Add",
            "desc": "Adds an item to the queue and begins processing if not already in progress.",
            "params": [
                {
                    "name": "item",
                    "desc": "The item to add to the queue.",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 64,
                "path": "src/shared/core/lib/ProcessQueue.luau"
            }
        },
        {
            "name": "Clear",
            "desc": "Clears all current items in the queue.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/shared/core/lib/ProcessQueue.luau"
            }
        },
        {
            "name": "Destroy",
            "desc": "Clears the queue and references.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/shared/core/lib/ProcessQueue.luau"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new ProcessQueue.",
            "params": [
                {
                    "name": "callback",
                    "desc": "The function to call for each item in the queue.",
                    "lua_type": "(any) -> any"
                },
                {
                    "name": "delay",
                    "desc": "Optional delay in seconds between processing each item.",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ProcessQueue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 92,
                "path": "src/shared/core/lib/ProcessQueue.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ProcessQueue",
    "desc": "Enables processing of a queue of items with an optional delay between each\nitem.",
    "source": {
        "line": 15,
        "path": "src/shared/core/lib/ProcessQueue.luau"
    }
}