3D Game Programming All in One- P27

Torque Console Script Command Reference 687
FindFirstFile (pattern)
Parameters: pattern
String pattern.
Return: string
The file's name.
Description:
Finds the name of the first file in the Torque Script file name buffer matching the
given
pattern
. Supports "*" to match any number of any characters and "?" to
match any single character.
Usage:
%result = FindFirstFile("/common/*.cs");
FindNextFile (pattern)
Parameters: pattern
String pattern.
Return: string
The file's name.
Description:
Finds the name of the next file in the Torque Script filename buffer matching the
search by immediately previous call to
FindFirstFile
. Supports '*' to match any
number of any characters and '?' to match any single character.
Usage:
%result = FindNextFile("/common/*.cs");
FirstWord(text)
Parameters: text
String with space-delimited words.
Return: string

The resultant string.
Description:
Gets the first word-string within
text
.
Usage:
%tgt = FirstWord(%text);
FlushTextureCache()
Parameters: none
Return: nothing
Description:
Deletes cached textures from memory.
Usage:
FlushTextureCache();
FreeMemoryDump()
Parameters: none
Return: nothing
Description:
Prints free memory statistics.
Usage:
FreeMemoryDump();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference688
GetBoxCenter(box)
Parameters: box
String containing two 3D tuples defining the box.
Return: string

Description:
Computes the center of a box.
Usage:
%c = GetBoxCenter("10,10,10,50,50,50");
GetBuildString()
Parameters: none
Return: string
Description:
Obtains the BUILD type (Release or Debug) of the current build.
Usage:
%bs = GetBuildString();
GetCompileTimeString()
Parameters: none
Return: string
Description:
Obtains the compile time and date of the current build.
Usage:
%ct = GetCompileTimeString();
GetControlObjectAltitude()
Parameters: none
Return: numeric
Description:
Obtains the altitude of the player object.
Usage:
%altitude = %player.GetControlObjectAltitude();
GetControlObjectSpeed()
Parameters: none
Return: numeric
Description:
Obtains the speed of the player object.

Usage:
%speed =
%player.GetControlObjectSpeed();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Torque Console Script Command Reference 689
GetDesktopResolution()
Parameters: none
Return: string
Description:
Reports the current desktop resolution.
Usage:
%res = GetDesktopResolution():
GetDisplayDeviceList()
Parameters: none
Return: string
Description:
Obtains the device name for each display device.
Usage:
%name = GetDisplayDeviceList();
GetField(text, index)
Parameters: text
String with field-delimited words.
index
Field-based offset into the text string.
Return: string
Contains the found field-string.
Description:
Gets the field-string at
index

within
text
. In the usage example that follows, if
%text
equaled "Of Mice and Men", then
%word
would be set to "and" when the
function returned.
Usage:
%field = GetField(%text, 0);
GetFieldCount (text)
Parameters: text
String with field-delimited words.
Return: numeric
Description:
Gets the number of field-strings within
text
.
Usage:
%count = GetFieldCount( %text );
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference690
GetFields(text, first [, last])
Parameters: text
String with space-delimited fields.
first
Field-based offset into the text string specifying the first field

to extract.
last
Field-based offset into the text string specifying the last field
to extract.
Return: string
Contains the found fields.
Description:
Gets one or more field-strings at
index
within
text
.If
count
is specified, gets
count
number of field-strings.
Usage:
%position = GetFields(%obj.getTransform(), 0, 2);
GetFileCount (pattern)
Parameters: pattern
String pattern.
Return: numeric
Description:
Gets the number of files in the Torque Script file name buffer that match
pattern
.
Usage:
%count = GetFileCount("/common/server/*.cs");
GetFileCRC(filename)
Parameters: filename

String containing full file name.
Return: numeric
The
Cyclic Redundancy Check
(CRC) value.
Description:
Gets the CRC value of the file specified by
filename
.
Usage:
%crc = GetFileCRC("/common/server/script.cs");
GetJoystickAxes( instance )
Parameters: instance
The joystick object.
Return: string
Description:
Obtains the current axes of the joystick pointed to by
instance
.
Usage:
%joyAxes = GetJoystickAxes( 3 );
GetMaxFrameAllocation()
Parameters: none
Return: numeric
Description:
Gets the Max Frame Allocation unit.
Usage:
%maxFrameAlloc = GetMaxFrameAllocation();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.

Torque Console Script Command Reference 691
GetModPaths()
Parameters: none
Return: string
Description:
Gets the current Mod path.
Usage:
$mp = GetModPaths();
GetRandom([[max]|[min,max]])
Parameters: max
High limit. (optional)
min
Low limit. (optional)
Return: numeric
Ranged from 0 to 1, exclusive, if no parameters given,
otherwise, see description.
Description:
Computes a pseudo-random number. If
min
is not included, then 0 is the
minimum. If
max
is not included, then 4,294,967,296 (highest 32-bit number
minus 1) is the maximum.
Usage:
%random = GetRandom(1,99);
GetRandomSeed()
Parameters: none
Return: numeric
Description:

Obtains the current random seed.
Usage:
%seed = GetRandomSeed();
GetRealTime()
Parameters: none
Return: numeric
Description:
Gets the real time (in milliseconds) since this computer started.
Usage:
%rt = GetRealTime();
GetRecord (text, index)
Parameters: text
String with new line-delimited records.
index
Record-based offset into the text string.
Return: string
Contains the found record-string.
Description:
Gets the record-string at index within text. In the usage example that follows, if
%text
equaled "Of Mice and Men\nGrapes of Wrath\nCannery Row", then
%record
would be set to "Grapes of Wrath" when the function returned.
Usage:
%record = GetRecord(%text, 1);
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference692

GetRecordCount (text)
Parameters: text
String with new line-delimited records.
Return: numeric
Description:
Get the number of record-strings within
text
.
Usage:
%count = GetRecordCount( %text );
GetRecords (text, first [, last])
Parameters: text
String with new line-delimited records.
first
Record-based offset into the text string specifying the first
record to extract.
last
Record-based offset into the text string specifying the last
record to extract.
Return: string
Contains the found records.
Description:
Gets one or more record-strings at
index
within
text
.If
count
is specified, gets
count

number of record-strings.
Usage:
%books = GetRecords(%obj.getTransform(), 0, 2);
GetResolution()
Parameters: none
Return: string
Description:
Obtains the current screen resolution.
Usage:
%res = GetResolution():
GetResolutionList(devicename)
Parameters:
devicename Name of the device to query.
Return: string
Description:
Obtains all available resolutions for the specified device.
Usage:
%rl = GetResolutionList(%device);
GetServerCount()
Parameters: none
Return: numeric
Description:
Gets the number of available servers from the master server.
Usage:
%sc = GetServerCount();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Torque Console Script Command Reference 693
GetSimTime()
Parameters: none

Return: numeric
Description:
Gets the current game time.
Usage:
%st = GetSimTime();
GetSubStr(str, loc, count)
Parameters: str
String to be processed.
loc
Offset into
str
to get start of substring from.
count
Number of characters to get.
Return: string
The processed resultant string.
Description:
Gets the substring of
string
that begins at
loc
, continuing for
count
characters or
to the end of the string, whichever comes first.
Usage:
%sub = GetSubStr(%text, 5, 99);
GetTag(tstring)
Parameters: tstring
Tagged string.

Return: string
Description:
Gets the tag for the tagged string
tstring
.
Usage:
%tag = GetTag(%variable);
GetTaggedString(tag)
Parameters: tag
Numeric tag of string to be removed.
Return: string
Description:
Gets the string associated with
tag
.
Usage:
%name = GetTaggedString( %tagname );
GetTerrainHeight(pos)
Parameters: pos
2D coordinate.
Return: numeric
Description:
Gets the terrain height at the specified position.
Usage:
%height = GetTerrainHeight(%pos);
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference694

GetVersionNumber()
Parameters: none
Return: numeric
Description:
Obtains the hard-coded engine version number of the current build.
Usage:
%vn = GetVersionNumber();
GetVersionString()
Parameters: none
Return: string
Description:
Obtains the hard-coded engine version string of the current build.
Usage:
%vs = GetVersionString ();
GetVideoDriverInfo()
Parameters: none
Return: string
Description:
Gets device driver information.
Usage:
%info = GetVideoDriverInfo();
GetWordCount(text)
Parameters: text
String with space-delimited words.
Return: numeric
Description:
Gets the number of word-strings within
text
.
Usage:

%count = GetWordCount( %text );
GetWord(text, index)
Parameters: text
String with space-delimited words.
index
Word-based offset into the text string.
Return: string
Contains the found word-string.
Description:
Gets the word-string at
index
within
text
. In the usage example that follows, if
%text
equaled "Of Mice and Men", then
%word
would be set to "and" when the
function returned.
Usage:
%word = GetWord(%text, 2);
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Torque Console Script Command Reference 695
GetWords(text, first [, last])
Parameters: text
String with space-delimited words.
first
Word-based offset into the text string specifying the first word
to extract.

last
Word-based offset into the text string specifying the last word
to extract.
Return: string
Contains the found words.
Description:
Gets one or more word-strings at
index
within
text
.If
count
is specified, gets
count
number of word-strings.
Usage:
%position = GetWords(%obj.getTransform(), 0, 2);
GLEnableLogging(switch)
Parameters: switch
1 enables, 0 disables.
Return: nothing
Description:
Enables OpenGL logging to gl_log.txt.
Usage:
GLEnableLogging(true);
GLEnableMetrics(switch)
Parameters: switch
1 enables, 0 disables.
Return: nothing
Description:

Tracks metrics data for OpenGL features.
Usage:
GLEnableMetrics(1);
GLEnableOutline(switch)
Parameters: switch
1 enables, 0 disables.
Return: nothing
Description:
Enables OpenGL wire-frame mode.
Usage:
GLEnableOutline(true);
GotoWebPage( address )
Parameters: address
URL of Web page.
Return: nothing
Description:
Opens default browser with specified address.
Usage:
GotoWebPage(" />Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference696
IncreaseFSAA()
Parameters: none
Return: nothing
Description:
Invokes
IncreaseNPatch
.

Usage:
IncreaseFSAA ()
IncreaseNPatch()
Parameters: none
Return: nothing
Description:
Increments
Npatch
level by 1.
Usage:
IncreaseNPatch();
InitContainerRadiusSearch (loc, radius, mask)
Parameters: loc
3D coordinate.
radius
To be searched.
mask
Mask of object type to look for.
Return: nothing
Description:
Searches for objects of type
mask
within a radius around the location.
Usage:
InitContainerRadiusSearch("0 450 76", %somerad, DebrisObjectType);
InputLog(filename)
Parameters: filename
String containing file name.
Return: nothing
Description: Windows Only:

Enables or disables logging of
DirectInput
events to log file
specified by string.
Usage:
InputLog(DI.log);
IsDemoRecording()
Parameters: none
Return: numeric
1 (or
true
) = enable, 0 (or
false
) = disable.
Description:
Queries if a demo is currently being recorded.
Usage:
%state = IsDemoRecording();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Torque Console Script Command Reference 697
IsDeviceFullScreenOnly(devicename)
Parameters: devicename
Name of device to query
Return: numeric
1 = yes, 0 = no.
Description:
Queries if device is capable of full screen only.
Usage:
IsDeviceFullScreenOnly(%devicename);

IsEventPending(%id)
Parameters: id
ID number to check
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if an event is pending with an ID number of
id
.
Usage:
%status = IsEventPending($eventid);
IsFile(filename)
Parameters: filename
String containing full file name.
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if the file exists in the Torque Script file name buffer.
Usage:
%result = IsFile("/common/server/script.cs");
IsFullScreen()
Parameters: none

Return: numeric
1 = yes, 0 = no.
Description:
Queries whether screen mode is set to full screen.
Usage:
%result = IsFullScreen();
IsJoystickDetected()
Parameters: none
Return numeric
1 =
true
,0 =
false
.
Description:
Determines if a joystick is present.
Usage:
%jd = IsJoystickDetected();
Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.
Appendix A
■
The Torque Game Engine Reference698
IsKoreanBuild()
Parameters: none
Return: string
Description:
Korean registry key checker.
Usage:
%kb = IsKoreanBuild();

IsObject(handle)
Parameters: handle
Handle of supposed object.
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if
handle
is an object.
Usage:
%status = IsObject(%chopper);
IsPackage(name)
Parameters: name
String containing the name of the package.
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if
name
is a registered package.
Usage:
%status = IsPackage(Show);

IsPointInside(point)
Parameters: point
"x y".
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if
point
is coincident with the interior of any object.
Usage:
%status = IsPointInside("123 345 25");
IsWriteableFileName(filename)
Parameters: filename
String containing full file name.
Return: numeric
1 =
true
,0 =
false
.
Description:
Queries if file specified by
filename
is writeable.
Usage:
%result = IsWriteableFileName("/common/server/script.cs");

Team LRN
Please purchase PDF Split-Merge on www.verypdf.com to remove this watermark.