array.shift()

pops the first element from an array and shift the rest of the values to the left. In case the array is empty an exception is thrown, unless the second argument "defaultValue" is provided, in that case that value is returned.

Introduced: 5.3.8.104

array.shift( defaultValue=any )

Returns: any

Argument Description
defaultValue
any, optional

this value is returned in case the array is empty

Examples

numbers = [ 1, 2, 3, 4 ];
numbers .Shift( );
Dump( numbers ); // Outputs 1
moreNumbers = [ 5, 6, 7, 8 ];
moreNumbers .Shift( );
Dump( numbers ); // Outputs 5
numbers     = [ "one", "two", "three", "four" ];
numbers.Shift( );
Dump( numbers ); // Outputs one

See also