Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.




Introduced in

Version:1.22

Description

Description:Removes the specified number of elements from the end (
right
rightmost side) of an array, and returns them. The original array is modified by reference.
Similar
This function is similar to fn vbs arrayPop
, however
. However, more than one item can be removed.

Syntax

Syntax:[array, removenum] call fn_vbs_arrayPopStack
Parameters:
  • array: Array - Array to modify.
  • removenum: Number - How many elements to remove from the right.
Return Value:Array - Elements removed from the array.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
_array = [1,2,3,4]; _newArray = [_array, 2] call fn_vbs_arrayPopStack
Result: _array now holds [1,2]; _newArray holds [3,4]

Additional Information

See also: fn vbs arrayPop
Multiplayer: 
Problems: 

Notes