Arma 3 Scripting

Function in Priority Queue

BIS_fnc_priorityQueue_PushItem

Also available as Markdown and JSON, or read the original wiki page.

Description

/*

Inserts item with a defined priority to the Queue The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes. Complexity: O(n)

Syntax

[] call BIS_fnc_priorityQueue_PushItem

Parameters:

Returns: _success:BOOL - true if item was inserted into the Queue, otherwise false

Examples

Example 1

_s = [_priorityQueue_1, "myItem", 5] call BIS_fnc_PriorityQueue_InsertItem;

Function header

The comment at the top of the function's file in the game; this page's description, params, returns, examples come from it.

/*
/*
    Author: Zozo

    Description:
    Inserts item with a defined priority to the Queue
    The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.
    Complexity: O(n)

    Parameters:
    _handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)
    _item:ANY - item, can be whatever
    _priority:INT - the priority the item is inserted with

    Returns:
    _success:BOOL - true if item was inserted into the Queue, otherwise false

    Syntax:
    _success:BOOL = [_handle, _item, _priority] call BIS_fnc_PriorityQueue_InsertItem;

    Example:
    _s = [_priorityQueue_1, "myItem", 5] call BIS_fnc_PriorityQueue_InsertItem;
*/