Simple Array Class for TorqueScript

Download Code File

Since Torque Script does not implement arrays in a standard fasion, I found myself unable to do certain things like pass them as function parameters. To get around this limitation I created this small light weight class that I could use in my script files.

To start using the file, simply copy it to the \RTSStarterKit\engine\console directory and include it in the Project File (Visual Studio Project file / Makefile). Rebuild the executable and you should be able to start using the Array class in TorqueScript.

Here is an example of using the Array class. In this example I am loping through all of the units that I currently have selected and I am grouping them together by their unit id. Each array holds a different piece of information. the iUnitId stores the unique unit id, the iUnitCount stores the number of each unit in the group and the iUnitHealth stores the health of all the units in the group.

%iUnitId = new Array();
	%iUnitCount = new Array();
	%iUnitHealth = new Array();	
        
        for (%i = 0; %i < %this.getSelectionSize(); %i++)
	{
		// Get the ID of the unit
		%idx = %this.getTypeID(%i);
		
		// Check to see if the unit is already in the array.
		%iCurrentIndex = %iUnitId.findValue( %idx );
		if (%iCurrentIndex < 0)		
		{
			// The unit id was not found in the array
			%iCurrentIndex = 0;
			
			// Lets add the unit id to the array
			%iUnitId.add(%idx);
			
			// lets let's update the count.
			%iUnitCount.add(1);
			
			// Update the health
			%iUnitHealth.add(%this.getHealthPercent(%i));
			
		}
		else
		{
			// The unit does already exist int he array, i'll update it.
			
			// Get the current unit count.
			%iTmpCount = %iUnitCount.getValue( %iCurrentIndex );
			
			// Update it
			%iUnitCount.setValue(%iCurrentIndex, (%iTmpCount + 1));
			
			// Now update the health counter
			%iTmpHealth = %iUnitHealth.getValue( %iCurrentIndex );
			
			%iUnitHealth.setValue(%iCurrentIndex, %iTmpHealth + %this.getHealthPercent(%i));
		}		
	}