groupSizes[]

Syntax

// size of a group
var size = groupSizes[id]; // will throw error if element missing
 
// next available group ID
var numGroups = groupSizes.length;

Properties

Property	Type	Mandatory	Description	Game version
id	Number		Specify the group ID that you want to query the size of (see "Notes" below for important information).	3.2
length	Number		Returns the next available group ID, which can be used to create a completely new group.	3.2

Return values

Notes

The groupSizes[] global is a "sparse" array – there might be gaps in the numbering of it's elements, which means that groupSizes.length is not representative of the number of groups you've actually used.

All elements up to groupSizes.length - 1 will be defined, but only groups that have been used will have a numeric value (the others will have a value of undefined).

It's recommended to use the forEach() method when iterating the array (see example below).

Note also that groups defined in labels.ini will have negative indices in the array (which I'm not sure if .forEach() will process?).

Example

The .forEach() method simplifies iteration of sparse arrays – it will skip any undefined elements...

groupSizes.forEach( function get(groupSize, groupID) {
	// any unused groups will be skipped, so this
	// groupID has been used, and groupSize will be ≥ 0
} );

When you need a new group, you can either use newGroup() or simply add stuff to a group that doesn't yet exist:

// add a structure to a new group
var newGroup = groupSizes.length;
 
groupSizes[newGroup]; // ReferenceError - no such element
 
groupAdd(newGroup, someStructure);
 
groupSizes[newGroup]; // 1
 
groupSizes.length; // == newGroup + 1

If you want to find the next free group that's already defined, you can do something like this (not recommended):

var
	i = 0,
	nextUnused = groupSizes.length;
 
while (i < nextUnused) {
	(typeof groupSizes[i] != "number") ? nextUnused = i : ++i;
}
 
// 'nextUnused' now contains the numeric ID of the next unused group
 
groupAdd(nextUnused, someObject); // create group by adding someObject to it