Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:1.22

Description

Description: Removes the specified number of elements from the beginning (left side) of an array and returns them. The original array is modified by reference. Similar to fn vbs arrayShift, however, more than one item can be removed.

Syntax

Syntax: [array, removenum] call fn_vbs_arrayShiftStack
Parameters:
  • array: Array - Array to modify
  • removenum: Number - How many elements to remove from the left
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_arrayShiftStack
Result: _array now holds [3,4]; _newArray holds [1,2]

Additional Information

See also: fn vbs arrayShift
Multiplayer: 
Problems: 

Notes