Array - Revision history

Lou Montana: Fix

2024-05-26T18:49:10Z

Fix

← Older revision		Revision as of 20:49, 26 May 2024
Line 277:		Line 277:
	_arrayA deleteAt _index;		_arrayA deleteAt _index;
	};		};
	} ~~forEachReversed~~ _arrayB;		} forEach _arrayB;

	_arrayA; // is now [1, 3, 5, 4]		_arrayA; // is now [1, 3, 5, 4]

Lou Montana: Some wiki formatting

2024-05-26T17:15:04Z

Some wiki formatting

← Older revision		Revision as of 19:15, 26 May 2024
Line 6:		Line 6:


	== Working ~~with arrays~~ ==		== Working With Arrays ==

	=== Array ~~properties~~ ===		=== Array Properties ===

	An array variable is a '''reference''' to the array (see {{Link\|https://en.wikipedia.org/wiki/Reference_(computer_science)\|Wikipedia reference page}});		An array variable is a '''reference''' to the array (see {{Link\|https://en.wikipedia.org/wiki/Reference_(computer_science)\|Wikipedia reference page}});
Line 28:		Line 28:
	</sqf>		</sqf>

	=== ~~Create an array~~ ===		=== Array Creation ===

	<sqf>		<sqf>
Line 59:		Line 59:
	</sqf>		</sqf>

	=== Setting an ~~element~~ ===		=== Setting an Element ===

	<sqf>		<sqf>
Line 118:		Line 118:
	Sub-arrays are also deep-copied; {{hl\|_myNewArray}} will not point at the same sub-array instances.		Sub-arrays are also deep-copied; {{hl\|_myNewArray}} will not point at the same sub-array instances.

	=== Adding (~~appending~~) ~~elements~~ ===		=== Adding (Appending) Elements ===

	In {{arma3}} use [[append]] and [[pushBack]] commands:		In {{arma3}} use [[append]] and [[pushBack]] commands:
Line 135:		Line 135:
	</sqf>		</sqf>

	=== Removing (~~deleting~~) ~~elements~~ ===		=== Removing (Deleting) Elements ===

	In {{arma3}} the [[deleteAt]] and [[deleteRange]] commands are available:		In {{arma3}} the [[deleteAt]] and [[deleteRange]] commands are available:
Line 177:		Line 177:
	</sqf>		</sqf>

	=== Going ~~through~~ the ~~array~~ ===		=== Going Through the Array ===

	The simplest way to iterate through an array is the [[forEach]] command:		The simplest way to iterate through an array is the [[forEach]] command:
Line 194:		Line 194:


	== Advanced ~~usage~~ ==		== Advanced Usage ==

	=== apply ===		=== apply ===
Line 263:		Line 263:

	=== Selective Removal ===		=== Selective Removal ===
	Selectively filter out single elements from _arrayA based on _arrayB.
	<br>		Selectively filter out single elements from {{hl\|_arrayA}} based on {{hl\|_arrayB}}.<br>
	~~Useful~~ in ~~removing elements~~ where duplicates ~~may exist~~.		This is useful in the case where ''some'' duplicates must be removed.

	<sqf>		<sqf>
	private _arrayA = [1,2,3,2,4,5,4];		private _arrayA = [1, 2, 3, 2, 4, 5, 4];
	private _arrayB = [2,2,4];		private _arrayB = [2, 2, 4];

	{		{
	~~private _element = _x;~~		private _index = _arrayA find _x;
	private _index = _arrayA find ~~_element~~;		if (_index != -1) then
			{
	if (_index != -1) then {
	_arrayA deleteAt _index;		_arrayA deleteAt _index;
	};		};
	} forEachReversed _arrayB		} forEachReversed _arrayB;

	_arrayA		_arrayA; // is now [1, 3, 5, 4]
	// ~~Returns~~ [1,3,5,4]
	</sqf>		</sqf>

	=== Sorting ~~an array~~ ===		=== Sorting ===

	==== sort ====		==== sort ====
Line 310:		Line 309:
	The function [[BIS_fnc_sortBy]] has been created for more complex sorting. Its algorithm input must return a number:		The function [[BIS_fnc_sortBy]] has been created for more complex sorting. Its algorithm input must return a number:
	<sqf>private _closestHelicopters = [[_heli1, _heli2, _heli3], [], { player distance _x }, "ASCEND"] call BIS_fnc_sortBy;</sqf>		<sqf>private _closestHelicopters = [[_heli1, _heli2, _heli3], [], { player distance _x }, "ASCEND"] call BIS_fnc_sortBy;</sqf>


	== Common Errors ==		== Common Errors ==

Hypoxic125: Added selective removal from _arrayA based on _arrayB

2024-05-26T17:06:35Z

Added selective removal from _arrayA based on _arrayB

@@ Line 260: / Line 260: @@
 private _myArray = [1, 2, nil, 3, 4];
 private _result = _myArray arrayIntersect _myArray; // _result is [1, 2, 3, 4]
 </sqf>
@@ Line 289: / Line 310: @@
 The function [[BIS_fnc_sortBy]] has been created for more complex sorting. Its algorithm input must return a number:
 <sqf>private _closestHelicopters = [[_heli1, _heli2, _heli3], [], { player distance _x }, "ASCEND"] call BIS_fnc_sortBy;</sqf>
 == Common Errors ==

Lou Montana: Some wiki formatting

2023-09-10T13:35:07Z

Some wiki formatting

← Older revision		Revision as of 15:35, 10 September 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	An '''Array''' is a list of items of varying [[:Category:Data Types\|variable types]]. Different types can coexist within the same array.		An '''Array''' is a list of items of varying [[:Category:Data Types\|variable types]] (including other arrays). Different types can coexist within the same array.
	~~An Array can either be one-dimensional or multi-dimensional~~.

	See also: [[:Category:Arrays\|Arrays]]		See also: [[:Category:Arrays\|Arrays]]
	{{Feature \| ~~Warning~~ \| Since {{arma3}} v1.56 arrays are limited to maximum of '''9,999,999''' (sometimes 10,000,000) elements}}		{{Feature\|warning\|Since {{arma3}} v1.56, arrays are limited to maximum of '''9,999,999''' (sometimes 10,000,000) elements.}}


Line 294:		Line 293:
	== Common Errors ==		== Common Errors ==

	=== Index ~~rounding~~ ===		=== Index Rounding ===

	In Real Virtuality scripts, indices are rounded to the nearest whole number.		In {{Link\|Real Virtuality}} scripts, indices are rounded to the nearest whole number.
	A boundary case (X.5, where X is any whole number) rounds to the nearest '''even''' whole number.		A boundary case (X.5, where X is any whole number) rounds to the nearest '''even''' whole number.

Line 312:		Line 311:
	*  3.5 rounds '''up''' to 4		*  3.5 rounds '''up''' to 4
	etc.		etc.
			{{Feature\|informative\|This behaviour is different from {{Link\|random}}'s behaviour.}}

	=== Index out of Range ===		=== Index out of Range ===
Line 327:		Line 327:
	Use the [[param]] command in order to avoid out of range error:		Use the [[param]] command in order to avoid out of range error:
	<sqf>		<sqf>
	private _myArray = [0,1,2];		private _myArray = [0, 1, 2];
	_myArray select 5; // error: out of range		_myArray select 5; // error: out of range
	_myArray param [5]; // returns nil		_myArray param [5]; // returns nil
	_myArray param [5, "abc"]; // returns default value "abc" on invalid index		_myArray param [5, "abc"]; // returns default value "abc" on invalid index
	</sqf>		</sqf>
			{{Feature\|informative\|See also [[params]] to define multiple items at once.}}

	==== set ====		==== set ====
	If the index given to the [[set]] command is out of bounds:		If the index given to the [[set]] command is out of bounds:
	* If the index rounded to a negative number, then an [[Error Zero Divisor]] message will be displayed in game.		* if the index rounded to a negative number, then an [[Error Zero Divisor]] message will be displayed in game.
	* If the index rounded to a positive number, then the array will [[resize]] to incorporate the index ''as its last value''. Each element between the last valid element, and the new [[set]] element, will be the [[Nothing\|null type]]		* if the index rounded to a positive number, then the array will [[resize]] to incorporate the index ''as its last value''. Each element between the last valid element, and the new [[set]] element, will be the [[Nothing\|null type]]

	=== ~~Bad Syntax~~ ===		=== Zero Divisor ===

			See above - a used array index may be negative.

			=== Unexpected "," ===

			This error originates from a bad syntax:
	<sqf>		<sqf>
	~~// Error: Unexpected ","~~
	private _myErroneousArray = ["Weapon1", "Weapon2", "Weapon3",]; // The last element in an array must not end by ","		private _myErroneousArray = ["Weapon1", "Weapon2", "Weapon3",]; // The last element in an array must not end by ","
	// mostly happens in vertical arrays
			// this mostly happens in vertical arrays
	private _myErroneousArray = [		private _myErroneousArray = [
	"element1",		"element1",
Line 351:		Line 357:
	</sqf>		</sqf>

	=== ~~Read-Only Array~~ ===		=== Reserved variable in expression ===

	~~If an array is~~ read-only (such as {{Link\|select}} arrays that are returned from an addon, or eventually a trigger's {{Link\|Magic Variables#thisList\|thisList}}~~, it will return an ''Error: Reserved variable in expression'' message upon trying to modify it~~.		This issue arises when trying to modify a read-only array (such as {{Link\|select}} arrays that are returned from an addon, or eventually a trigger's {{Link\|Magic Variables#thisList\|thisList}}).

	To combat this, ''copy'' an array with the + command before modifying:		To combat this, ''copy'' said array with the {{Link\|+\|plus (+)}} command before modifying:
	<sqf>		<sqf>
	private _readOnlyArray = thisList; // assuming the code is called from within a trigger		private _readOnlyArray = thisList; // assuming the code is called from within a trigger

Lou Montana: Fix examples to avoid command argument/array item confusion

2023-09-10T13:23:17Z

Fix examples to avoid command argument/array item confusion

Show changes

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

2023-04-28T14:07:39Z

Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

← Older revision		Revision as of 16:07, 28 April 2023
Line 198:		Line 198:
	=== apply ===		=== apply ===

	Similar to the [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map "map" function in Javascript],		Similar to the {{Link\|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map\|"map" function in Javascript}},
	[[apply]] allows to apply code to every elements in an array and return a copy:		[[apply]] allows to apply code to every elements in an array and return a copy:
	<sqf>		<sqf>

Lou Montana: Text replacement - "\{\{ Wikipedia \| ([-()a-zA-Z0-9_#':%\/\\]+) \| ([-()a-zA-Z0-9_#':%\/\\ ]+) \}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"

2023-02-23T23:48:38Z

Text replacement - "\{\{ *Wikipedia *\| *([-()a-zA-Z0-9_#':%\/\\]+) *\| *([-()a-zA-Z0-9_#':%\/\\ ]+) *\}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"

← Older revision		Revision as of 01:48, 24 February 2023
Line 11:		Line 11:
	=== Array properties ===		=== Array properties ===

	An array variable is a '''reference''' to the array (see {{~~Wikipedia~~\|Reference_(computer_science)\|Wikipedia reference page}});		An array variable is a '''reference''' to the array (see {{Link\|https://en.wikipedia.org/wiki/Reference_(computer_science)\|Wikipedia reference page}});
	this means that if the array is edited, all the scripts/functions using a reference to this array will see the edition.		this means that if the array is edited, all the scripts/functions using a reference to this array will see the edition.

Fraali: /* Common errors */

2022-08-07T21:43:38Z

Common errors

← Older revision		Revision as of 23:43, 7 August 2022
Line 344:		Line 344:
	</sqf>		</sqf>

			=== Un-modifiable ===

			If the array is considered "Un-modifiable" such as select arrays that are returned from an addon, and some undiscovered returns, it will return a ''Error: Reserved variable in expression'' upon trying to modify it.

			To combat this, ''copy'' an array with the + prefix before modifying.

			<sqf>
			// Error: Reserved variable in expression
			_arr = [1,2,3];
			_arr set [1,"test"]; // May error if previous array was un-modifiable

			// No Error
			_arr = [4,5,6];
			_arr = +_arr; // Copy the array instead of using a reference
			_arr set [1,"test"]; // Will not error even if previous array is not modifiable
			</sqf>

	== See Also ==		== See Also ==

Lou Montana: Some wiki formatting

2022-07-01T14:05:26Z

Some wiki formatting

← Older revision		Revision as of 16:05, 1 July 2022
Line 117:		Line 117:
	</sqf>		</sqf>

	Sub-arrays are also deep-copied {{ic\|_myNewArray}} will not point at the same sub-array instances.		Sub-arrays are also deep-copied; {{hl\|_myNewArray}} will not point at the same sub-array instances.

	=== Adding (appending) elements ===		=== Adding (appending) elements ===

Lou Montana: Some wiki formatting

2022-05-02T15:05:53Z

Some wiki formatting

Show changes

Array - Revision history

Lou Montana: Fix

Lou Montana: Some wiki formatting

Hypoxic125: Added selective removal from _arrayA based on _arrayB

Lou Montana: Some wiki formatting

Lou Montana: Fix examples to avoid command argument/array item confusion

Lou Montana: Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

Lou Montana: Text replacement - "\{\{ *Wikipedia *\| *([-()a-zA-Z0-9_#':%\/\\]+) *\| *([-()a-zA-Z0-9_#':%\/\\ ]+) *\}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"

Fraali: /* Common errors */

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

Lou Montana: Text replacement - "\{\{ Wikipedia \| ([-()a-zA-Z0-9_#':%\/\\]+) \| ([-()a-zA-Z0-9_#':%\/\\ ]+) \}\}" to "{{Link|https://en.wikipedia.org/wiki/$1|$2}}"