cleararray()

Warning

This page may contain outdated information, incompatible with the current version of Hercules and its coding standards.

Syntax

cleararray(<array variable>, <value>, <amount of values to set>);

Description

This command sets a range of elements in an array to given value. If you specify an array variable without index, then index 0 is assumed, otherwise the value setting will start from given index.

Examples

setarray(@array[0], 100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100);
cleararray(@array[0], 100, 11);

Info

Both lines result in the same array, but using cleararray saves typing.

cleararray(@array[0], 0, 127);  // number array
cleararray(@strarray$[0], "", 127); // string array

Info

Deletes entire array.

setarray(@array[0], 1, 2, 3, 4, 5, 6);
cleararray(@array[2], 0, 2);

Info

Results in array { 1, 2, 0, 0, 5, 6 }.