resize: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(79 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#R|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''''array'' resize ''count'''''</h2>
|game1= ofp
|version1= 1.75


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''array:''' [[Array]]
|game4= arma2
|version4= 1.00


'''count:''' [[Number]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= Arrays


Change array size.
|descr= Changes the size of the given array. The command does not return new array, it resizes the source array to the desired number of elements.
If the new size is bigger than the current size, the new places are filled with [[nil]]. The {{Link|#Syntax 2|alternative syntax}} allows to fill resized positions with a given value. [[Array]] and [[HashMap]] values are copied.


Can be used to add or remove elements from the array.
|s1= array [[resize]] count


|p1= array: [[Array]] of [[Anything]]


'''Example:'''
|p2= count: [[Number]] - the new array size


arrayOne '''resize''' 2
|r1= [[Nothing]]
 
|s2= array [[resize]] [count, fill]
|s2since= arma3 2.10
 
|p21= array: [[Array]] of [[Anything]]
 
|p22= count: [[Number]] - the new array size
|p23= fill: [[Anything]] - value to fill added positions
 
|r2= [[Nothing]]
 
 
|x1= <sqf>
_arrayNum = [0,1,2,3,4];
_arrayNum resize 2; // _arrayNum is now [0, 1]
_arrayNum resize 5; // _arrayNum is now [0, 1, nil, nil, nil]
</sqf>
 
|x2= <sqf>
private _array = [0, 1, 2];
_array resize [5, -1]; // _array is now [0, 1, 2, -1, -1]
 
private _array = [0, 1, 2];
_array resize [1, -1]; // _array is now [0]
 
private _array = [0, 1, 2];
_array resize [4, "something"]; // _array is now [0, 1, 2, "something"]
</sqf>
 
|seealso= [[set]] [[reverse]] [[deleteAt]] [[deleteRange]]
}}
 
{{Note
|user= DreadedEntity
|timestamp= 20141113062600
|text= Use this number to resize the array to the number of elements desired, not the desired index of the final element.<br>
[[resize]] cannot be used to create a new array.
}}

Latest revision as of 14:16, 15 June 2024

Hover & click on the images for description

Description

Description:
Changes the size of the given array. The command does not return new array, it resizes the source array to the desired number of elements. If the new size is bigger than the current size, the new places are filled with nil. The alternative syntax allows to fill resized positions with a given value. Array and HashMap values are copied.
Groups:
Arrays

Syntax

Syntax:
array resize count
Parameters:
array: Array of Anything
count: Number - the new array size
Return Value:
Nothing

Alternative Syntax

Syntax:
array resize [count, fill]
Parameters:
array: Array of Anything
count: Number - the new array size
fill: Anything - value to fill added positions
Return Value:
Nothing

Examples

Example 1:
_arrayNum = [0,1,2,3,4]; _arrayNum resize 2; // _arrayNum is now [0, 1] _arrayNum resize 5; // _arrayNum is now [0, 1, nil, nil, nil]
Example 2:
private _array = [0, 1, 2]; _array resize [5, -1]; // _array is now [0, 1, 2, -1, -1] private _array = [0, 1, 2]; _array resize [1, -1]; // _array is now [0] private _array = [0, 1, 2]; _array resize [4, "something"]; // _array is now [0, 1, 2, "something"]

Additional Information

See also:
set reverse deleteAt deleteRange

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
DreadedEntity - c
Posted on Nov 13, 2014 - 06:26 (UTC)
Use this number to resize the array to the number of elements desired, not the desired index of the final element.
resize cannot be used to create a new array.