BIS fnc priorityQueue Init: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(created page)
 
mNo edit summary
Line 13: Line 13:


Description:
Description:
Checks if the Queue is empty
Initialize the Priority Queue data structure.
The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.


Parameters:
Parameters:
_handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)
_maxSize:INT - OPTIONAL, sets the Queue MAX SIZE (otherwise it is set to the constant defined in the .inc file)


Returns:
Returns:
_empty:BOOL - true if the Queue is empty
_handle: Handle to the Queue (essential for manipulation with the Queue)


Syntax:
Syntax:
_empty:BOOL = [_handle] call BIS_fnc_PriorityQueue_IsEmpty;
_handle:INT = [_maxSize] call BIS_fnc_PriorityQueue_Init;


Example:
Example:
_isTheQueueEmpty = [_priorityQueue_1] call BIS_fnc_PriorityQueue_IsEmpty;
_priorityQueue_1 = [10] call BIS_fnc_PriorityQueue_Init;
*</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
*</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_priorityQueue_IsEmpty]]|Syntax=
|[] call [[BIS_fnc_priorityQueue_Init]]|Syntax=


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
Line 39: Line 40:
}}
}}


[[Category:Function Group: Arrays|{{uc:priorityQueue_IsEmpty}}]]
[[Category:Function Group: Arrays|{{uc:priorityQueue_Init}}]]
[[Category:Functions|{{uc:priorityQueue_IsEmpty}}]]
[[Category:Functions|{{uc:priorityQueue_Init}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:priorityQueue_IsEmpty}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:priorityQueue_Init}}]]

Revision as of 02:14, 24 December 2018

Hover & click on the images for description

Description

Description:
/*
	Author: Zozo

	Description:
	Initialize the Priority Queue data structure.
	The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.

	Parameters:
	_maxSize:INT - OPTIONAL, sets the Queue MAX SIZE (otherwise it is set to the constant defined in the .inc file)

	Returns:
	_handle: Handle to the Queue (essential for manipulation with the Queue)

	Syntax:
	_handle:INT = [_maxSize] call BIS_fnc_PriorityQueue_Init;

	Example:
	_priorityQueue_1 = [10] call BIS_fnc_PriorityQueue_Init;
*
Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[] call BIS_fnc_priorityQueue_Init
Parameters:
parameter: Datatype - (Optional, default defValue) description
Return Value:
Datatype - description

Examples

Example 1:

Additional Information

See also:
See also needed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note