<exports>
<class>
<name>ActionMap</name>
<base>SimObject</base>
<method>
<name>bind</name>
<args> device , action , [ modifier , mod... ] , command </args>
<desc>Use the bind method to associate a function to a keystroke or other device input.
The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.
@param device Name of the device to bind the command to.
@param action Name of the action to watch for.
@param modifier Special modifiers (mouse only), such as dead spot, etc.
@param command The function to be called on make and break.
@return No return value.
@sa bindCmd, getBinding, unbind</desc>
</method>
<method>
<name>bindCmd</name>
<args> device , action , makeCmd , breakCmd </args>
<desc>Use the bindCmd method to associate up to two functions to a keystroke or other device input.
The makeCmd is bound to the make event and the breakCmd is bound to the break event and in both cases, the commands are specified as complete scripts, with all arguments, elipses, and the terminating semi-colon. Either of these commands may be non-specified (NULL strings). For clarification, see 'Bind Sample' example below.
@param device Name of the device to bind the command to (see 'Device Table' below).
@param action Name of the action to watch for(see 'Action Table' below).
@param makeCmd The function to be called on make event.
@param breakCmd The function to be called on break event.
@return No return value.
@sa bind, getBinding, unbind</desc>
</method>
<method>
<name>bindObj</name>
<args>device, action, [modifier spec, mod...], command, object</args>
<desc>Use the bindObj method to associate a function to a keystroke or other device input.
The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.
@param device Name of the device to bind the command to.
@param action Name of the action to watch for.
@param modifier Special modifiers (mouse only), such as dead spot, etc.
@param command The function to be called on make and break.
@param object The explicit object (it defaults to NULL when you call bind() )
@return No return value.
@sa bindCmd, getBinding, unbind</desc>
</method>
<method>
<name>getBinding</name>
<args> command </args>
<desc>Use the getBinding method to get the binding for a specified command.
@param command The function to seek a binding for.
@return Returns a string containing the binding as a field (TAB separated string), or a NULL string meaning 'no binding found'.
@sa bind, bindCmd</desc>
</method>
<method>
<name>getCommand</name>
<args> device , action </args>
<desc>Use the getCommand method to get the function associated with a specific device + action pair.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@return Returns the function name or specification associated with the specified device + action pair, or a NULL-string meaning 'no binding found'.
@sa bind, bindCmd, getBinding</desc>
</method>
<method>
<name>getDeadZone</name>
<args> device , action </args>
<desc>Use the getDeadZone method to get the dead-zone associated with a specific device + action pair.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@return Returns a dead-zone specification, or "0 0" meaning that there is no dead-zone, or a NULL string meaning the mapping was not found.
@sa bind, bindCmd</desc>
</method>
<method>
<name>getScale</name>
<args> device , action </args>
<desc>Use the getScale method to get the scale associated with a specific device + action pair.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@return Returns 1 if no scale is associated with the specified device + action pair, or the mapping was not found.
@sa bind, bindCmd</desc>
</method>
<method>
<name>isInverted</name>
<args> device , action </args>
<desc>Use the Purpose method to determine if a specific device + action pair in inverted.
This only applies to scrolling devices.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@return Returns 1 if the mouse (or other scrolling device) is inverted, 0 otherwise.
@sa bind, bindCmd</desc>
</method>
<method>
<name>pop</name>
<desc>Use the pop method to de-activate an ActionMap and remove it from non-global ActionMap stack.
@return No return value.
@sa push</desc>
</method>
<method>
<name>push</name>
<desc>Use the pop method to activate an ActionMap and place it at the top of the non-global ActionMap stack.
@return No return value.
@sa pop</desc>
</method>
<method>
<name>save</name>
<args> [ fileName ] [ , append ] </args>
<desc>Use the save method to save an entire action map specification to a file. If append is not specified, or specified as false, fileName will be overwritten, otherwise the action map will be appended to the file.
@param fileName Full path to file in which to store action map definition.
@param append If true, do not overwrite the file, else start from scratch.
@return No return value</desc>
</method>
<method>
<name>unbind</name>
<args> device , action </args>
<desc>Use the unbind method to remove a previosly specified device + action pair from the action map.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@return No return value.
@sa bind, bindCmd</desc>
</method>
<method>
<name>unbindObj</name>
<args>device, action, object</args>
<desc>Use the unbind method to remove a previosly specified device + action pair from the action map.
@param device Name of the device to bound to a command (see 'Device Table' below).
@param action Name of the action to watch for (see 'Action Table' below).
@param object Explicit object (it defaults to NULL when you call unbind() ).@return No return value.
@sa bind, bindCmd</desc>
</method>
</class>
<class>
<name>ActionMapGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>ActiveActionMapSet</name>
<base>SimSet</base>
</class>
<class>
<name>AudioDescription</name>
<base>SimDataBlock</base>
<field>
<name>coneInsideAngle</name>
<desc>int coneInsideAngle</desc>
</field>
<field>
<name>coneOutsideAngle</name>
<desc>int coneOutsideAngle</desc>
</field>
<field>
<name>coneOutsideVolume</name>
<desc>float coneOutsideVolume</desc>
</field>
<field>
<name>coneVector</name>
<desc>Point3F coneVector</desc>
</field>
<field>
<name>environmentLevel</name>
<desc>float environmentLevel</desc>
</field>
<field>
<name>is3D</name>
<desc>bool is3D</desc>
</field>
<field>
<name>isLooping</name>
<desc>bool isLooping</desc>
</field>
<field>
<name>isStreaming</name>
<desc>bool isStreaming</desc>
</field>
<field>
<name>loopCount</name>
<desc>int loopCount</desc>
</field>
<field>
<name>maxDistance</name>
<desc>float maxDistance</desc>
</field>
<field>
<name>maxLoopGap</name>
<desc>int maxLoopGap</desc>
</field>
<field>
<name>minLoopGap</name>
<desc>int minLoopGap</desc>
</field>
<field>
<name>referenceDistance</name>
<desc>float referenceDistance</desc>
</field>
<field>
<name>Type</name>
<desc>int Type</desc>
</field>
<field>
<name>volume</name>
<desc>float volume</desc>
</field>
</class>
<class>
<name>AudioEnvironment</name>
<base>SimDataBlock</base>
<field>
<name>airAbsorption</name>
<desc>float airAbsorption</desc>
</field>
<field>
<name>damping</name>
<desc>float damping</desc>
</field>
<field>
<name>decayHFRatio</name>
<desc>float decayHFRatio</desc>
</field>
<field>
<name>decayTime</name>
<desc>float decayTime</desc>
</field>
<field>
<name>effectVolume</name>
<desc>float effectVolume</desc>
</field>
<field>
<name>environmentDiffusion</name>
<desc>float environmentDiffusion</desc>
</field>
<field>
<name>environmentSize</name>
<desc>float environmentSize</desc>
</field>
<field>
<name>flags</name>
<desc>int flags</desc>
</field>
<field>
<name>reflections</name>
<desc>int reflections</desc>
</field>
<field>
<name>reflectionsDelay</name>
<desc>float reflectionsDelay</desc>
</field>
<field>
<name>reverb</name>
<desc>int reverb</desc>
</field>
<field>
<name>reverbDelay</name>
<desc>float reverbDelay</desc>
</field>
<field>
<name>room</name>
<desc>enumval room</desc>
</field>
<field>
<name>roomHF</name>
<desc>int roomHF</desc>
</field>
<field>
<name>roomRolloffFactor</name>
<desc>float roomRolloffFactor</desc>
</field>
<field>
<name>roomVolume</name>
<desc>int roomVolume</desc>
</field>
<field>
<name>useRoom</name>
<desc>bool useRoom</desc>
</field>
</class>
<class>
<name>AudioProfile</name>
<base>SimDataBlock</base>
<field>
<name>description</name>
<desc>AudioDescription description</desc>
</field>
<field>
<name>environment</name>
<desc>AudioSampleEnvironment environment</desc>
</field>
<field>
<name>fileName</name>
<desc>filename fileName</desc>
</field>
<field>
<name>preload</name>
<desc>bool preload</desc>
</field>
</class>
<class>
<name>AudioSampleEnvironment</name>
<base>SimDataBlock</base>
<field>
<name>airAbsorption</name>
<desc>float airAbsorption</desc>
</field>
<field>
<name>direct</name>
<desc>int direct</desc>
</field>
<field>
<name>directHF</name>
<desc>int directHF</desc>
</field>
<field>
<name>flags</name>
<desc>int flags</desc>
</field>
<field>
<name>obstruction</name>
<desc>float obstruction</desc>
</field>
<field>
<name>obstructionLFRatio</name>
<desc>float obstructionLFRatio</desc>
</field>
<field>
<name>occlusion</name>
<desc>float occlusion</desc>
</field>
<field>
<name>occlusionLFRatio</name>
<desc>float occlusionLFRatio</desc>
</field>
<field>
<name>occlusionRoomRatio</name>
<desc>float occlusionRoomRatio</desc>
</field>
<field>
<name>outsideVolumeHF</name>
<desc>int outsideVolumeHF</desc>
</field>
<field>
<name>room</name>
<desc>int room</desc>
</field>
<field>
<name>roomRolloff</name>
<desc>float roomRolloff</desc>
</field>
</class>
<class>
<name>BanList</name>
<base>SimObject</base>
<method>
<name>add</name>
<args> int ID, TransportAddress TA, int banLength </args>
<desc>Ban a user for banLength seconds.

@param   ID       Unique ID of the player.
@param   TA       Address from which the player connected.
@param   banTime  Time at which they will be allowed back in.</desc>
</method>
<method>
<name>addAbsolute</name>
<args> int ID, TransportAddress TA, int banTime </args>
<desc>Ban a user until a given time.

@param   ID       Unique ID of the player.
@param   TA       Address from which the player connected.
@param   banTime  Time at which they will be allowed back in.</desc>
</method>
<method>
<name>export</name>
<args>string filename</args>
<desc>Dump the banlist to a file.</desc>
</method>
<method>
<name>isBanned</name>
<args> int ID, TransportAddress TA </args>
<desc>Is someone banned?

@param   ID       Unique ID of the player.
@param   TA       Address from which the player connected.</desc>
</method>
<method>
<name>removeBan</name>
<args> int ID, TransportAddress TA </args>
<desc>Unban someone.

@param   ID       Unique ID of the player.
@param   TA       Address from which the player connected.</desc>
</method>
</class>
<class>
<name>BehaviorComponent</name>
<base>DynamicConsoleMethodComponent</base>
<method>
<name>addBehavior</name>
<args>BehaviorInstance bi</args>
<desc>- Add a behavior to the object
@param bi The behavior instance to add@return (bool success) Whether or not the behavior was successfully added</desc>
</method>
<method>
<name>clearBehaviors</name>
<desc>- Clear all behavior instances
@return No return value</desc>
</method>
<method>
<name>getBehavior</name>
<args>string BehaviorTemplateName</args>
<desc>- gets a behavior
@param BehaviorTemplateName The name of the template of the behavior instance you want
@return (BehaviorInstance bi) The behavior instance you requested</desc>
</method>
<method>
<name>getBehaviorByIndex</name>
<args>int index</args>
<desc>- Gets a particular behavior
@param index The index of the behavior to get
@return (BehaviorInstance bi) The behavior instance you requested</desc>
</method>
<method>
<name>getBehaviorCount</name>
<desc>- Get the count of behaviors on an object
@return (int count) The number of behaviors on an object</desc>
</method>
<method>
<name>removeBehavior</name>
<args>BehaviorInstance bi, [bool deleteBehavior = true]</args>
<desc>@param bi The behavior instance to remove
@param deleteBehavior Whether or not to delete the behavior
@return (bool success) Whether the behavior was successfully removed</desc>
</method>
<method>
<name>reOrder</name>
<args>BehaviorInstance inst, [int desiredIndex = 0]</args>
<desc>@param inst The behavior instance you want to reorder
@param desiredIndex The index you want the behavior instance to be reordered to
@return (bool success) Whether or not the behavior instance was successfully reordered</desc>
</method>
</class>
<class>
<name>BehaviorInstance</name>
<base>SimObject</base>
<method>
<name>getTemplateName</name>
<desc>- Get the template name of this behavior
@return (string name) The name of the template this behaivor was created from</desc>
</method>
<field>
<name>Owner</name>
<desc>SimObjectPtr Owner</desc>
</field>
<field>
<name>template</name>
<desc>Template this instance was created from</desc>
</field>
</class>
<class>
<name>BehaviorSet</name>
<base>SimSet</base>
</class>
<class>
<name>BehaviorTemplate</name>
<base>SimObject</base>
<method>
<name>addBehaviorField</name>
<args>fieldName, desc, type, [defaultValue, userData]</args>
<desc>Adds a named BehaviorField to a Behavior Template
@param fieldName The name of this field
@param desc The Description of this field
@param type The DataType for this field (default, int, float, Point2F, bool, enum, Object, keybind, color)
@param defaultValue The Default value for this field
@param userData An extra data field that can be used for custom data on a per-field basis&lt;br&gt;Usage for default types&lt;br&gt;-enum: a TAB separated list of possible values&lt;br&gt;-object: the T2D object type that are valid choices for the field.  The object types observe inheritance, so if you have a t2dSceneObject field you will be able to choose t2dStaticSrpites, t2dAnimatedSprites, etc.
@return Nothing</desc>
</method>
<method>
<name>createInstance</name>
<desc>- Create an instance of this behavior
@return (BehaviorInstance inst) The behavior instance created</desc>
</method>
<method>
<name>getBehaviorField</name>
<args>int index</args>
<desc>- Gets a Tab-Delimited list of information about a BehaviorField specified by Index
@param index The index of the behavior
@return FieldName, FieldType and FieldDefaultValue, each separated by a TAB character.</desc>
</method>
<method>
<name>getBehaviorFieldCount</name>
<desc>- Get the number of BehaviorField's on this object
@return Returns the number of BehaviorFields as a nonnegative integer</desc>
</method>
<method>
<name>getBehaviorFieldDescription</name>
<args>int index</args>
<desc>- Gets a field description by index
@param index The index of the behavior
@return Returns a string representing the description of this field</desc>
</method>
<method>
<name>getBehaviorFieldUserData</name>
<args>int index</args>
<desc>- Gets the UserData associated with a field by index in the field list
@param index The index of the behavior
@return Returns a string representing the user data of this field</desc>
</method>
<field>
<name>behaviorType</name>
<desc>?? Organizational keyword ??</desc>
</field>
<field>
<name>description</name>
<desc>The description of this behavior which can be set to a "string" or a fileName</desc>
</field>
<field>
<name>friendlyName</name>
<desc>Human friendly name of this behavior</desc>
</field>
</class>
<class>
<name>CachedInterfaceExampleComponent</name>
<base>SimComponent</base>
</class>
<class>
<name>ChunkFileGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>ClientConnectionGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>ClientGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>ConnectionMessageEvent</name>
</class>
<class>
<name>ConsoleLogger</name>
<base>SimObject</base>
<method>
<name>attach</name>
<desc>Attaches this object to the console and begins logging
@return Returns true on success, and false on failure.</desc>
</method>
<method>
<name>detach</name>
<desc>Detaches this object from the console and stops logging
@return Returns true on success, and false on failure.</desc>
</method>
<field>
<name>level</name>
<desc>enumval level</desc>
</field>
</class>
<class>
<name>DataBlockGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>DbgFileView</name>
<base>GuiArrayCtrl</base>
<method>
<name>clearBreakPositions</name>
<desc>Clear all break points in the current file.
@return No return value.</desc>
</method>
<method>
<name>findString</name>
<args>string findThis</args>
<desc>Find the specified string in the currently viewed file and scroll it into view.
@return Returns true on success</desc>
</method>
<method>
<name>getCurrentLine</name>
<desc>Get the currently executing file and line, if any.

@returns A string containing the file, a tab, and then the line number. Use getField() with this.</desc>
</method>
<method>
<name>open</name>
<args>string filename</args>
<desc>Open a file for viewing.

@return Returns true on success.
@note This loads the file from the local system.</desc>
</method>
<method>
<name>removeBreak</name>
<args>int line</args>
<desc>Remove a breakpoint from the specified line.
@return No return value.</desc>
</method>
<method>
<name>setBreak</name>
<args>int line</args>
<desc>Set a breakpoint at the specified line.
@return No return value.</desc>
</method>
<method>
<name>setBreakPosition</name>
<args>int line</args>
<desc>Set a breakpoint at the specified line.
@return No return value.</desc>
</method>
<method>
<name>setCurrentLine</name>
<args>int line, bool selected</args>
<desc>Set the current highlighted line.
@return No return value.</desc>
</method>
</class>
<class>
<name>DynamicConsoleMethodComponent</name>
<base>SimComponent</base>
<method>
<name>callMethod</name>
<args>methodName, argi</args>
<desc>Calls script defined method
@param methodName The method's name as a string
@param argi Any arguments to pass to the method
@return No return value@note %obj.callMethod( %methodName, %arg1, %arg2, ... );</desc>
</method>
</class>
<class>
<name>EventManager</name>
<base>SimObject</base>
<method>
<name>dumpEvents</name>
<desc>Print all registered events to the console.</desc>
</method>
<method>
<name>dumpSubscribers</name>
<args> String event </args>
<desc>Print all subscribers to an event to the console.
@param event The event whose subscribers are to be printed. If this parameter isn't specified, all events will be dumped.</desc>
</method>
<method>
<name>isRegisteredEvent</name>
<args> String event </args>
<desc>Check if an event is registered or not.
@param event The event to check.
@return Whether or not the event exists.</desc>
</method>
<method>
<name>postEvent</name>
<args> String event, String data </args>
<desc>Trigger an event.
@param event The event to trigger.
@param data The data associated with the event.
@return Whether or not the event was dispatched successfully.</desc>
</method>
<method>
<name>registerEvent</name>
<args> String event </args>
<desc>Register an event with the event manager.
@param event The event to register.
@return Whether or not the event was registered successfully.</desc>
</method>
<method>
<name>remove</name>
<args> SimObject listener, String event </args>
<desc>Remove a listener from an event.
@param listener The listener to remove.
@param event The event to be removed from.</desc>
</method>
<method>
<name>subscribe</name>
<args> SimObject listener, String event, String callback </args>
<desc>Subscribe a listener to an event.
@param listener The listener to subscribe.
@param event The event to subscribe to.
@param callback Optional method name to receive the event notification. If this is not specified, "on[event]" will be used.
@return Whether or not the subscription was successful.</desc>
</method>
<method>
<name>unregisterEvent</name>
<args> String event </args>
<desc>Remove an event from the EventManager.
@param event The event to remove.</desc>
</method>
<field>
<name>queue</name>
<desc>string queue</desc>
</field>
</class>
<class>
<name>FileChunkEvent</name>
</class>
<class>
<name>FileDialog</name>
<base>SimObject</base>
<method>
<name>Execute</name>
<desc>Executes the dialog
@return Returns true on success and false otherwise</desc>
</method>
<field>
<name>ChangePath</name>
<desc>True/False whether to set the working directory to the directory returned by the dialog</desc>
</field>
<field>
<name>DefaultFile</name>
<desc>Default File when Dialog is shown</desc>
</field>
<field>
<name>DefaultPath</name>
<desc>Default Path when Dialog is shown</desc>
</field>
<field>
<name>fileName</name>
<desc>Default File when Dialog is shown</desc>
</field>
<field>
<name>Filters</name>
<desc>Default File when Dialog is shown</desc>
</field>
<field>
<name>Title</name>
<desc>Default File when Dialog is shown</desc>
</field>
</class>
<class>
<name>FileDownloadRequestEvent</name>
</class>
<class>
<name>FileObject</name>
<base>SimObject</base>
<method>
<name>close</name>
<desc>Use the close method to close the current file handle. If the file was opened for writing, this flushes the contents of the last write to disk.
@return No return value.
@sa openForAppend, openForRead, openForWrite</desc>
</method>
<method>
<name>isEOF</name>
<desc>Use the isEOF method to check to see if the end of the current file (opened for read) has been reached.
@return Returns true if the end of file has been reached, false otherwise.
@sa openForRead</desc>
</method>
<method>
<name>openForAppend</name>
<args> filename </args>
<desc>Use the openForAppend method to open a previously created file for appending. If the file specified by filename does not exist, the file is created first.
@param filename The path and filename of the file to open for appending.
@return Returns true if the file was successfully opened for appending, false otherwise.
@sa close, openForRead, openForWrite</desc>
</method>
<method>
<name>openForRead</name>
<args> filename </args>
<desc>Use the openForRead method to open a previously created file for reading.
@param filename The path and filename of the file to open for reading.
@return Returns true if the file was successfully opened for reading, false otherwise.
@sa close, OpenForAppend, OpenForWrite</desc>
</method>
<method>
<name>openForWrite</name>
<args> filename </args>
<desc>Use the openForWrite method to previously created or a new file for writing. In either case, the file will be overwritten.
@param filename The path and filename of the file to open for writing.
@return Returns true if the file was successfully opened for writing, false otherwise.
@sa close, OpenForAppend, openForRead</desc>
</method>
<method>
<name>peekLine</name>
<desc>Read a line from the file without moving the stream position.</desc>
</method>
<method>
<name>readLine</name>
<desc>Use the readLine method to read a single line from a file previously opened for reading.
Use isEOF to check for end of file while reading.
@return Returns the next line in the file, or a NULL string if the end-of-file has been reached.
@sa isEOF, openForRead</desc>
</method>
<method>
<name>writeLine</name>
<args> text </args>
<desc>Use the writeLine method to write a value ( text ) into a file that was previously opened for appending or over-writing.
@param text The value to write to the file.
@return No return value.
@sa openForAppend, openForWrite</desc>
</method>
<method>
<name>writeObject</name>
<args>SimObject, object prepend</args>
</method>
</class>
<class>
<name>FileStreamObject</name>
<base>StreamObject</base>
<method>
<name>close</name>
<desc>Close the file.</desc>
</method>
<method>
<name>open</name>
<args>filename, mode</args>
<desc>Open a file. Mode can be one of Read, Write, ReadWrite or WriteAppend.</desc>
</method>
</class>
<class>
<name>fxFoliageSet</name>
<base>SimSet</base>
</class>
<class>
<name>fxReplicatorSet</name>
<base>SimSet</base>
</class>
<class>
<name>GameConnection</name>
<base>NetConnection</base>
<method>
<name>activateGhosting</name>
<desc>Use the activateGhosting method to GameConnection instance to start ghosting objects to the client.
This is called on each client connection by the server.
@return No return value.
@sa resetGhosting</desc>
</method>
<method>
<name>delete</name>
<args> [ reason ] </args>
<desc>Use the delete method to destroy and disconnect the current connection, giving an optional reason. If reason is specified, it will be transmitted to the client/server on the other end of the connection.
@param reason A string explaining while the connection is being severed.
@return No return value</desc>
</method>
<method>
<name>getServerConnection</name>
<desc>Get the server connection if any.</desc>
</method>
<method>
<name>resetGhosting</name>
<desc>Use the resetGhosting method to reset ghosting. This in effect tells the server to resend each ghost to insure that all objects which should be ghosts and are in fact ghosted.
@return No return value.
@sa activateGhosting</desc>
</method>
<method>
<name>setConnectArgs</name>
<args> name [ , arg1 , ... , arg15 ] </args>
<desc>Use the setConnectArgs method to set the connection arguments for this client-side GameConnection. These values will be passed to the server upon establishing a connection.
@param name Generally, the first argument is the name of the player.
@param arg1 ... , arg15 – 15 additional arguments may be passed.
@return No return value.
@sa setJoinPassword</desc>
</method>
<method>
<name>setJoinPassword</name>
<args> password </args>
<desc>Use the setJoinPassword method to set the password required to connect to this server-side GameConnection.
Pass a NULL string to clear the password.
@param password A string representing the case insensitive password to use for this server-side GameConnection.
@return No return value.
@sa setConnectArgs</desc>
</method>
</class>
<class>
<name>GhostAlwaysObjectEvent</name>
</class>
<class>
<name>GhostAlwaysSet</name>
<base>SimSet</base>
</class>
<class>
<name>GlobalActionMap</name>
<base>ActionMap</base>
</class>
<class>
<name>GuiArrayCtrl</name>
<base>GuiControl</base>
</class>
<class>
<name>GuiAutoScrollCtrl</name>
<base>GuiTickCtrl</base>
<field>
<name>childBorder</name>
<desc>int childBorder</desc>
</field>
<field>
<name>resetDelay</name>
<desc>float resetDelay</desc>
</field>
<field>
<name>scrollSpeed</name>
<desc>float scrollSpeed</desc>
</field>
<field>
<name>startDelay</name>
<desc>float startDelay</desc>
</field>
<field>
<name>tickCallback</name>
<desc>bool tickCallback</desc>
</field>
</class>
<class>
<name>GuiAviBitmapCtrl</name>
<base>GuiControl</base>
<field>
<name>done</name>
<desc>bool done</desc>
</field>
</class>
<class>
<name>GuiBackgroundCtrl</name>
<base>GuiControl</base>
</class>
<class>
<name>GuiBitmapBorderCtrl</name>
<base>GuiControl</base>
</class>
<class>
<name>GuiBitmapButtonCtrl</name>
<base>GuiButtonCtrl</base>
<method>
<name>setBitmap</name>
<args>filepath name</args>
<desc>Loads a bitmap from a given file
@return No return value.</desc>
</method>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
</class>
<class>
<name>GuiBitmapButtonTextCtrl</name>
<base>GuiBitmapButtonCtrl</base>
</class>
<class>
<name>GuiBitmapCtrl</name>
<base>GuiControl</base>
<method>
<name>setBitmap</name>
<args> pathName </args>
<desc>Use the setBitmap method to change the bitmap this control uses.
@param pathName A path to a new texture for this control. Limited to 256x256.
@return No return value</desc>
</method>
<method>
<name>setValue</name>
<args>int xAxis, int yAxis</args>
<desc>Set the offset of the bitmap.
@return No return value.</desc>
</method>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
<field>
<name>wrap</name>
<desc>bool wrap</desc>
</field>
</class>
<class>
<name>GuiBorderButtonCtrl</name>
<base>GuiButtonBaseCtrl</base>
</class>
<class>
<name>GuiBubbleTextCtrl</name>
<base>GuiTextCtrl</base>
</class>
<class>
<name>GuiButtonBaseCtrl</name>
<base>GuiControl</base>
<method>
<name>getText</name>
<desc>- returns the text of the button.
@return The text member of the button as a char string</desc>
</method>
<method>
<name>performClick</name>
<desc>- simulates a button click from script.</desc>
</method>
<method>
<name>setStateOn</name>
<args>bool isStateOn</args>
<desc>- sets the state on member and updates siblings of the same group.</desc>
</method>
<method>
<name>setText</name>
<args>string text</args>
<desc>- Sets the text of the button to the string.</desc>
</method>
<method>
<name>setTextID</name>
<args>string id</args>
<desc>- Sets the text of the button to the localized string.</desc>
</method>
<field>
<name>buttonType</name>
<desc>enumval buttonType</desc>
</field>
<field>
<name>groupNum</name>
<desc>int groupNum</desc>
</field>
<field>
<name>text</name>
<desc>caseString text</desc>
</field>
<field>
<name>textID</name>
<desc>string textID</desc>
</field>
<field>
<name>useMouseEvents</name>
<desc>bool useMouseEvents</desc>
</field>
</class>
<class>
<name>GuiButtonCtrl</name>
<base>GuiButtonBaseCtrl</base>
</class>
<class>
<name>GuiCanvas</name>
<base>GuiControl</base>
<method>
<name>cursorOff</name>
<desc>Use the cursorOff method to disable the cursor.
@return No return value</desc>
</method>
<method>
<name>cursorOn</name>
<desc>Use the cursorOn method to enable the cursor.
@return No return value</desc>
</method>
<method>
<name>getContent</name>
<desc>Use the getContent method to get the ID of the control which is being used as the current canvas content.
@return Returns the ID of the current canvas content (a control), or 0 meaning the canvas is empty</desc>
</method>
<method>
<name>getCursorPos</name>
<desc>Use the getCursorPos method to retrieve the current position of the mouse pointer.
@return Returns a vector containing the “x y” coordinates of the cursor in the canvas</desc>
</method>
<method>
<name>getMouseControl</name>
<desc>Gets the gui control under the mouse.</desc>
</method>
<method>
<name>hideCursor</name>
</method>
<method>
<name>isCursorOn</name>
</method>
<method>
<name>popDialog</name>
<args> handle </args>
<desc>Use the popDialog method to remove a currently showing dialog. If no handle is provided, the top most dialog is popped.
@param handle The ID or a previously pushed dialog.
@return No return value.
@sa pushDialog, popLayer</desc>
</method>
<method>
<name>popLayer</name>
<args> layer </args>
<desc>Use the popLayer method to remove (close) all dialogs in the specified canvas ‘layer’.
@param layer A integer value in the range [ 0 , inf ) specifying the canvas layer to clear.
@return No return value.
@sa pushDialog, popDialog</desc>
</method>
<method>
<name>pushDialog</name>
<args> handle [ , layer ] </args>
<desc>Use the pushDialog method to open a dialog on a specific canvas layer, or in the same layer the last openned dialog. Newly placed dialogs placed in a layer with another dialog(s) will overlap the prior dialog(s).
@param handle The numeric ID or name of the dialog to be opened.
@param layer A integer value in the range [ 0 , inf ) specifying the canvas layer to place the dialog in.
@return No return value</desc>
</method>
<method>
<name>renderFront</name>
<args>bool enable</args>
</method>
<method>
<name>repaint</name>
<desc>Use the repaint method to force the canvas to redraw all elements.
@return No return value</desc>
</method>
<method>
<name>reset</name>
<desc>Use the reset method to reset the current canvas update region.
@return No return value</desc>
</method>
<method>
<name>setContent</name>
<args> handle </args>
<desc>Use the setContent method to set the control identified by handle as the current canvas content.
@param handle The numeric ID or name of the control to be made the canvas contents.
@return No return value</desc>
</method>
<method>
<name>setCursor</name>
<args> cursorHandle </args>
<desc>Use the setCursor method to select the current cursor.
@param cursorHandle The ID of a previously defined GuiCursor object.
@return No return value</desc>
</method>
<method>
<name>setCursorPos</name>
<args> </args>
<desc>Use the setCursorPos method to set the position of the cursor in the cavas.
@param position An "x y" position vector specifying the new location of the cursor.
@return No return value</desc>
</method>
<method>
<name>setDoubleClickDelay</name>
</method>
<method>
<name>setDoubleClickMoveBuffer</name>
</method>
<method>
<name>showCursor</name>
</method>
</class>
<class>
<name>GuiCheckBoxCtrl</name>
<base>GuiButtonBaseCtrl</base>
<method>
<name>setStateOn</name>
<args>state</args>
<desc>Sets the control as active and updates siblings of the same group.@param state This argument may be a boolean value or an integer.state &lt; 0: Parent::setStateOn(false), obj::setActive(false)
state == 0 (or false): Parent::setStateOn(false), obj::setActive(true)
state &gt; 0 (or true): Parent::setStateOn(true), obj::setActive(true)</desc>
</method>
<field>
<name>useInactiveState</name>
<desc>bool useInactiveState</desc>
</field>
</class>
<class>
<name>GuiChunkedBitmapCtrl</name>
<base>GuiControl</base>
<method>
<name>setBitmap</name>
<args>string filename</args>
<desc>Set the bitmap contained in this control.
@param filename The location of the bitmap.
@return No return value.</desc>
</method>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
<field>
<name>tile</name>
<desc>bool tile</desc>
</field>
<field>
<name>useVariable</name>
<desc>bool useVariable</desc>
</field>
</class>
<class>
<name>GuiColorPickerCtrl</name>
<base>GuiControl</base>
<method>
<name>getSelectorPos</name>
<desc>Gets the current position of the selector
@return Returns the position of the selector as space-separted x,y coordinates.</desc>
</method>
<method>
<name>setSelectorPos</name>
<args>"x y"</args>
<desc>Sets the current position of the selector@param The coordinates with space-separated formating.
@return No return value.</desc>
</method>
<method>
<name>updateColor</name>
<desc>Forces update of pick color
@return No return value.</desc>
</method>
<field>
<name>ActionOnMove</name>
<desc>bool ActionOnMove</desc>
</field>
<field>
<name>BaseColor</name>
<desc>ColorF BaseColor</desc>
</field>
<field>
<name>DisplayMode</name>
<desc>enumval DisplayMode</desc>
</field>
<field>
<name>PickColor</name>
<desc>ColorF PickColor</desc>
</field>
<field>
<name>SelectorGap</name>
<desc>int SelectorGap</desc>
</field>
</class>
<class>
<name>GuiConsole</name>
<base>GuiArrayCtrl</base>
</class>
<class>
<name>GuiConsoleEditCtrl</name>
<base>GuiTextEditCtrl</base>
<field>
<name>useSiblingScroller</name>
<desc>bool useSiblingScroller</desc>
</field>
</class>
<class>
<name>GuiConsoleTextCtrl</name>
<base>GuiControl</base>
<field>
<name>expression</name>
<desc>caseString expression</desc>
</field>
</class>
<class>
<name>GuiControl</name>
<base>SimGroup</base>
<method>
<name>addGuiControl</name>
<args>int controlId</args>
<desc>Adds the gui control
@param controlId integer ID of the control to add
@return No Return value</desc>
</method>
<method>
<name>findHitControl</name>
<args>int x, int y</args>
<desc>Searches for the control at the given point
@return Returns the Id of the control at the point</desc>
</method>
<method>
<name>getCenter</name>
<desc>@return Returns center of control, as space seperated ints</desc>
</method>
<method>
<name>getExtent</name>
<desc>Get the width and height of the control.
@return The height and width as a string with space-separated integers</desc>
</method>
<method>
<name>getGlobalCenter</name>
<desc>@return Returns center of control, as space seperated ints</desc>
</method>
<method>
<name>getGlobalPosition</name>
<desc>@return Returns the control's position converted to global coordinates (position as space-separted integers)</desc>
</method>
<method>
<name>getMinExtent</name>
<desc>Get the minimum allowed size of the control.
@return Returns the minimum extent as a string with space separated point values &lt;width&gt; &lt;height&gt;</desc>
</method>
<method>
<name>getParent</name>
<desc>@return Returns the Id of the parent control</desc>
</method>
<method>
<name>getPosition</name>
<desc>@return A string set up as "&lt;pos.x&gt; &lt;pos.y&gt;"</desc>
</method>
<method>
<name>getScriptFile</name>
<desc>- gets the script file the control was created in
@return String containing script file path</desc>
</method>
<method>
<name>getValue</name>
<desc>Use the getValue method to get the control-specific 'value' for this control.
@return Returns a control-specific specific value. Varies by control</desc>
</method>
<method>
<name>isActive</name>
<desc>Use the isActive method to determine if this control is active.
An inactive control may visible, but will not accept inputs. It will also normally re-shade or re-skin itself to reflect its inactive state
@return Returns true if this control is active.</desc>
</method>
<method>
<name>isAwake</name>
<desc>Use the isAwake method to determine if this control is awake.
@return Returns true if this control is awake and ready to display</desc>
</method>
<method>
<name>isVisible</name>
<desc>Use the isVisible method to determine if this control is visible.
This can return true, even if the entire control covered by another. This merely means that the control will render if not covered
@return Returns true if the control is visible.</desc>
</method>
<method>
<name>makeFirstResponder</name>
<args> isFirst </args>
<desc>Use the makeFirstResponder method to force this control to become the first responder.
@param isFirst A boolean value. If true, then this control become first reponder and at captures inputs before all other controls, excluding dialogs above this control.
@return No return value</desc>
</method>
<method>
<name>pointInControl</name>
<args>int x, int y</args>
<desc>Check if point id in the control
@param x Point x coordinate in parent coords
@param y Point y coordinate in parent coords
@return Returns true if the point is in the control, false otherwise</desc>
</method>
<method>
<name>reorderChild</name>
<args>child1, child2</args>
<desc>uses simset reorder to push child 1 after child 2 - both must already be child controls of this control</desc>
</method>
<method>
<name>resize</name>
<args>int x, int y, int w, int h</args>
<desc>Resizes the control to the given dimensions</desc>
</method>
<method>
<name>setActive</name>
<args> isActive </args>
<desc>Use the setActive method to (de)activate this control. Once active, a control can accept inputs. Controls automatically re-shade/skin themselves to reflect their active/inactive state.
@param isActive A boolean value. f isActive is true, this control is activated, else it is set to inactive.
@return No return value</desc>
</method>
<method>
<name>setCanSave</name>
<args>bool canSave</args>
<desc>Sets whether this control can serialize itself to the hard disk
@param Flag setting
@return No Return Value</desc>
</method>
<method>
<name>setCenter</name>
<args>int x, int y</args>
<desc>Sets control position, by center - coords are local not global
@return No Return value.</desc>
</method>
<method>
<name>setExtent</name>
<args>int width, int height</args>
<desc>Sets the width &amp; height of the control.
@return No Return Value.</desc>
</method>
<method>
<name>setFirstResponder</name>
<desc>Sets this control as the first responder</desc>
</method>
<method>
<name>setPosition</name>
<args>int x, int y</args>
<desc>Sets the current control position in local space
@return No Return Value.</desc>
</method>
<method>
<name>setPositionGlobal</name>
<args>int x, int y</args>
<desc>Sets the control's position in global space
@return No return value</desc>
</method>
<method>
<name>setProfile</name>
<args>GuiControlProfile p</args>
<desc>Sets the currently used from for the GuiControl
@param p The profile you wish to set the control to use
@return No return value</desc>
</method>
<method>
<name>setValue</name>
<args> value </args>
<desc>Use the setValue method to set the control specific value to value. Purpose and type varies by control type.
@param value Some control specific value.
@return No return value</desc>
</method>
<method>
<name>setVisible</name>
<args> isVisible </args>
<desc>Use the setVisible method to (un)hide this control.
@param isVisible A boolean value. If true, the control will be made visible, otherwise the control will be hidden.
@return No return value</desc>
</method>
<field>
<name>Accelerator</name>
<desc>string Accelerator</desc>
</field>
<field>
<name>AltCommand</name>
<desc>string AltCommand</desc>
</field>
<field>
<name>canSave</name>
<desc>bool canSave</desc>
</field>
<field>
<name>Command</name>
<desc>string Command</desc>
</field>
<field>
<name>Extent</name>
<desc>Point2I Extent</desc>
</field>
<field>
<name>HorizSizing</name>
<desc>enumval HorizSizing</desc>
</field>
<field>
<name>hovertime</name>
<desc>int hovertime</desc>
</field>
<field>
<name>isContainer</name>
<desc>bool isContainer</desc>
</field>
<field>
<name>langTableMod</name>
<desc>string langTableMod</desc>
</field>
<field>
<name>MinExtent</name>
<desc>Point2I MinExtent</desc>
</field>
<field>
<name>Modal</name>
<desc>@deprecated This member is deprecated, which means that its value is always undefined.</desc>
</field>
<field>
<name>Position</name>
<desc>Point2I Position</desc>
</field>
<field>
<name>Profile</name>
<desc>GuiProfile Profile</desc>
</field>
<field>
<name>setFirstResponder</name>
<desc>@deprecated This member is deprecated, which means that its value is always undefined.</desc>
</field>
<field>
<name>ToolTip</name>
<desc>string ToolTip</desc>
</field>
<field>
<name>tooltipprofile</name>
<desc>GuiProfile tooltipprofile</desc>
</field>
<field>
<name>Variable</name>
<desc>string Variable</desc>
</field>
<field>
<name>VertSizing</name>
<desc>enumval VertSizing</desc>
</field>
<field>
<name>Visible</name>
<desc>bool Visible</desc>
</field>
</class>
<class>
<name>GuiControlArrayControl</name>
<base>GuiControl</base>
<field>
<name>colCount</name>
<desc>int colCount</desc>
</field>
<field>
<name>colSizes</name>
<desc>intList colSizes</desc>
</field>
<field>
<name>colSpacing</name>
<desc>int colSpacing</desc>
</field>
<field>
<name>rowSize</name>
<desc>int rowSize</desc>
</field>
<field>
<name>rowSpacing</name>
<desc>int rowSpacing</desc>
</field>
</class>
<class>
<name>GuiControlListPopUp</name>
<base>GuiPopUpMenuCtrl</base>
</class>
<class>
<name>GuiControlProfile</name>
<base>SimObject</base>
<field>
<name>autoSizeHeight</name>
<desc>bool autoSizeHeight</desc>
</field>
<field>
<name>autoSizeWidth</name>
<desc>bool autoSizeWidth</desc>
</field>
<field>
<name>bevelColorHL</name>
<desc>ColorI bevelColorHL</desc>
</field>
<field>
<name>bevelColorLL</name>
<desc>ColorI bevelColorLL</desc>
</field>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
<field>
<name>border</name>
<desc>int border</desc>
</field>
<field>
<name>borderColor</name>
<desc>ColorI borderColor</desc>
</field>
<field>
<name>borderColorHL</name>
<desc>ColorI borderColorHL</desc>
</field>
<field>
<name>borderColorNA</name>
<desc>ColorI borderColorNA</desc>
</field>
<field>
<name>borderThickness</name>
<desc>int borderThickness</desc>
</field>
<field>
<name>canKeyFocus</name>
<desc>bool canKeyFocus</desc>
</field>
<field>
<name>cursorColor</name>
<desc>ColorI cursorColor</desc>
</field>
<field>
<name>fillColor</name>
<desc>ColorI fillColor</desc>
</field>
<field>
<name>fillColorHL</name>
<desc>ColorI fillColorHL</desc>
</field>
<field>
<name>fillColorNA</name>
<desc>ColorI fillColorNA</desc>
</field>
<field>
<name>fontCharset</name>
<desc>enumval fontCharset</desc>
</field>
<field>
<name>fontColor</name>
<desc>ColorI fontColor</desc>
</field>
<field>
<name>fontColorHL</name>
<desc>ColorI fontColorHL</desc>
</field>
<field>
<name>fontColorLink</name>
<desc>ColorI fontColorLink</desc>
</field>
<field>
<name>fontColorLinkHL</name>
<desc>ColorI fontColorLinkHL</desc>
</field>
<field>
<name>fontColorNA</name>
<desc>ColorI fontColorNA</desc>
</field>
<field>
<name>fontColors</name>
<desc>ColorI fontColors</desc>
</field>
<field>
<name>fontColorSEL</name>
<desc>ColorI fontColorSEL</desc>
</field>
<field>
<name>fontSize</name>
<desc>int fontSize</desc>
</field>
<field>
<name>fontType</name>
<desc>string fontType</desc>
</field>
<field>
<name>justify</name>
<desc>enumval justify</desc>
</field>
<field>
<name>Modal</name>
<desc>bool Modal</desc>
</field>
<field>
<name>mouseOverSelected</name>
<desc>bool mouseOverSelected</desc>
</field>
<field>
<name>numbersOnly</name>
<desc>bool numbersOnly</desc>
</field>
<field>
<name>opaque</name>
<desc>bool opaque</desc>
</field>
<field>
<name>profileForChildren</name>
<desc>SimObjectPtr profileForChildren</desc>
</field>
<field>
<name>returnTab</name>
<desc>bool returnTab</desc>
</field>
<field>
<name>soundButtonDown</name>
<desc>AudioProfile soundButtonDown</desc>
</field>
<field>
<name>soundButtonOver</name>
<desc>AudioProfile soundButtonOver</desc>
</field>
<field>
<name>tab</name>
<desc>bool tab</desc>
</field>
<field>
<name>textOffset</name>
<desc>Point2I textOffset</desc>
</field>
</class>
<class>
<name>GuiCursor</name>
<base>SimObject</base>
<field>
<name>bitmapName</name>
<desc>filename bitmapName</desc>
</field>
<field>
<name>hotSpot</name>
<desc>Point2I hotSpot</desc>
</field>
<field>
<name>renderOffset</name>
<desc>Point2F renderOffset</desc>
</field>
</class>
<class>
<name>GuiDataGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>GuiDirectoryFileListCtrl</name>
<base>GuiListBoxCtrl</base>
<method>
<name>getSelectedFile</name>
<desc>@return Returns the currently selected file name</desc>
</method>
<method>
<name>getSelectedFiles</name>
<desc>@return Returns a word separated list of selected file(s)</desc>
</method>
<method>
<name>setFilter</name>
<args>[mask]</args>
<desc>Set the current GuiDirectoryFileListCtrl filter.
@param mask The filter to set (space separted values)
@return No return value
@note %obj.setFilter([mask space delimited])</desc>
</method>
<method>
<name>setPath</name>
<args>path, [filter]</args>
<desc>Directory to enumerate files from (without trailing slash)
@param path The path of the directory.
@param filter Optional filter
@return Returns true on success, false otherwise.</desc>
</method>
</class>
<class>
<name>GuiDirectoryTreeCtrl</name>
<base>GuiControl</base>
</class>
<class>
<name>GuiDragAndDropControl</name>
<base>GuiControl</base>
<method>
<name>startDragging</name>
<args> int x, int y </args>
<desc>@param x X coordinate relative to the point on the object on which you are clicking
@param y Y coordinate relative to the point on the object on which you are clicking
@note If no point is passed, or only one coordinate is passed, the method defaults to (0,0)</desc>
</method>
<field>
<name>deleteOnMouseUp</name>
<desc>bool deleteOnMouseUp</desc>
</field>
</class>
<class>
<name>GuiDynamicCtrlArrayControl</name>
<base>GuiControl</base>
<method>
<name>refresh</name>
<desc>Forces the child controls to recalculate</desc>
</method>
<field>
<name>colCount</name>
<desc>int colCount</desc>
</field>
<field>
<name>colSize</name>
<desc>int colSize</desc>
</field>
<field>
<name>colSpacing</name>
<desc>int colSpacing</desc>
</field>
<field>
<name>rowSize</name>
<desc>int rowSize</desc>
</field>
<field>
<name>rowSpacing</name>
<desc>int rowSpacing</desc>
</field>
</class>
<class>
<name>GuiEditCtrl</name>
<base>GuiControl</base>
<method>
<name>addNewCtrl</name>
<args>GuiControl ctrl</args>
<desc>Adds the given control to the control list
@return No return value.</desc>
</method>
<method>
<name>addSelection</name>
<args>ctrlID</args>
<desc>Adds the selected control.
@return No return value.</desc>
</method>
<method>
<name>bringToFront</name>
<desc>Brings control to front
@return No return value.</desc>
</method>
<method>
<name>clearSelection</name>
<desc>Clear selected controls list.
@return No return value.</desc>
</method>
<method>
<name>deleteSelection</name>
<desc>Delete the selected text.
@return No return value.</desc>
</method>
<method>
<name>getCurrentAddSet</name>
<desc>@return Returns the set to which new controls will be added</desc>
</method>
<method>
<name>getSelected</name>
<desc>Gets the GUI control(s) the editor is currently selecting
@return Returns the ID of the control.</desc>
</method>
<method>
<name>getTrash</name>
<desc>Gets the GUI controls(s) that are currently in the trash.
@return Returns the ID of the control</desc>
</method>
<method>
<name>getUndoManager</name>
<desc>Gets the Gui Editor's UndoManager object
@return Returns the ID of the object.</desc>
</method>
<method>
<name>justify</name>
<args>int mode</args>
<desc>Sets justification mode of selection
@return No return value.</desc>
</method>
<method>
<name>loadSelection</name>
<args>string fileName</args>
<desc>Loads from given filename
@return No return value.</desc>
</method>
<method>
<name>moveSelection</name>
<args>int deltax, int deltay</args>
<desc>Moves selection to given (relative to current position) point
@param deltax,deltay The change in coordinates.
@return No return value.</desc>
</method>
<method>
<name>pushToBack</name>
<desc>Sends control to back
@return No return value.</desc>
</method>
<method>
<name>removeSelection</name>
<args>ctrlID</args>
<desc>Removes the selected control from list.
@return No return value.</desc>
</method>
<method>
<name>saveSelection</name>
<args>string fileName</args>
<desc>Saves the current selection to given filename
@return No return value.</desc>
</method>
<method>
<name>select</name>
<args>GuiControl ctrl</args>
<desc>Finds and selects given object
@return No return value.</desc>
</method>
<method>
<name>selectAll</name>
<desc>Selects all controls in list
@return No return value.</desc>
</method>
<method>
<name>setCurrentAddSet</name>
<args>GuiControl ctrl</args>
<desc>Set the current control set in which controls are added.
@param ctrl The addset
@return No return value.</desc>
</method>
<method>
<name>setRoot</name>
<args>GuiControl root</args>
<desc>Sets the given control as root
@return No return value.</desc>
</method>
<method>
<name>setSnapToGrid</name>
<args>gridsize</args>
<desc>Set the size of the snap-to grid.
@return No return value.</desc>
</method>
<method>
<name>toggle</name>
<desc>Toggle activation.
@return No return value.</desc>
</method>
</class>
<class>
<name>GuiEditorRuler</name>
<base>GuiControl</base>
<field>
<name>refCtrl</name>
<desc>string refCtrl</desc>
</field>
</class>
<class>
<name>GuiEffectCanvas</name>
<base>GuiCanvas</base>
</class>
<class>
<name>GuiFadeinBitmapCtrl</name>
<base>GuiBitmapCtrl</base>
<field>
<name>done</name>
<desc>bool done</desc>
</field>
<field>
<name>fadeinTime</name>
<desc>int fadeinTime</desc>
</field>
<field>
<name>fadeoutTime</name>
<desc>int fadeoutTime</desc>
</field>
<field>
<name>waitTime</name>
<desc>int waitTime</desc>
</field>
</class>
<class>
<name>GuiFilterCtrl</name>
<base>GuiControl</base>
<method>
<name>getValue</name>
<desc>Use the getValue method to get all the values in the filter.
@return Returns a n-tuple floating-point vector of values for each knot (left to right)</desc>
</method>
<method>
<name>identity</name>
<desc>Resets the filter and places all knots on a line following a 45 degree angle from 0.0 (bottom) on the left to 1.0 (top) on the right.
@return No return value</desc>
</method>
<method>
<name>setValue</name>
<args> knots </args>
<desc>Sets the knot value for each knot by position.
@param knots a vector containing the knot positions for each knot. Each knot has a value between 0.0 and 1.0.
@return No return value</desc>
</method>
<field>
<name>controlPoints</name>
<desc>int controlPoints</desc>
</field>
<field>
<name>filter</name>
<desc>floatList filter</desc>
</field>
</class>
<class>
<name>GuiFormCtrl</name>
<base>GuiControl</base>
<method>
<name>getMenuID</name>
<desc>Returns the ID of the Form Menu</desc>
</method>
<method>
<name>setCaption</name>
<args>caption</args>
<desc>- Sets the title of the Form Menu</desc>
</method>
<field>
<name>Caption</name>
<desc>string Caption</desc>
</field>
<field>
<name>Content</name>
<desc>string Content</desc>
</field>
<field>
<name>ContentLibrary</name>
<desc>string ContentLibrary</desc>
</field>
<field>
<name>HasMenu</name>
<desc>bool HasMenu</desc>
</field>
<field>
<name>Movable</name>
<desc>bool Movable</desc>
</field>
</class>
<class>
<name>GuiFrameSetCtrl</name>
<base>GuiControl</base>
<method>
<name>addColumn</name>
<desc>Use the addColumn method to add another column to the control.
The current contents of the GUIFrameCtrl may shift to fill the new column. New columns are added on the right of the control.
@return No return value.
@sa addRow, removeColumn, removeRow</desc>
</method>
<method>
<name>addRow</name>
<desc>Use the addRow method to add another row to the control.
The current contents of the GUIFrameCtrl may shift to fill the new row. New rows are added on the bottom of the control.
@return No return value.
@sa addColumn, removeColumn, removeRow</desc>
</method>
<method>
<name>frameBorder</name>
<args> index [ , enable = true ] </args>
<desc>Use the frameBorder method to change the frame's enable state.
This function is not working as of this writing
@param index Frame index to enable/disable/enable – Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.
@return No return value.</desc>
</method>
<method>
<name>frameMinExtent</name>
<args>index, w, h </args>
<desc>Use the frameMinExtent method to set the minimum extent allowed for a frame.
These minimum extents do not prevent a parent control from collapsing the frame control and its frames. These limits apply to dragging and resizing as is done with the frames' draggable borders
@param index The frame number.
@param w Minimum width in pixels.
@param h Minimum height in pixels.
@return No return value.</desc>
</method>
<method>
<name>frameMovable</name>
<args> index [ , enable = true ] </args>
<desc>Use the frameMovable method to change the frame's draggable state.
This function is not working as of this writing
@param index Frame index to enable/disable/enable – Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.
@return No return value.</desc>
</method>
<method>
<name>getColumnCount</name>
<desc>Use the getColumnCount method to determine the number of columns in this control.
@return Returns an integer value equal to the number of columns in this frame.
@sa getRowCount</desc>
</method>
<method>
<name>getColumnOffset</name>
<args> column </args>
<desc>Use the getColumnOffset method to determine the current pixel location of the specified column.
Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc.
@param column An integer value specifying the column to examine.
@return Returns the pixel offset for the specified column.
@sa getRowOffset, setColumnOffset, setRowOffset</desc>
</method>
<method>
<name>getRowCount</name>
<desc>Use the getRowCount method to determine the number of rows in this control.
@return Returns an integer value equal to the number of rows in this frame.
@sa getColumnCount</desc>
</method>
<method>
<name>getRowOffset</name>
<args> row </args>
<desc>Use the getRowOffset method to determine the current pixel location of the specified row.
Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc.
@param row An integer value specifying the row to examine.
@return Returns the pixel offset for the specified row.
@sa getColumnOffset, setColumnOffset, setRowOffset</desc>
</method>
<method>
<name>removeColumn</name>
<desc>Use the removeColumn method to remove a column from the right side of the control.
Columns are removed right to left.
@return No return value.
@sa addColumn, addRow, removeRow</desc>
</method>
<method>
<name>removeRow</name>
<desc>Use the removeRow method to remove the bottom row from the control.
Rows are removed bottom to top.
@return No return value.
@sa addColumn, addRow, removeColumn</desc>
</method>
<method>
<name>setColumnOffset</name>
<args> column , offset </args>
<desc>Use the setColumnOffset method to determine the current pixel location of the specified column.
Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc. The left-most and right-most columns cannot be moved.
@param column An integer value specifying the column to examine.
@param offset An integer value specifying the new column offset in pixels.
@return No return value.
@sa getColumnOffset, getRowOffset, setRowOffset</desc>
</method>
<method>
<name>setRowOffset</name>
<args> row , offset </args>
<desc>Use the setRowOffset method to set the current pixel location of the specified row.
Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc. The bottom-most and top-most rows cannot be moved.
@param row An integer value specifying the row to modify.
@param offset An integer value specifying the new row offset in pixels.
@return No return value.
@sa getColumnOffset, getRowOffset, setColumnOffset</desc>
</method>
<field>
<name>autoBalance</name>
<desc>bool autoBalance</desc>
</field>
<field>
<name>borderColor</name>
<desc>ColorI borderColor</desc>
</field>
<field>
<name>borderEnable</name>
<desc>enumval borderEnable</desc>
</field>
<field>
<name>borderMovable</name>
<desc>enumval borderMovable</desc>
</field>
<field>
<name>borderWidth</name>
<desc>int borderWidth</desc>
</field>
<field>
<name>columns</name>
<desc>intList columns</desc>
</field>
<field>
<name>fudgeFactor</name>
<desc>int fudgeFactor</desc>
</field>
<field>
<name>rows</name>
<desc>intList rows</desc>
</field>
</class>
<class>
<name>GuiGraphCtrl</name>
<base>GuiControl</base>
<method>
<name>addAutoPlot</name>
<args>int plotID, string variable, int update</args>
<desc>Adds a data point with value variable, every update ms.
@return No return value.</desc>
</method>
<method>
<name>addDatum</name>
<args>int plotID, float v</args>
<desc>Add a data point to the given plot.
@return No return value.</desc>
</method>
<method>
<name>getDatum</name>
<args>int plotID, int samples</args>
<desc>Get a data point from the plot specified, samples from the start of the graph.
@return Returns the data point from the plot.</desc>
</method>
<method>
<name>matchScale</name>
<args>int plotID, int plotID, ...</args>
<desc>Sets the scale of all specified plots to the maximum scale among them.
@return No return value.</desc>
</method>
<method>
<name>removeAutoPlot</name>
<args>int plotID</args>
<desc>Stops automatic pointing over set interval.
@return No return value.</desc>
</method>
<method>
<name>setGraphType</name>
<args>int plotID, string graphType</args>
<desc>Change GraphType of plot plotID.
@return No return value.</desc>
</method>
</class>
<class>
<name>GuiGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>GuiIconButtonCtrl</name>
<base>GuiButtonCtrl</base>
<method>
<name>setBitmap</name>
<args>filepath name</args>
<desc>Loads bitmap from file
@param name The path of the desired bitmap file
@return No Return Value.</desc>
</method>
<field>
<name>buttonMargin</name>
<desc>Point2I buttonMargin</desc>
</field>
<field>
<name>iconBitmap</name>
<desc>filename iconBitmap</desc>
</field>
<field>
<name>iconLocation</name>
<desc>enumval iconLocation</desc>
</field>
<field>
<name>sizeIconToButton</name>
<desc>bool sizeIconToButton</desc>
</field>
<field>
<name>textLocation</name>
<desc>enumval textLocation</desc>
</field>
<field>
<name>textMargin</name>
<desc>int textMargin</desc>
</field>
</class>
<class>
<name>GuiImageList</name>
<base>SimObject</base>
<method>
<name>clear</name>
<desc>Clears the imagelist
@return Returns true on success, and false otherwise</desc>
</method>
<method>
<name>count</name>
<desc>Gets the number of images in the list
@return Return number of images as an integer</desc>
</method>
<method>
<name>getImage</name>
<args>int index</args>
<desc>Get a path to the texture at the specified index
@param index The index of the desired image
@return The ID of the image or -1 on failure</desc>
</method>
<method>
<name>getIndex</name>
<args>char* path</args>
<desc>Retrieves the imageindex of a specified texture in the list
@param path Thge path of the image file to retrieve the indexs of
@return The index of the image as an integer or -1 for failure</desc>
</method>
<method>
<name>insert</name>
<args>image path</args>
<desc>Insert an image into imagelist
@param path The path of the image file
@return returns the image index or -1 for failure</desc>
</method>
<method>
<name>remove</name>
<args>index</args>
<desc>Removes an image from the list by index
@param index The index of the image to remove
@return Returns true on success, false otherwise</desc>
</method>
</class>
<class>
<name>GuiInputCtrl</name>
<base>GuiControl</base>
</class>
<class>
<name>GuiInspector</name>
<base>GuiStackControl</base>
<method>
<name>getInspectObject</name>
<desc>- Returns currently inspected object
@return The Object's ID as a string.</desc>
</method>
<method>
<name>inspect</name>
<args>obj</args>
<desc>Goes through the object's fields and autogenerates editor boxes
@return No return value.</desc>
</method>
<method>
<name>setName</name>
<args>NewObjectName</args>
<desc>Set object name.
@return No return value.</desc>
</method>
</class>
<class>
<name>GuiInspectorDatablockField</name>
<base>GuiInspectorField</base>
</class>
<class>
<name>GuiInspectorDynamicField</name>
<base>GuiInspectorField</base>
<method>
<name>renameField</name>
<args>newDynamicFieldName</args>
</method>
</class>
<class>
<name>GuiInspectorDynamicGroup</name>
<base>GuiInspectorGroup</base>
<method>
<name>addDynamicField</name>
</method>
<method>
<name>inspectGroup</name>
<desc>Refreshes the dynamic fields in the inspector.
@return Returns true on success.</desc>
</method>
</class>
<class>
<name>GuiInspectorField</name>
<base>GuiControl</base>
<method>
<name>apply</name>
<args>newValue</args>
<desc>Applies the given value to the field
@return No return value.</desc>
</method>
</class>
<class>
<name>GuiInspectorGroup</name>
<base>GuiRolloutCtrl</base>
</class>
<class>
<name>GuiInspectorTypeCheckBox</name>
<base>GuiInspectorField</base>
</class>
<class>
<name>GuiInspectorTypeColor</name>
<base>GuiInspectorField</base>
</class>
<class>
<name>GuiInspectorTypeColorF</name>
<base>GuiInspectorTypeColor</base>
</class>
<class>
<name>GuiInspectorTypeColorI</name>
<base>GuiInspectorTypeColor</base>
</class>
<class>
<name>GuiInspectorTypeEnum</name>
<base>GuiInspectorField</base>
</class>
<class>
<name>GuiInspectorTypeFileName</name>
<base>GuiInspectorField</base>
</class>
<class>
<name>GuiInspectorTypeGuiProfile</name>
<base>GuiInspectorTypeEnum</base>
</class>
<class>
<name>GuiListBoxCtrl</name>
<base>GuiControl</base>
<method>
<name>addItem</name>
<args>text, [color]</args>
<desc>Adds an item to the end of the list with an optional color
@param text The object text.
@param color Optional color setting.
@return No return value.</desc>
</method>
<method>
<name>clearItemColor</name>
<args>index</args>
<desc>Clears the color of the item at index.
@param index The index of the item to modify.
@return No return value.</desc>
</method>
<method>
<name>clearItems</name>
<desc>Clears all the items in the listbox
@return No return value.</desc>
</method>
<method>
<name>clearSelection</name>
<desc>Sets all currently selected items to unselected
@return No return value.</desc>
</method>
<method>
<name>deleteItem</name>
<args>index</args>
<desc>Deletes the item at the given index.
@param index The index of the item to delete.
@return No return value.</desc>
</method>
<method>
<name>findItemText</name>
<args>string itemText, bool caseSensitive</args>
<desc>Find the item with the given text.
@param itemText The text to search for.
@param caseSensitive Sets whether or not to ignore text in the search.
@return Returns index of item with matching text or -1 if none@note %listBox.findItemText( myItemText, [?caseSensitive - false] )</desc>
</method>
<method>
<name>getItemCount</name>
<desc>@return Returns the number of items in the list</desc>
</method>
<method>
<name>getItemText</name>
<args>index</args>
<desc>@return Returns the text of the item at the specified index</desc>
</method>
<method>
<name>getSelCount</name>
<desc>@return Returns the number of items currently selected</desc>
</method>
<method>
<name>getSelectedItem</name>
<desc>@return Returns the selected items index or -1 if none. If multiple selections exist it returns the first selected item</desc>
</method>
<method>
<name>getSelectedItems</name>
<desc>@return Returns a space delimited list of the selected items indexes in the list</desc>
</method>
<method>
<name>insertItem</name>
<args> text, index </args>
<desc>Inserts an item into the list at the specified index.
@param text The desired object text.
@param index The index to set the object at.
@return Returns the index assigned or -1 on error</desc>
</method>
<method>
<name>setCurSel</name>
<args>index</args>
<desc>Sets the currently selected item at the specified index
@return No return value.</desc>
</method>
<method>
<name>setCurSelRange</name>
<args>start,[stop]</args>
<desc>Sets the current selection range fromindex start to stop.
@param start The start of the selection range.
@param stop The stopping point of the selection range. If no stop is specified it sets from start index to the end of the list
@return No return value.</desc>
</method>
<method>
<name>setItemColor</name>
<args>index, color</args>
<desc>Sets the color of the item at given index.
@param index The index of the item you wish to modify.
@param color The color you wish to set the object to.
@return No return value.</desc>
</method>
<method>
<name>setItemText</name>
<args>index, newtext</args>
<desc>Sets the item's text at the specified index
@param index The index of the item to modify.
@param newtext The new text to set to the object.
@return No return value.</desc>
</method>
<method>
<name>setMultipleSelection</name>
<args>bool setMS</args>
<desc>Set the MultipleSelection field.
@return No return value.
@note %listBox.setMultipleSelection([true/false])</desc>
</method>
<method>
<name>setSelected</name>
<args>S32 index, bool setting</args>
<desc>Sets the item at the index specified to selected or not@param index The index of the item you wish to modify.
@param setting A boolean value. True sets it as selected; false, not selected.
@return No return value.</desc>
</method>
<field>
<name>AllowMultipleSelections</name>
<desc>bool AllowMultipleSelections</desc>
</field>
<field>
<name>fitParentWidth</name>
<desc>bool fitParentWidth</desc>
</field>
</class>
<class>
<name>GuiMenuBar</name>
<base>GuiTickCtrl</base>
<method>
<name>addMenu</name>
<args> menuName , menuID </args>
<desc>Adds a new menu to the menu bar.
@param menuName The text (name) of the new menu entry.
@param menuID The ID of the new menu entry.
@return No return value</desc>
</method>
<method>
<name>addMenuItem</name>
<args> menuID | menuName , menuItemName , menuItemID , [ accelerator ] , [ checkGroup ] </args>
<desc>Adds a sub-menu entry to the specified menu.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param accelerator A boolean value. If set to true, the sub-menu entry is checked, otherwise it is unchecked.
@param checkGroup The check group this item should belong to, if any.
@return No return value</desc>
</method>
<method>
<name>addSubmenuItem</name>
<args>string menu, string menuItem, string submenuItemText, int submenuItemId, string accelerator = NULL, int checkGroup = -1</args>
<desc>Adds a menu item to the specified menu.  The menu argument can be either the text of a menu or its id.</desc>
</method>
<method>
<name>clearMenuItems</name>
<args> menuID | menuName </args>
<desc>Removes all the sub-menu items from the specified menu.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@return No return value</desc>
</method>
<method>
<name>clearMenus</name>
<desc>Clears all menus and sub-menus from the menu bar.
@return No return value</desc>
</method>
<method>
<name>clearSubmenuItems</name>
<args>string menu, string menuItem</args>
<desc>Removes all the menu items from the specified submenu.
@return No return value.</desc>
</method>
<method>
<name>removeMenu</name>
<args> menuID | menuName </args>
<desc>Removes the specified menu from the menu bar.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param checked A boolean value. If set to true, the sub-menu entry is checked, otherwise it is unchecked.
@return No return value</desc>
</method>
<method>
<name>removeMenuItem</name>
<args> menuID | menuName , menuItemID | menuItemName </args>
<desc>Removes the specified menu item from the menu.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@return No return value</desc>
</method>
<method>
<name>setCheckmarkBitmapIndex</name>
<args>S32 bitmapindex</args>
<desc>- sets the menu bitmap index for the check mark image.
@return No Return Value.</desc>
</method>
<method>
<name>setMenuBitmapIndex</name>
<args>string menu, S32 bitmapindex, bool bitmaponly, bool drawborder</args>
<desc>Sets the bitmap index for the menu and toggles rendering only the bitmap.
@return No return value.</desc>
</method>
<method>
<name>setMenuItemBitmap</name>
<args> menuID | menuName , menuItemID | menuItemName , bitmapIndex </args>
<desc>Sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param bitMapIndex An integer value specifying the row of bitmap entries to use for sub-menu entry.
@return No return value</desc>
</method>
<method>
<name>setMenuItemChecked</name>
<args> menuID | menuName , menuItemID | menuItemName , checked </args>
<desc>Sets the menu item bitmap to a check mark, which must be the first element in the bitmap array. Any other menu items in the menu with the same check group become unchecked if they are checked.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param checked A boolean value. If set to true, the sub-menu entry is checked, otherwise it is unchecked.
@return No return value</desc>
</method>
<method>
<name>setMenuItemEnable</name>
<args> menuID | menuName , menuItemID | menuItemName , enabled </args>
<desc>Sets the menu item to enabled or disabled.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param enabled A boolean value. If set to true, the sub-menu entry is enabled, otherwise it is disabled.
@return No return value</desc>
</method>
<method>
<name>setMenuItemSubmenuState</name>
<args>string menu, string menuItem, bool isSubmenu</args>
<desc>Sets the given menu item to be a submenu
@param menu The menu where the sub menu is located.
@param menuItem The menu item to set as a sub menu.
@param inSubmenu A boolean value signifying whether or not it is a submenu.
@return No return value.</desc>
</method>
<method>
<name>setMenuItemText</name>
<args> menuID | menuName , menuItemID | menuItemName , newMenuItemText </args>
<desc>Sets the text of the specified menu item to the new string.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param newMenuItemText The new text for the specified sub-menu entry.
@return No return value</desc>
</method>
<method>
<name>setMenuItemVisible</name>
<args> menuID | menuName, menuItemID | menuItemName, visible </args>
<desc>Use the setMenuItemVisible method to enable or disable the visibility of a specific sub-menu entry.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param menuItemID The ID of the menu item.
@param menuItemName The text (name) of the menu item.
@param visible A boolean value. If set to true, this sub-menu entry will be shown, otherwise it will be hidden.
@return No return value</desc>
</method>
<method>
<name>setMenuMargins</name>
<args>S32 horizontalMargin, S32 verticalMargin, S32 bitmapToTextSpacing</args>
<desc>Sets the menu rendering margins: horizontal, vertical, bitmap spacing.</desc>
</method>
<method>
<name>setMenuText</name>
<args> menuID | menuName , newMenuText </args>
<desc>Sets the text of the specified menu to the new string.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param newMenuText The new text to give the menu entry.
@return No return value</desc>
</method>
<method>
<name>setMenuVisible</name>
<args> menuID | menuName , visible </args>
<desc>Use the setMenuVisible method to enable or disable the visibility of a specific menu entry.
@param menuID The ID of the menu.
@param menuName The text (name) of the menu.
@param visible A boolean value. If set to true, this menu entry will be shown, otherwise it will be hidden.
@return No return value</desc>
</method>
<method>
<name>setSubmenuItemChecked</name>
<args>string menu, string menuItem, string submenuItemText, bool checked</args>
<desc>Sets the menu item bitmap to a check mark, which by default is the first element in the bitmap array (although this may be changed with setCheckmarkBitmapIndex()).  Any other menu items in the menu with the same check group become unchecked if they are checked.</desc>
</method>
<field>
<name>Padding</name>
<desc>int Padding</desc>
</field>
</class>
<class>
<name>GuiMessageVectorCtrl</name>
<base>GuiControl</base>
<method>
<name>attach</name>
<args> aVector </args>
<desc>Make this gui control display messages from the specified MessageVector.
@param aVector A previously created messageVector instance.
@return No return value</desc>
</method>
<method>
<name>detach</name>
<desc>Stop listening to messages from the MessageVector this control was previously attached to.
@return No return value</desc>
</method>
<field>
<name>allowedMatches</name>
<desc>string allowedMatches</desc>
</field>
<field>
<name>lineContinuedIndex</name>
<desc>int lineContinuedIndex</desc>
</field>
<field>
<name>lineSpacing</name>
<desc>int lineSpacing</desc>
</field>
<field>
<name>matchColor</name>
<desc>ColorI matchColor</desc>
</field>
<field>
<name>maxColorIndex</name>
<desc>int maxColorIndex</desc>
</field>
</class>
<class>
<name>GuiMLTextCtrl</name>
<base>GuiControl</base>
<method>
<name>addText</name>
<args> text , reformat </args>
<desc>Use the addText method to add new text to the control. You may optionally request that the control be reformatted.
@param text Text to add to control.
@param reformat A boolean value that when set to true forces the control to re-evaluate the entire contents and to redisplay it.
@return No return value.
@sa getText, setText, forceReflow</desc>
</method>
<method>
<name>forceReflow</name>
<desc>Use the forceReflow method to force the text control to re-evaluate the entire contents and to redisplay it, possibly resizing the control.
@return No return value.
@sa addText</desc>
</method>
<method>
<name>getText</name>
<desc>Use the getText method to return the current text contents of the control, including all formatting characters.
@return Returns the entire text contents of the control or “” indicating no contents.
@sa addText</desc>
</method>
<method>
<name>scrollToBottom</name>
<desc>Use the scrollToBottom method to scroll to the bottom of the text.
@return No return value.
@sa scrollToTag, setCursorPosition, scrollToTop</desc>
</method>
<method>
<name>scrollToTag</name>
<args> tagID </args>
<desc>Use the scrollToTag method to scroll to the first instance of a tag if it exists.
@param tagID A tag number to search for. These tags are specified by embedding TorqueML &lt;tag:tag_number&gt; entries in text.
@return No return value.
@sa scrollToTop, setCursorPosition</desc>
</method>
<method>
<name>scrollToTop</name>
<desc>Use the scrollToTop method to scroll to the top of the text.
@return No return value.
@sa scrollToTag, setCursorPosition, scrollToBottom</desc>
</method>
<method>
<name>setAlpha</name>
<args> alpha </args>
<desc>Use the setAlpha method to set alpha of this control to between [0.0 , 1.0].
@param alpha A floating point value between 0.0 and 1.0 indicating the control's new alpha setting.
@return No return value</desc>
</method>
<method>
<name>setCursorPosition</name>
<args>newPos</args>
<desc>Use the setCursorPosition method to offset the cursor by newPos characters into the current text contents of the control.
@param newPos An integer value indicating the character position at which to place the cursor.
@return No return value.
@sa scrollToTag, scrollToTop</desc>
</method>
<method>
<name>setText</name>
<args>text</args>
<desc>Use the setText method to change the current text content of the control to text. This replaces all old content.
@param text The new contents for this control.
@return No return value.
@sa addText, getText</desc>
</method>
<field>
<name>allowColorChars</name>
<desc>bool allowColorChars</desc>
</field>
<field>
<name>deniedSound</name>
<desc>AudioProfile deniedSound</desc>
</field>
<field>
<name>lineSpacing</name>
<desc>int lineSpacing</desc>
</field>
<field>
<name>maxChars</name>
<desc>int maxChars</desc>
</field>
<field>
<name>text</name>
<desc>caseString text</desc>
</field>
</class>
<class>
<name>GuiMLTextEditCtrl</name>
<base>GuiMLTextCtrl</base>
<field>
<name>escapeCommand</name>
<desc>string escapeCommand</desc>
</field>
</class>
<class>
<name>GuiMouseEventCtrl</name>
<base>GuiControl</base>
<field>
<name>lockMouse</name>
<desc>bool lockMouse</desc>
</field>
</class>
<class>
<name>GuiPaneControl</name>
<base>GuiControl</base>
<method>
<name>setCollapsed</name>
<args>bool collapsed</args>
<desc>Sets the controls "collapsed" property
@param collapsed True if the control is to be collapsed@return No return value.</desc>
</method>
<field>
<name>barBehindText</name>
<desc>bool barBehindText</desc>
</field>
<field>
<name>Caption</name>
<desc>string Caption</desc>
</field>
<field>
<name>captionID</name>
<desc>string captionID</desc>
</field>
<field>
<name>collapsable</name>
<desc>bool collapsable</desc>
</field>
</class>
<class>
<name>GuiPopUpMenuCtrl</name>
<base>GuiTextCtrl</base>
<method>
<name>add</name>
<args> entryText , entryID [ , entryScheme ] </args>
<desc>Use the add method to add a new entry with text entryText, ID entryID, and using the scheme entryScheme.
@param entryText Text to display in menu entry.
@param entryID ID to assign to entry. This value may be 1 or greater.
@param entryScheme An integer value representing the ID of an optional color scheme to be used for this entry.
@return No return value.
@sa addScheme, clear</desc>
</method>
<method>
<name>addScheme</name>
<args> entryScheme , fontColor , fontColorHL , fontColorSEL </args>
<desc>Use the addScheme method to create a new color scheme or to modify an existing one.
An integer color vector contains three integer values, each between 0 and 255 and is organized in this order: “R G B”.
@param entryScheme An integer value representing the ID of the scheme, between 1 and inf.
@param fontColor A vector containing an integer representation of the menu entry's normal color.
@param fontColorHL A vector containing an integer representation of the menu entry's highlighted color.
@param fontColorSEL A vector containing an integer representation of the menu entry's selected color.
@return No return value.
@sa add</desc>
</method>
<method>
<name>clear</name>
<desc>Use the clear method to remove all entries and schemes from the menu.
@return No return value.
@sa add, addScheme</desc>
</method>
<method>
<name>findText</name>
<args> text </args>
<desc>Use the findText method to locate the string text in the list of menu items. It will return the ID of the first entry found.
This is an exact match, so if the menu item is “Gish” and you search for “Gis”, or “gish', or any other variation that does not match the entire menu item and the case of each letter, the search will not find a match
@param text A string containing the text to search for.
@return Returns an integer value representing the ID of the menu item, or -1 if the text was not found.</desc>
</method>
<method>
<name>forceClose</name>
<desc>Use the forceClose method to force the menu to close.
This is useful for making menus that fold up after a short delay when the mouse leaves the menu area.
@return No return value.
@sa forceOnAction</desc>
</method>
<method>
<name>forceOnAction</name>
<desc>Use the forceOnAction method to force the onAction callback to be triggered.
@return No return value.
@sa forceClose, onAction (GUIControl callback)</desc>
</method>
<method>
<name>getSelected</name>
<desc>Use the getSelected method to get the ID of the last selected entry.
@return Returns the ID of the currently selected entry, or 0 meaning no menu was selected after the last menu open.</desc>
</method>
<method>
<name>getText</name>
<desc>Use the getText method to get the text currently displayed in the menu bar.
@return Returns the text in the menu bar or “” if no text is present.
@sa getSelected, setText</desc>
</method>
<method>
<name>getTextById</name>
<args> ID </args>
<desc>Use the getTextById method to get the text value for the menu item represented by ID.
@param ID An integer value representing the ID of a menu item.
@return Returns a string containing the menu item corresponding to ID, or a NULL string (“”) if no menu item has the specified ID.
@sa add, getText</desc>
</method>
<method>
<name>replaceText</name>
<args> enable </args>
<desc>Use the replaceText method to enable the updating of the menu bar text when a menu item is selected.
This does not prevent changing the menu bar text with setText.
@param enable A boolean value enabling or disabling the automatic updating of the menu bar text when a selection is made.
@return No return value.
@sa getText, setText</desc>
</method>
<method>
<name>setEnumContent</name>
<args>string class, string enum</args>
<desc>This fills the popup with a classrep's field enumeration type info.

More of a helper function than anything.   If console access to the field list is added, at least for the enumerated types, then this should go away..@param className The class name associated with this enum content.
@param enumName The name of the enumerated entry to add to the menu. This value must match an enum string as exposed by the engine for the class. The menu item will have the same text as the enum string name, and the ID will be equal to the enumerated entries value.
@return No return value</desc>
</method>
<method>
<name>setFirstSelected</name>
<desc>@return No return value.</desc>
</method>
<method>
<name>setNoneSelected</name>
<desc>Deselects all popup menu controls
@return No return value.</desc>
</method>
<method>
<name>setSelected</name>
<args>int id, [scriptCallback=true]</args>
<desc>Set the object status as selected
@param id The object's ID.
@param scriptCallback Flag whether to notify
@return No return value.</desc>
</method>
<method>
<name>setText</name>
<args> text </args>
<desc>Use the setText method to change the text displayed in the menu bar.
Pass the NULL string (“”) to clear the menu bar text.
@param text New text to display in the menu bar.
@return No return value.
@sa getText, replaceText</desc>
</method>
<method>
<name>size</name>
<desc>Get the size of the menu, ie the number of entries in it.
@return The numbers of entries as an integer.</desc>
</method>
<method>
<name>sort</name>
<desc>Use the sort method to sort the menu in ascending order.
This is a lexicographic sort, so number (1,2,3,...) will come before letters (a,b,c,...)
@return No return value.</desc>
</method>
<method>
<name>sortID</name>
<desc>Sort the list by ID.
@return No return value.</desc>
</method>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
<field>
<name>bitmapBounds</name>
<desc>Point2I bitmapBounds</desc>
</field>
<field>
<name>maxPopupHeight</name>
<desc>int maxPopupHeight</desc>
</field>
<field>
<name>reverseTextList</name>
<desc>bool reverseTextList</desc>
</field>
<field>
<name>sbUsesNAColor</name>
<desc>bool sbUsesNAColor</desc>
</field>
</class>
<class>
<name>GuiPopUpMenuCtrlEx</name>
<base>GuiTextCtrl</base>
<method>
<name>add</name>
<args>string name, int idNum, int scheme=0</args>
<desc>Adds a new pop up menu control
@param name The control's name
@param idNum The control's ID
@param scheme The selected scheme (default 0)
@return No Return Value</desc>
</method>
<method>
<name>addCategory</name>
<args>string text</args>
<desc>Adds the given category to the list
@param text The category to add
@return No return value.</desc>
</method>
<method>
<name>addScheme</name>
<args>int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL</args>
<desc>Adds the defined scheme
@param id The object id of the scheme.
@param fontcolor The desired color of the font.
@param fontColorHL The desired color on highlight.
@param fontColorSEL The desired color on select.
@return No return value.</desc>
</method>
<method>
<name>clear</name>
<desc>Clear the popup list.
@return No return value.</desc>
</method>
<method>
<name>findText</name>
<args>string text</args>
<desc>Returns the position of the first entry containing the specified text.</desc>
</method>
<method>
<name>forceClose</name>
</method>
<method>
<name>forceOnAction</name>
</method>
<method>
<name>getSelected</name>
</method>
<method>
<name>getText</name>
<desc>@return Returns the control's text</desc>
</method>
<method>
<name>getTextById</name>
<args>int id</args>
</method>
<method>
<name>replaceText</name>
<args>bool doReplaceText</args>
</method>
<method>
<name>setEnumContent</name>
<args>string class, string enum</args>
<desc>This fills the popup with a classrep's field enumeration type info.

More of a helper function than anything.   If console access to the field list is added, at least for the enumerated types, then this should go away..</desc>
</method>
<method>
<name>setFirstSelected</name>
</method>
<method>
<name>setNoneSelected</name>
</method>
<method>
<name>setSelected</name>
<args>int id</args>
</method>
<method>
<name>setText</name>
<args>string text</args>
<desc>Set control text to given string.
@param text The desired text.
@return No return vlaue.</desc>
</method>
<method>
<name>size</name>
<desc>Get the size of the menu - the number of entries in it.</desc>
</method>
<method>
<name>sort</name>
<desc>Sort the list alphabetically.
@return No return value.</desc>
</method>
<method>
<name>sortID</name>
<desc>Sort the list by ID.
@return No return value.</desc>
</method>
<field>
<name>bitmap</name>
<desc>filename bitmap</desc>
</field>
<field>
<name>bitmapBounds</name>
<desc>Point2I bitmapBounds</desc>
</field>
<field>
<name>hotTrackCallback</name>
<desc>Whether to provide a 'onHotTrackItem' callback when a list item is hovered over</desc>
</field>
<field>
<name>maxPopupHeight</name>
<desc>int maxPopupHeight</desc>
</field>
<field>
<name>reverseTextList</name>
<desc>bool reverseTextList</desc>
</field>
<field>
<name>sbUsesNAColor</name>
<desc>bool sbUsesNAColor</desc>
</field>
</class>
<class>
<name>GuiProgressCtrl</name>
<base>GuiTextCtrl</base>
</class>
<class>
<name>GuiRadioCtrl</name>
<base>GuiCheckBoxCtrl</base>
</class>
<class>
<name>GuiRolloutCtrl</name>
<base>GuiControl</base>
<method>
<name>collapse</name>
<desc>Collapses control.
@return No return value.</desc>
</method>
<method>
<name>expand</name>
<desc>Expands control
@return No return value.</desc>
</method>
<method>
<name>instantCollapse</name>
<desc>Collapses control without animation.
@return No return value.</desc>
</method>
<method>
<name>instantExpand</name>
<desc>Expands control without animation.
@return No return value.</desc>
</method>
<method>
<name>isExpanded</name>
<desc>@return Returns true if object is expanded, false otherwise</desc>
</method>
<method>
<name>sizeToContents</name>
<desc>Resizes control to fit its contents
@return No return value.</desc>
</method>
<field>
<name>Caption</name>
<desc>caseString Caption</desc>
</field>
<field>
<name>ClickCollapse</name>
<desc>bool ClickCollapse</desc>
</field>
<field>
<name>Collapsed</name>
<desc>bool Collapsed</desc>
</field>
<field>
<name>DefaultHeight</name>
<desc>int DefaultHeight</desc>
</field>
<field>
<name>Margin</name>
<desc>Point2I Margin</desc>
</field>
</class>
<class>
<name>GuiScriptNotifyCtrl</name>
<base>GuiControl</base>
<field>
<name>onChildAdded</name>
<desc>bool onChildAdded</desc>
</field>
<field>
<name>onChildRemoved</name>
<desc>bool onChildRemoved</desc>
</field>
<field>
<name>onChildResized</name>
<desc>bool onChildResized</desc>
</field>
<field>
<name>onGainFirstResponder</name>
<desc>bool onGainFirstResponder</desc>
</field>
<field>
<name>onLoseFirstResponder</name>
<desc>bool onLoseFirstResponder</desc>
</field>
<field>
<name>onParentResized</name>
<desc>bool onParentResized</desc>
</field>
<field>
<name>onResize</name>
<desc>bool onResize</desc>
</field>
</class>
<class>
<name>GuiScrollCtrl</name>
<base>GuiControl</base>
<method>
<name>getScrollPositionX</name>
<desc>- get the current x scroll position of the scroll control.</desc>
</method>
<method>
<name>getScrollPositionY</name>
<desc>- get the current y scroll position of the scroll control.</desc>
</method>
<method>
<name>scrollToBottom</name>
<desc>Use the scrollToBottom method to scroll the scroll control to the bottom of the child content area.
@return No return value.
@sa scrollToTop</desc>
</method>
<method>
<name>scrollToTop</name>
<desc>Use the scrollToTop method to scroll the scroll control to the top of the child content area.
@return No return value.
@sa scrollToBottom</desc>
</method>
<method>
<name>setScrollPosition</name>
<args>x, y</args>
<desc>- scrolls the scroll control to the specified position.</desc>
</method>
<field>
<name>childMargin</name>
<desc>Point2I childMargin</desc>
</field>
<field>
<name>constantThumbHeight</name>
<desc>bool constantThumbHeight</desc>
</field>
<field>
<name>hScrollBar</name>
<desc>enumval hScrollBar</desc>
</field>
<field>
<name>vScrollBar</name>
<desc>enumval vScrollBar</desc>
</field>
<field>
<name>willFirstRespond</name>
<desc>bool willFirstRespond</desc>
</field>
</class>
<class>
<name>GuiSeparatorCtrl</name>
<base>GuiControl</base>
<field>
<name>BorderMargin</name>
<desc>int BorderMargin</desc>
</field>
<field>
<name>Caption</name>
<desc>string Caption</desc>
</field>
<field>
<name>Invisible</name>
<desc>bool Invisible</desc>
</field>
<field>
<name>LeftMargin</name>
<desc>int LeftMargin</desc>
</field>
<field>
<name>Type</name>
<desc>enumval Type</desc>
</field>
</class>
<class>
<name>GuiSliderCtrl</name>
<base>GuiControl</base>
<method>
<name>getValue</name>
<desc>Use the getValue method to get the current value of the slider.
@return Returns current value of control (position of slider)</desc>
</method>
<field>
<name>range</name>
<desc>Point2F range</desc>
</field>
<field>
<name>ticks</name>
<desc>int ticks</desc>
</field>
<field>
<name>value</name>
<desc>float value</desc>
</field>
</class>
<class>
<name>GuiStackControl</name>
<base>GuiControl</base>
<method>
<name>updateStack</name>
<desc>- Restacks controls it owns</desc>
</method>
<field>
<name>HorizStacking</name>
<desc>enumval HorizStacking</desc>
</field>
<field>
<name>Padding</name>
<desc>int Padding</desc>
</field>
<field>
<name>StackingType</name>
<desc>enumval StackingType</desc>
</field>
<field>
<name>VertStacking</name>
<desc>enumval VertStacking</desc>
</field>
</class>
<class>
<name>GuiTabBookCtrl</name>
<base>GuiControl</base>
<method>
<name>addPage</name>
<desc>Empty</desc>
</method>
<method>
<name>selectPage</name>
<args>int pageIndex</args>
</method>
<method>
<name>selectPageName</name>
<args>pageName</args>
</method>
<field>
<name>MinTabWidth</name>
<desc>int MinTabWidth</desc>
</field>
<field>
<name>TabHeight</name>
<desc>int TabHeight</desc>
</field>
<field>
<name>TabMargin</name>
<desc>int TabMargin</desc>
</field>
<field>
<name>TabPosition</name>
<desc>enumval TabPosition</desc>
</field>
</class>
<class>
<name>GuiTabPageCtrl</name>
<base>GuiTextCtrl</base>
</class>
<class>
<name>GuiTextCtrl</name>
<base>GuiControl</base>
<method>
<name>setText</name>
<args> newText </args>
<desc>Use the setText method to set the content of label to newText.
@param newText A string representing the new value for this label.
@return No return value</desc>
</method>
<method>
<name>setTextID</name>
<args> int newTextID </args>
<desc>Set the textID to a new value.
@param newTextID The desired new ID
@return No return value.</desc>
</method>
<field>
<name>maxLength</name>
<desc>int maxLength</desc>
</field>
<field>
<name>text</name>
<desc>caseString text</desc>
</field>
<field>
<name>textID</name>
<desc>string textID</desc>
</field>
</class>
<class>
<name>GuiTextEditCtrl</name>
<base>GuiTextCtrl</base>
<method>
<name>forceValidateText</name>
</method>
<method>
<name>getCursorPos</name>
<desc>Use the getCursorPos method to get the current position of the text cursor in the control.
@return Returns the current position of the text cursor in the control, where 0 is at the beginning of the line, 1 is after the first letter, and so on.
@sa setCursorPos</desc>
</method>
<method>
<name>getText</name>
<desc>Get the contents of the textedit control
@return Returns the current textedit buffer.</desc>
</method>
<method>
<name>selectAllText</name>
</method>
<method>
<name>setCursorPos</name>
<args> newPos </args>
<desc>Use the setCursorPos method to set the current position of text cursor to newPos.
If the requested position is beyond the end of text, the cursor will be placed after the last letter. If the value is less than zero, the cursor will be placed at the front of the entry.
@param newPos The new position to place the cursor at, where 0 is at the beginning of the line, 1 is after the first letter, and so on.
@return No return value.
@sa getCursorPos</desc>
</method>
<field>
<name>deniedSound</name>
<desc>AudioProfile deniedSound</desc>
</field>
<field>
<name>escapeCommand</name>
<desc>string escapeCommand</desc>
</field>
<field>
<name>historySize</name>
<desc>int historySize</desc>
</field>
<field>
<name>password</name>
<desc>bool password</desc>
</field>
<field>
<name>passwordMask</name>
<desc>string passwordMask</desc>
</field>
<field>
<name>sinkAllKeyEvents</name>
<desc>bool sinkAllKeyEvents</desc>
</field>
<field>
<name>tabComplete</name>
<desc>bool tabComplete</desc>
</field>
<field>
<name>validate</name>
<desc>string validate</desc>
</field>
</class>
<class>
<name>GuiTextEditSliderCtrl</name>
<base>GuiTextEditCtrl</base>
<field>
<name>format</name>
<desc>string format</desc>
</field>
<field>
<name>increment</name>
<desc>float increment</desc>
</field>
<field>
<name>range</name>
<desc>Point2F range</desc>
</field>
</class>
<class>
<name>GuiTextListCtrl</name>
<base>GuiArrayCtrl</base>
<method>
<name>addRow</name>
<args> ID , text [ , row ] </args>
<desc>Use the addRow method to add a new entry to the text list.
@param ID The integer ID to assign to this entry. May be between 0 and inf and can be repeated. i.e., multiple entries may have the same ID.
@param text The text to display for this entry in the list.
@param row An optional integer value representing the position at which to add this entry, where 0 is the top of the list, 1 is after them first entry (if any), etc.
@return Returns the row number of the new entry.
@sa clear, removeRow</desc>
</method>
<method>
<name>clear</name>
<desc>Use the clear method to remove all entries from the list.
@return No return value.
@sa addRow, clearSelection, removeRow</desc>
</method>
<method>
<name>clearSelection</name>
<desc>Use the clearSelection method to deselect the current selection (if any).
@return No return value.
@sa clear, setSelection</desc>
</method>
<method>
<name>findTextIndex</name>
<args> text </args>
<desc>Use the findTextIndex method to do an exact-match search for text in the list of items.
This is an exact match, so if the menu item is “Gish” and you search for “Gis”, or “gish', or any other variation that does not match the entire menu item and the case of each letter, the search will not find a match.
@param text The text to search for. Must match exactly or no match will occur.
@return No return value.
@sa getRowText, getRowTextByID</desc>
</method>
<method>
<name>getRowId</name>
<args> row </args>
<desc>Use the getRowId method to get the ID value for a specified row.
Row numbers start at 0.
@param row The row in the list to check the ID for.
@return Returns the ID of the specified row, or -1 if row is out of range.
@sa addRow, getRowNumByID, getRowText, getRowTextByID</desc>
</method>
<method>
<name>getRowNumById</name>
<args> ID </args>
<desc>Use the getRowNumById method to get the row number of the first entry in the list with the specified ID.
Row numbers start at 0.
@param ID An integer value equal to an the entry ID to search for.
@return Returns the number of the first row found with a matching ID, or -1 if no row contains the specified ID.
@sa addRow, getRowID, getRowText, getRowTextByID</desc>
</method>
<method>
<name>getRowText</name>
<args> row </args>
<desc>Use the getRowText method to retrieve the text value of an entry in the list at the specified row.
Row numbers start at 0.
@param row The number of the list row from which to retrieve the text.
@return Returns the text found at the specified row, or the NULL string (“”) if the row number is out of bounds.
@sa addRow, getRowID, getRowNumByID, getRowTextByID</desc>
</method>
<method>
<name>getRowTextById</name>
<args> ID </args>
<desc>Use the getRowTextById method to get the text of the first row with an ID matching the passed ID.
@param ID An integer value equal to the entry ID to search for.
@return Returns a string containing the text of the first row with a matching ID, or the NULL string (“”) if no row matches the specified ID.
@sa addRow, findTextIndex, getRowID, getRowNumByID, getRowTextByID</desc>
</method>
<method>
<name>getSelectedId</name>
<desc>Use the getSelectedId method to return the ID value of the currently selected entry (if any).
@return Returns the integer ID of the currently selected row or -1 if no row is selected.
@sa addRow, clearSelected, getRowID, getRowNumByID, getRowTextByID</desc>
</method>
<method>
<name>getSelectedRow</name>
<args> row </args>
<desc>Use the setSelectedRow method to select a specified row in the list.
Row numbers start at 0. No selection will be made if the row number is out of bounds. Additionally, if no selection is made and a prior row was selected, that selection will stay in effect.
@param row The number of the list row to set as selected.
@return No return value.
@sa setSelectedByID</desc>
</method>
<method>
<name>isRowActive</name>
<args> row </args>
<desc>Use the isRowActive method to determine if the specified row is active.
Row numbers start at 0.
@param row The row to check the active status for.
@return Returns 1 if the row is active, or 0 if the row is inactive or the specified row is out of bounds.
@sa setRowActive</desc>
</method>
<method>
<name>removeRow</name>
<args> row </args>
<desc>Use the removeRow method to remove the specified row from the list.
Row numbers start at 0. Nothing is removed if row is out of bounds.
@param row The number of the list row to be removed.
@return No return value.
@sa add, removeRowbyID</desc>
</method>
<method>
<name>removeRowById</name>
<args> ID </args>
<desc>Use the removeRowById method to remove the first row containing a matching ID.
@param ID An integer value equal to the entry ID of the row to delete.
@return No return value.
@sa add, removeRow, rowCount</desc>
</method>
<method>
<name>rowCount</name>
<desc>Use the rowCount method to determine how many entries are in the list.
@return Returns 0 if the list is entry or a positive integer value equal to the number of rows in the list if it is not empty.
@sa add, removeRow</desc>
</method>
<method>
<name>scrollVisible</name>
<args> row </args>
<desc>Use the scrollVisible method to force the scrollList containing this text list to scroll so that the specified row is visible.
Row numbers start at 0.
@param row The number of the list row to be scrolled to.
@return No return value.
@sa rowCount</desc>
</method>
<method>
<name>setRowActive</name>
<args> row , active </args>
<desc>Use the setRowActive method to activate or deactivate the specified row.
Row numbers start at 0. The row will not change visibly, but we can check if a selected row is active later to determine whether to respond or not to this selection.
@param row The number of the list row to activate or deactivate.
@param active A boolean value specifying whether this row is active or inactive.
@return No return value.
@sa isRowActive</desc>
</method>
<method>
<name>setRowById</name>
<args> ID , text </args>
<desc>Use the setRowById method to update the text if the first row fond with an ID matching the specified ID.
@param ID An integer value equal to the entry ID of the row to change the text for.
@param text The text to replace the found row value with.
@return No return value</desc>
</method>
<method>
<name>setSelectedById</name>
<args> ID </args>
<desc>Use the setSelectedById method to selected a row by a specified ID. This will select the first row found to have an ID matching the specified ID.
No selection will be made if no row has a matching ID. Additionally, if no selection is made and a prior row was selected, that selection will stay in effect.
@param ID An integer value equal to the entry ID of the row to select.
@return No return value.
@sa setSelectedRow</desc>
</method>
<method>
<name>setSelectedRow</name>
<args>int rowNum</args>
<desc>Selects the specified row.
@return No return value.</desc>
</method>
<method>
<name>sort</name>
<args> columnID [ , ascending = false ] </args>
<desc>Use the sort method to sort the list using a lexicographic sort. The sort order may be either ascending or descending (default).
Columns may be specified when setting up the list, by default most lists have one column so the columnID should be 0.
@param columnID The column to sort on.
@param ascending An optional boolean value, which when true means to do an ascending sort, otherwise the sort will be descending.
@return No return value.
@sa sortNumerical</desc>
</method>
<method>
<name>sortNumerical</name>
<args> columnID [ , ascending = false] </args>
<desc>Use the sortNumerical method to sort the list using a numeric sort. The sort order may be either ascending or descending (default).
Columns may be specified when setting up the list, by default most lists have one column so the columnID should be 0.
@param columnID The column to sort on.
@param ascending An optional boolean value, which when true means to do an ascending sort, otherwise the sort will be descending.
@return No return value.
@sa sort</desc>
</method>
<field>
<name>clipColumnText</name>
<desc>bool clipColumnText</desc>
</field>
<field>
<name>columns</name>
<desc>intList columns</desc>
</field>
<field>
<name>enumerate</name>
<desc>bool enumerate</desc>
</field>
<field>
<name>fitParentWidth</name>
<desc>bool fitParentWidth</desc>
</field>
<field>
<name>resizeCell</name>
<desc>bool resizeCell</desc>
</field>
</class>
<class>
<name>GuiTheoraCtrl</name>
<base>GuiControl</base>
<method>
<name>getCurrentTime</name>
<desc>@return Return the time elapsed in playback, in seconds (floating point).</desc>
</method>
<method>
<name>setFile</name>
<args>string filename</args>
<desc>Set an Ogg Theora file to play.
@return No return value.</desc>
</method>
<method>
<name>stop</name>
<desc>Stop playback.
@return No return value.</desc>
</method>
<field>
<name>backgroundColor</name>
<desc>ColorI backgroundColor</desc>
</field>
<field>
<name>done</name>
<desc>bool done</desc>
</field>
<field>
<name>stopOnSleep</name>
<desc>bool stopOnSleep</desc>
</field>
<field>
<name>theoraFile</name>
<desc>filename theoraFile</desc>
</field>
</class>
<class>
<name>GuiTickCtrl</name>
<base>GuiControl</base>
<method>
<name>setProcessTicks</name>
<args> [tick = true] </args>
<desc>- This will set this object to either be processing ticks or not
@return No return value.</desc>
</method>
</class>
<class>
<name>GuiToolboxButtonCtrl</name>
<base>GuiButtonCtrl</base>
<method>
<name>setHoverBitmap</name>
<args> filepath name </args>
<desc>Sets the bitmap that shows when the button is disabled@param name The path of the desired bitmap file
@return No Return Value.</desc>
</method>
<method>
<name>setLoweredBitmap</name>
<args> filepath name </args>
<desc>Sets the bitmap that shows when the button is disabled@param name The path of the desired bitmap file
@return No Return Value.</desc>
</method>
<method>
<name>setNormalBitmap</name>
<args> filepath name </args>
<desc>Sets the bitmap that shows when the button is active@param name The path of the desired bitmap file
@return No Return Value.</desc>
</method>
<field>
<name>hoverBitmap</name>
<desc>filename hoverBitmap</desc>
</field>
<field>
<name>loweredBitmap</name>
<desc>filename loweredBitmap</desc>
</field>
<field>
<name>normalBitmap</name>
<desc>filename normalBitmap</desc>
</field>
</class>
<class>
<name>GuiTreeViewCtrl</name>
<base>GuiArrayCtrl</base>
<method>
<name>addChildSelectionByValue</name>
<args>TreeItemId parent, value</args>
</method>
<method>
<name>addSelection</name>
<args>string ID</args>
<desc>Select an item@param ID The ID of the item to select.
@return No return value.</desc>
</method>
<method>
<name>buildIconTable</name>
<args>string icons</args>
<desc>Icons should be designated by the bitmap/png file names (minus the file extensions) and separated by colons (:). This list should be synchronized with the Icons enum.
@param icons The list of icons to add sepated by colons.
@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>buildVisibleTree</name>
<desc>Build the visible tree</desc>
</method>
<method>
<name>clear</name>
<desc>- empty tree</desc>
</method>
<method>
<name>clearSelection</name>
<desc>Clear selection
@return No return value.</desc>
</method>
<method>
<name>deleteSelection</name>
<desc>Delete all selected items.
@return No return value.</desc>
</method>
<method>
<name>editItem</name>
<args>TreeItemId item, string newText, string newValue</args>
</method>
<method>
<name>expandItem</name>
<args>TreeItemId item, [bool expand=true]</args>
<desc>Deselects item</desc>
</method>
<method>
<name>findItemByName</name>
<args>name</args>
<desc>Find item by name
@param name The name of the desired object.
@return Returns the ID of the object, or -1 on failure (not found).</desc>
</method>
<method>
<name>findItemByObjectId</name>
<args>find item by object id and returns the mId</args>
</method>
<method>
<name>getChild</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getFirstRootItem</name>
<desc>Get id for root item.</desc>
</method>
<method>
<name>getItemCount</name>
<desc>@return Returns the number of items in control</desc>
</method>
<method>
<name>getItemText</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getItemValue</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getNextSibling</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getParent</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getPrevSibling</name>
<args>TreeItemId item</args>
</method>
<method>
<name>getSelectedItem</name>
<desc>@return Returns the ID of the selected item.</desc>
</method>
<method>
<name>getSelectedItemList</name>
<desc>returns a space seperated list of mulitple item ids</desc>
</method>
<method>
<name>getSelectedItemsCount</name>
</method>
<method>
<name>getSelectedObject</name>
<desc>@return Returns the currently selected simObject in inspector mode or -1</desc>
</method>
<method>
<name>getTextToRoot</name>
<args>TreeItemId item,Delimiter=none</args>
<desc>gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally</desc>
</method>
<method>
<name>insertItem</name>
<args>TreeItemId parent, name, value, icon, normalImage=0, expandedImage=0</args>
<desc>Adds item to tree control.
@param parent The new item's parent.
@param name The name of the new item.
@param value The new item's value.
@param icon The new item's icon
@return Returns the new item's ID.</desc>
</method>
<method>
<name>lockSelection</name>
<args>[bool lock]</args>
<desc>Set whether the selection is to be locked.@param lock Boolean flag for whether or not the current selected object should be locked
@return No return value.</desc>
</method>
<method>
<name>moveItemDown</name>
<args>TreeItemId item</args>
</method>
<method>
<name>moveItemUp</name>
<args>TreeItemId item</args>
</method>
<method>
<name>open</name>
<args>SimSet obj, bool okToEdit=true</args>
<desc>Set the root of the tree view to the specified object, or to the root set.</desc>
</method>
<method>
<name>removeAllChildren</name>
<args>TreeItemId parent</args>
</method>
<method>
<name>removeChildSelectionByValue</name>
<args>TreeItemId parent, value</args>
</method>
<method>
<name>removeItem</name>
<args>TreeItemId item</args>
</method>
<method>
<name>removeSelection</name>
<args>string ID</args>
<desc>Deselects given item.
@param ID The ID of the item to deselect.
@return No return value.</desc>
</method>
<method>
<name>scrollVisible</name>
<args>TreeItemId item</args>
<desc>Make the given item visible.
@param ID of the desired item.
@return No return value.</desc>
</method>
<method>
<name>scrollVisibleByObjectId</name>
<args>show item by object id. returns true if sucessful.</args>
</method>
<method>
<name>selectItem</name>
<args>TreeItemId item, [bool select=true]</args>
<desc>Selects item.</desc>
</method>
<field>
<name>DeleteObjectAllowed</name>
<desc>bool DeleteObjectAllowed</desc>
</field>
<field>
<name>destroyTreeOnSleep</name>
<desc>bool destroyTreeOnSleep</desc>
</field>
<field>
<name>DragToItemAllowed</name>
<desc>bool DragToItemAllowed</desc>
</field>
<field>
<name>fullRowSelect</name>
<desc>bool fullRowSelect</desc>
</field>
<field>
<name>itemHeight</name>
<desc>int itemHeight</desc>
</field>
<field>
<name>MouseDragging</name>
<desc>bool MouseDragging</desc>
</field>
<field>
<name>MultipleSelections</name>
<desc>bool MultipleSelections</desc>
</field>
<field>
<name>tabSize</name>
<desc>int tabSize</desc>
</field>
<field>
<name>textOffset</name>
<desc>int textOffset</desc>
</field>
</class>
<class>
<name>GuiVectorFieldCtrl</name>
<base>GuiTickCtrl</base>
</class>
<class>
<name>GuiWindowCtrl</name>
<base>GuiTextCtrl</base>
<field>
<name>canClose</name>
<desc>bool canClose</desc>
</field>
<field>
<name>canMaximize</name>
<desc>bool canMaximize</desc>
</field>
<field>
<name>canMinimize</name>
<desc>bool canMinimize</desc>
</field>
<field>
<name>canMove</name>
<desc>bool canMove</desc>
</field>
<field>
<name>closeCommand</name>
<desc>string closeCommand</desc>
</field>
<field>
<name>minSize</name>
<desc>Point2I minSize</desc>
</field>
<field>
<name>resizeHeight</name>
<desc>bool resizeHeight</desc>
</field>
<field>
<name>resizeWidth</name>
<desc>bool resizeWidth</desc>
</field>
</class>
<class>
<name>HTTPObject</name>
<base>TCPObject</base>
<method>
<name>get</name>
<args>TransportAddress addr, string requirstURI, string query=NULL</args>
</method>
<method>
<name>post</name>
<args>TransportAddress addr, string requestURI, string query, string post</args>
</method>
</class>
<class>
<name>LangTable</name>
<base>SimObject</base>
<method>
<name>addLanguage</name>
<args>string filename, [string languageName]</args>
<desc>Adds the specified language to a table from file
@param filename Filename of file containing language data
@param languageName (Optional) Name of language
@return The size of the language table or -1 on failure</desc>
</method>
<method>
<name>getCurrentLanguage</name>
<desc>@return Returns the ID of the currentlt used language</desc>
</method>
<method>
<name>getLangName</name>
<args>int language</args>
<desc>Returns the name of the langauge specified by the given ID
@param language The ID of the desired language to check
@return The name of the specified language, or the empty string on failure.</desc>
</method>
<method>
<name>getNumLang</name>
<desc>Returns the number of currently stored languages
@return The number of laguages as an integer</desc>
</method>
<method>
<name>getString</name>
<args>string</args>
</method>
<method>
<name>setCurrentLanguage</name>
<args>int language</args>
<desc>Sets the current language to the one specified
@param language ID of the desired language
@return No return value.</desc>
</method>
<method>
<name>setDefaultLanguage</name>
<args>int language</args>
<desc>Sets the default language to the one specified
@param language ID of the desired language
@return No return value.</desc>
</method>
</class>
<class>
<name>LightSet</name>
<base>SimSet</base>
</class>
<class>
<name>MaterialPropertyMap</name>
<base>SimObject</base>
</class>
<class>
<name>Message</name>
<base>SimObject</base>
<method>
<name>addReference</name>
<desc>Increment the reference count for this message
@return No Return Value.</desc>
</method>
<method>
<name>freeReference</name>
<desc>Decrement the reference count for this message
@return No Return Value.</desc>
</method>
<method>
<name>getType</name>
<desc>Get message type (script class name or C++ class name if no script defined class)@return The type as a string</desc>
</method>
</class>
<class>
<name>MessageForwarder</name>
<base>ScriptMsgListener</base>
<field>
<name>toQueue</name>
<desc>Queue to forward to</desc>
</field>
</class>
<class>
<name>MessageVector</name>
<base>SimObject</base>
<method>
<name>clear</name>
<desc>Clear the message vector.
@return No return value</desc>
</method>
<method>
<name>deleteLine</name>
<args> lineIndex </args>
<desc>Delete the line at the specified position.
@param lineIndex The line to delete in this vector.
@return No return value.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>dump</name>
<args> filename [ , header ] </args>
<desc>Dump the message vector to a file, optionally prefixing the file with a header.
@param filename The file to dump this vector to.
@param header An optional string containing data to dump to the new file prior to dumping the vector.
@return No return value</desc>
</method>
<method>
<name>getLineIndexByTag</name>
<args> tag </args>
<desc>Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found.
@param tag A special marker, possibly embedded in one or more lines in the vector.
@return Returns the line number of the first line found with the specified tag, otherwise returns -1.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>getLineTag</name>
<args>line</args>
<desc>Use the getLineTag method to retrieve the tag for the specified line.
@param line Line to search for tag in.
@return Returns a tag value or 0 indicating no tag found.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>getLineText</name>
<args> index </args>
<desc>Use the getLineIndex method to get the text at a specified line.
@param index The index in the vector from which to retrieve a line of text.
@return Returns the text at the specified line, or “” indicating a bad index.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>getLineTextByTag</name>
<args> tag </args>
<desc>Use the getLineTextByTag method to scan through the lines in the vector, returning the first line that has a matching tag.
@param tag An special marker that may have been used when creating lines in the vector.
@return Returns the contents of the first line found with a matching tag, or “” indicating no match.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>getNumLines</name>
<desc>Use the getNumLines method to get the number of lines in the vector.
@return Returns an integer value equal to the line count for this vector.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>insertLine</name>
<args> pos , msg [ , tag ] </args>
<desc>Use the insertLine method to insert a new line into the vector at the specified position. An optional tag may also be applied.
@param pos The line at which to insert the new text.
@param msg The text to add to this control.
@param tag An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.
@return No return value.
@sa pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>popBackLine</name>
<desc>Use the popBackLine method to pop a line from the back of the list; destroys the line.
@return No return value.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>popFrontLine</name>
<desc>Use the popFrontLine method to pop a line from the front of the vector, destroying the line.
@return No return value.
@sa insertLine, pushBackLine, pushFrontLine</desc>
</method>
<method>
<name>pushBackLine</name>
<args> msg [ , tag ] </args>
<desc>Use the pushBackLine method to push a line onto the back of the list.
@param msg The text to add to this control.
@param tag An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.
@return No return value.
@sa popBackLine, popFrontLine, insertLine, pushFrontLine</desc>
</method>
<method>
<name>pushFrontLine</name>
<args> msg [ , tag ] </args>
<desc>Use the pushFrontLine method to push a line onto the front of the vector.
@param msg The text to add to this control.
@param tag An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.
@return No return value.
@sa popBackLine, popFrontLine, insertLine, pushBackLine</desc>
</method>
</class>
<class>
<name>MoreAdvancedComponent</name>
<base>SimComponent</base>
</class>
<class>
<name>NetConnection</name>
<base>SimGroup</base>
<method>
<name>checkMaxRate</name>
<desc>Use the checkMaxRate method to retrieve the current maximum packet rate for this connection.
The period may not neccesarily be one second. To adjust packet rates, see the preference variables above
@return Returns an integer value representing the maximum number of packets that can be transmitted by this connection per transmission period.</desc>
</method>
<method>
<name>connect</name>
<args> remoteAddress </args>
<desc>Use the connect method to request a connection to a remote server at the address remoteAddress.
@param remoteAddress A string containing an address of the form: “A.B.C.D:Port”, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536.
@return No return value.
@sa connectLocal, getAddress</desc>
</method>
<method>
<name>connectLocal</name>
<desc>Use the connectLocal method to connect the current client-side connection to a local NetConnection, that is to create an internal connection from this client to the internal server. This is accomplished through the use of a back door mechanism and has an extremely high bandwidth.
@return No return value.
@sa connect, getAddress</desc>
</method>
<method>
<name>getAddress</name>
<desc>Use the getAddress method to get the address and port that this NetConnection is currently attached to.
@return Returns the address and port that this NetConnection is currently attached to, where the addres will be of the form: “A.B.C.D:Port”. A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. If the connection is local, the string “local” will be returned. If a this NetConnection is not currently connected the method will return a NULL string.
@sa connect, connectLocal</desc>
</method>
<method>
<name>getGhostID</name>
<args> S32 realID </args>
<desc>Convert a real id to the ghost id for this connection.@return The ID as an integer</desc>
</method>
<method>
<name>getGhostsActive</name>
<desc>Use the getGhostsActive method to determine how many ghosts are active on a particular connection.
@return Returns an integer value between 0 and inf, specifying how many objects are being ghosted to a client on the other side of a specific connection</desc>
</method>
<method>
<name>getPacketLoss</name>
<desc>Use the getPacketLoss method to determine the current packetLoss count for this connection.
@return Returns an integer value between 0 and inf, indicating the number of packets that have been lost to date on this net connection.
@sa getPing</desc>
</method>
<method>
<name>getPing</name>
<desc>Use the getPing method to determine the round-trip travel time from this connection to the agent on the other end and back again.
@return Returns an integer value representing the total time in milliseconds it takes for a ping request to travel to the agent on the other end of a connection and back to this agent.
@sa getPacketLoss</desc>
</method>
<method>
<name>resolveGhostID</name>
<args> S32 ghostID </args>
<desc>Convert a ghost id from this connection to a real id.@return The ID as an integer</desc>
</method>
<method>
<name>resolveObjectFromGhostIndex</name>
<args> S32 ghostIdx</args>
<desc>Convert a ghost index from this connection to a real id.@return The ID as an integer</desc>
</method>
<method>
<name>setSimulatedNetParams</name>
<args> packetLoss , delay </args>
<desc>Use the setSimulatedNetParams method to force a connection to experience a certain degree of packet-loss and/or latency. This is a debug feature to allow us to see how a distributed game will behave in the face of poor connection quality.
@param packetLoss A floating-point value between 0.0 (0%) and 1.0 (100%) dictating the percentage of packets to be artificially lost.
@param delay An integer value specifying the number of milliseconds to insert into transmission latencies.
@return No return value.
@sa getPacketLoss, getPing</desc>
</method>
</class>
<class>
<name>NetObject</name>
<base>SimObject</base>
<method>
<name>clearScopeToClient</name>
<args> client </args>
<desc>Use the clearScopeToClient method to undo the effects of a previous call to scopeToClient.
@param client The ID of the client to stop forcing scoping this object for.
@return No return value.
@sa scopeToClient</desc>
</method>
<method>
<name>getGhostID</name>
<desc>@return Returns the ghost ID of the object</desc>
</method>
<method>
<name>scopeToClient</name>
<args> client </args>
<desc>Use the scopeToClient method to force this object to be SCOPE_ALWAYS on client.
When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to a client, use this method.
@param client The ID of the client to force this object to be SCOPE_ALWAYS for.
@return No return value.
@sa clearScopeToClient, setScopeAlways</desc>
</method>
<method>
<name>setScopeAlways</name>
<desc>Use the setScopeAlways method to force an object to be SCOPE_ALWAYS for all clients.
When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to all clients, use this method.
@return No return value.
@sa scopeToClient</desc>
</method>
</class>
<class>
<name>NetStringEvent</name>
</class>
<class>
<name>OpenFileDialog</name>
<base>FileDialog</base>
<field>
<name>MultipleFiles</name>
<desc>True/False whether multiple files may be selected and returned or not</desc>
</field>
<field>
<name>MustExist</name>
<desc>True/False whether the file returned must exist or not</desc>
</field>
</class>
<class>
<name>OpenFolderDialog</name>
<base>OpenFileDialog</base>
<field>
<name>fileMustExist</name>
<desc>File that must in selected folder for it to be valid</desc>
</field>
</class>
<class>
<name>pathAStar2d</name>
<base>t2dSceneObject</base>
<method>
<name>calculate</name>
<desc>find(startX / startY, destX / destY) - creates a path</desc>
</method>
<method>
<name>clear</name>
<desc>- Clear Path</desc>
</method>
<method>
<name>getDistance</name>
<desc>- Distance of Path</desc>
</method>
<method>
<name>getLinearAngle</name>
<args> step </args>
<desc>- Angle at Path Step</desc>
</method>
<method>
<name>getLinearWorld</name>
<args> distance </args>
<desc>- coord at path step + subStep</desc>
</method>
<method>
<name>getNodeWorldCoords</name>
<args>nodeIndex</args>
<desc>-- returns the world Coordinates of a node</desc>
</method>
<method>
<name>getPathCoordsList</name>
<desc>returns a list of all node coordinates in world space</desc>
</method>
<method>
<name>getSplineAngle</name>
<args> step </args>
<desc>- Angle at Path Step</desc>
</method>
<method>
<name>getSplineWorld</name>
<args> distance </args>
<desc>- coord at path step + subStep</desc>
</method>
<method>
<name>getSteps</name>
<desc>- Steps in Path</desc>
</method>
</class>
<class>
<name>pathGrid2d</name>
<base>t2dSceneObject</base>
<method>
<name>clearSymbols</name>
<desc>-- clears current symbols on map</desc>
</method>
<method>
<name>createPath</name>
<args>startX / startY, destX / destY, [cut corners?], [optimise?]</args>
<desc>- creates a path</desc>
</method>
<method>
<name>deleteAllPaths</name>
<desc>Deletes all Path(s).</desc>
</method>
<method>
<name>deletePath</name>
<args>pathIndex</args>
<desc>- Deletes a Path.</desc>
</method>
<method>
<name>deletePathId</name>
<args>pathID</args>
<desc>- deletes a Path by Id.</desc>
</method>
<method>
<name>getPath</name>
<args>pathIndex</args>
<desc>- Returns Path by Index.</desc>
</method>
<method>
<name>getPathCount</name>
<desc>Returns the number of paths</desc>
</method>
<method>
<name>getTileLayer</name>
<desc>returns the assigned tile layer</desc>
</method>
<method>
<name>setDebugDraw</name>
<args>bool</args>
<desc>- Sets debug draw flag</desc>
</method>
<method>
<name>setDiagonalMovement</name>
<args>bool</args>
<desc>- Enable/Disable diagonal movement</desc>
</method>
<method>
<name>setTileLayer</name>
<args>layer Name</args>
<desc>- Sets the layer</desc>
</method>
<method>
<name>setWeight</name>
<args>weight</args>
<desc>- Sets the weight for this tile, from 0 (passable) to 10 (blocked)</desc>
</method>
</class>
<class>
<name>PopupMenu</name>
<base>SimObject</base>
<method>
<name>attachToMenuBar</name>
<args>pos, title</args>
<desc>Attaches given menu item to menu bar
@param pos The position of the desired menu item
@param title The menu item title
@return No return value</desc>
</method>
<method>
<name>checkItem</name>
<args>pos, checked</args>
<desc>Sets the given item's "checked" status
@param pos The item's position
@return No return value</desc>
</method>
<method>
<name>checkRadioItem</name>
<args>firstPos, lastPos, checkPos</args>
<desc>Checks the specified menu item and makes it a radio item
@param firstPos The position of the first item in the group
@param lastPos The position of the last item in the group
@param checkPos The position of the item to check
@return No return value.</desc>
</method>
<method>
<name>enableItem</name>
<args>pos, enabled</args>
<desc>Enables the item at the given position
@param pos The item's position
@param enabled A boolean value to set its current status
@return No return value</desc>
</method>
<method>
<name>insertItem</name>
<args>pos[, title][, accelerator</args>
<desc>Insert a new menu item
@param pos The position of the item
@param title The title of the item to add (optional)
@param accelerator A keyboard accelerator for the menu item
@return Returns the id of the new menu item as a nonnegative integer (-1 on fail)</desc>
</method>
<method>
<name>insertSubMenu</name>
<args>pos, title, subMenu</args>
<desc>Inserts a menu item into the current object
@param pos The position of the menu item
@param The desired title of the sub menu
@param subMenu The submenu you are inserting.
@return Returns the ID of the inserted item or -1 on failure</desc>
</method>
<method>
<name>isItemChecked</name>
<args>pos</args>
<desc>Checks (no pun intended) the "checked" flag of the given menu item
@param pos The position of the desired item
@return Returns true if checked, false otherwise</desc>
</method>
<method>
<name>removeFromMenuBar</name>
<desc>Removes current item from menu bar@return No return value</desc>
</method>
<method>
<name>removeItem</name>
<args>pos</args>
<desc>Removes the menu item at the given position
@param pos The position of the desired menu item to obliterate
@return No return value</desc>
</method>
<method>
<name>showPopup</name>
<args>[x, y]</args>
<desc>Show the menu (optional: specify position)
@param x,y Coodinates to display menu (upper left corner)
@return No return value.</desc>
</method>
<field>
<name>isPopup</name>
<desc>bool isPopup</desc>
</field>
</class>
<class>
<name>RemoteCommandEvent</name>
</class>
<class>
<name>RootGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>SaveFileDialog</name>
<base>FileDialog</base>
<field>
<name>OverwritePrompt</name>
<desc>True/False whether the dialog should prompt before accepting an existing file name</desc>
</field>
</class>
<class>
<name>ScriptGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>ScriptMsgListener</name>
<base>SimObject</base>
</class>
<class>
<name>ScriptObject</name>
<base>SimObject</base>
</class>
<class>
<name>SimChunk</name>
<base>SimGroup</base>
</class>
<class>
<name>SimComponent</name>
<base>SimObject</base>
<method>
<name>addComponents</name>
<args> %compObjName, %compObjName2, ... </args>
</method>
<method>
<name>getComponent</name>
<args>idx</args>
<desc>Get the component corresponding to the given index.
@param idx An integer index value corresponding to the desired component.
@return The id of the component at the given index as an integer</desc>
</method>
<method>
<name>getComponentCount</name>
<desc>Get the current component count
@return The number of components in the list as an integer</desc>
</method>
<method>
<name>isEnabled</name>
<desc>Check whether SimComponent is currently enabled
@return true if enabled and false if not</desc>
</method>
<method>
<name>removeComponents</name>
<args> %compObjName, %compObjName2, ... </args>
</method>
<method>
<name>setEnabled</name>
<args>enabled</args>
<desc>Sets or unsets the enabled flag
@param enabled Boolean value
@return No return value</desc>
</method>
<field>
<name>Enabled</name>
<desc>bool Enabled</desc>
</field>
</class>
<class>
<name>SimDataBlock</name>
<base>SimObject</base>
</class>
<class>
<name>SimGroup</name>
<base>SimSet</base>
</class>
<class>
<name>SimObject</name>
<method>
<name>addFieldFilter</name>
<args>fieldName</args>
<desc>Adds the given field filter to the list of table entries.
@param fieldName The name of the field filter to add.
@return No return value</desc>
</method>
<method>
<name>call</name>
<args> %args </args>
<desc>- Dynamically call a method on an object.</desc>
</method>
<method>
<name>delete</name>
<desc>Use the delete method to delete this object.
When an object is deleted, it automatically: Unregisters its ID and name (if it has one) with the engine. Removes itself from any SimGroup or SimSet it may be a member of. (eventually) returns the memory associated with itself and its non-dynamic members. Cancels all pending %obj.schedule() events. For objects in the GameBase, ScriptObject, or GUIControl hierarchies, an object will first: Call the onRemove() method for the object's namespace
@return No return value.</desc>
</method>
<method>
<name>dump</name>
<desc>Use the dump method to display the following information about this object: All engine and script registered console methods (including parent methods) for this object, all Non-Dynamic Fields AND all Dynamic Fields
@return No return value</desc>
</method>
<method>
<name>dumpClassHierarchy</name>
</method>
<method>
<name>getClassName</name>
</method>
<method>
<name>getClassNamespace</name>
</method>
<method>
<name>getDynamicField</name>
<args>index</args>
</method>
<method>
<name>getDynamicFieldCount</name>
</method>
<method>
<name>getField</name>
<args>int index</args>
<desc>- Gets the name of the field at the given index.</desc>
</method>
<method>
<name>getFieldCount</name>
<desc>- Gets the number of persistent fields on the object.</desc>
</method>
<method>
<name>getFieldType</name>
<args>fieldName</args>
</method>
<method>
<name>getFieldValue</name>
<args>fieldName</args>
</method>
<method>
<name>getGroup</name>
<desc>Use the getGroup method to determine if this object is contained in a SimGroup and if so, which one.
@return Returns the ID of the SimGroup this shape is in or zero if the shape is not contained in a SimGroup</desc>
</method>
<method>
<name>getId</name>
<desc>Use the getId method to get the numeric ID of this shape.
@return Returns the unique numeric ID of this shape.
@sa getName, setName</desc>
</method>
<method>
<name>getInternalName</name>
<desc>getInternalName returns the objects internal name</desc>
</method>
<method>
<name>getName</name>
</method>
<method>
<name>getSuperClassNamespace</name>
</method>
<method>
<name>getType</name>
<desc>Use the getType method to get the type for this object. This type is an integer value composed of bitmasks. For simplicity, these bitmasks are defined in the engine and exposed for our use as global variables.
To simplify the writing of scripts, a set of globals has been provided containing the bit setting for each class corresponding to a particular type. For a complete list of the bit masks, see the 'Shape Type Bitmasks' table.
-$TypeMasks::GameBaseObjectType
-- $TypeMasks::EnvironmentObjectType
-- $TypeMasks::ExplosionObjectType
-- $TypeMasks::ProjectileObjectType
-- $TypeMasks::ShapeBaseObjectType
--- $TypeMasks::CameraObjectType
--- $TypeMasks::ItemObjectType
--- $TypeMasks::MarkerObjectType
--- $TypeMasks::PlayerObjectType
--- $TypeMasks::StaticShapeObjectType
--- $TypeMasks::VehicleObjectType
-- $TypeMasks::TriggerObjectType
- $TypeMasks::InteriorObjectType
- $TypeMasks::StaticObjectType
- $TypeMasks::TerrainObjectType
- $TypeMasks::VehicleBlockerObjectType
- $TypeMasks::WaterObjectType Two interesting general masks are:
$TypeMasks::EnvironmentObjectType – Matches sky, sun, lightning, particle emitter nodes.
$TypeMasks::StaticObjectType – Matches – fxFoliageReplicator, fxLight, fxShapeReplicator, fxSunlight, interiorInstance, lightning, mirrorSubObject, missionMarker, staticShape, terrain, tsStatic
@return Returns a bit mask containing one or more set bits.
@sa getClassName</desc>
</method>
<method>
<name>isChildOfGroup</name>
<desc>returns true, if we are in the specified simgroup - or a subgroup thereof</desc>
</method>
<method>
<name>isMemberOfClass</name>
<args>string classname</args>
<desc>-- returns true if this object is a member of the specified class</desc>
</method>
<method>
<name>isMethod</name>
<args>string method name</args>
</method>
<method>
<name>removeFieldFilter</name>
<args>fieldName</args>
<desc>Removes the specified field filter from the table
@param fieldName The name of the field filter to remove.
@return No return value.</desc>
</method>
<method>
<name>save</name>
<args>fileName, [selectedOnly]</args>
</method>
<method>
<name>schedule</name>
<args>time , command , &lt;arg1 ... argN&gt; </args>
<desc>Use the schedule method to schedule an action to be executed upon this object time milliseconds in the future.
The major difference between this and the schedule console function is that if this object is deleted prior to the scheduled event, the event is automatically canceled. times should not be treated as exact since some 'simulation delay' is to be expected. The minimum resolution for a scheduled event is "32 ms, or one tick. schedule does not validate the existence of command. i.e. If you pass an invalid console method name, the schedule() method will still return a schedule ID, but the subsequent event will fail silently.
@param time Time in milliseconds till action is scheduled to occur.
@param command Name of the command to execute. This command must be scoped to this object (i.e. It must exist in the namespace of the object), otherwise the schedule call will fail.
@param arg1...argN These are optional arguments which will be passed to command. This version of schedule automatically passes the ID of %obj as arg0 to command.
@return Returns an integer schedule ID.
@sa See the schedule console function and its corresponding helper functions.</desc>
</method>
<method>
<name>setClassNamespace</name>
</method>
<method>
<name>setFieldValue</name>
<args>fieldName,value</args>
</method>
<method>
<name>setInternalName</name>
<desc>string InternalName</desc>
</method>
<method>
<name>setName</name>
<args>newName</args>
</method>
<method>
<name>setSuperClassNamespace</name>
</method>
<field>
<name>canSaveDynamicFields</name>
<desc>bool canSaveDynamicFields</desc>
</field>
<field>
<name>class</name>
<desc>Script SuperClass of object.</desc>
</field>
<field>
<name>internalName</name>
<desc>string internalName</desc>
</field>
<field>
<name>parentGroup</name>
<desc>Group hierarchy parent of the object.</desc>
</field>
<field>
<name>superclass</name>
<desc>Script Class of object.</desc>
</field>
</class>
<class>
<name>SimpleComponent</name>
<base>SimComponent</base>
</class>
<class>
<name>SimpleMessageEvent</name>
</class>
<class>
<name>SimpleNetObject</name>
<base>NetObject</base>
<method>
<name>setMessage</name>
<args>string msg</args>
<desc>Sets the object message to the provide string
@param msg The string you wish as the message
@return No return value</desc>
</method>
</class>
<class>
<name>SimSet</name>
<base>SimObject</base>
<method>
<name>add</name>
<args>obj1,...</args>
<desc>Adds given listy of objects to the SimSet.
@param obj_i (i is unilimited) Variable list of objects to add
@return No return value</desc>
</method>
<method>
<name>bringToFront</name>
<args>object</args>
<desc>Brings object to front of set.
@return No return value.</desc>
</method>
<method>
<name>clear</name>
<desc>Clears the Simset
@return No return value</desc>
</method>
<method>
<name>findObjectByInternalName</name>
<args>string name, [bool searchChildren]</args>
<desc>Returns the object with given internal name
@param name The internal nam eof the object you wish to find
@param searchChildren Set this true if you wish to search all children as well.
@return Returns the ID of the object.</desc>
</method>
<method>
<name>getCount</name>
<desc>@return Returns the number of objects in the SimSet</desc>
</method>
<method>
<name>getObject</name>
<args>objIndex</args>
<desc>@return Returns the ID of the desired object or -1 on failure</desc>
</method>
<method>
<name>isMember</name>
<args>object</args>
<desc>@return Returns true if specified object is a member of the set, and false otherwise</desc>
</method>
<method>
<name>listObjects</name>
<desc>Prints the object data within the set
@return No return value</desc>
</method>
<method>
<name>pushToBack</name>
<args>object</args>
<desc>Sends item to back of set.
@return No return value.</desc>
</method>
<method>
<name>remove</name>
<args>obj1,...</args>
<desc>Removes given listy of objects from the SimSet.
@param obj_i (i is unilimited) Variable list of objects to remove
@return No return value</desc>
</method>
<method>
<name>reorderChild</name>
<args>child1, child2</args>
<desc>Uses simset reorder to push child 1 before child 2 - both must already be child controls of this control
@param child1 The child you wish to set first
@param child2 The child you wish to set after child1
@return No return value.</desc>
</method>
</class>
<class>
<name>SimXMLDocument</name>
<base>SimObject</base>
<method>
<name>addComment</name>
<args>string comment</args>
<desc>Add the given comment as a child of current stack element.
@param comment The desired comment to add
@return No return value.</desc>
</method>
<method>
<name>addData</name>
<args>string text</args>
<desc>Add the given text as a child of current stack element.
@param The desired text to add
@return No return value</desc>
</method>
<method>
<name>addHeader</name>
<desc>Add XML header to document.
@return No return value.</desc>
</method>
<method>
<name>addNewElement</name>
<args>string name</args>
<desc>Create new element as child of current stack element and push new element on to stack.
@param name The anme of the new element
@return No return value</desc>
</method>
<method>
<name>addText</name>
<args>string text</args>
<desc>Add the given text as a child of current stack element.
@param text The desired text to add
@return No return value.</desc>
</method>
<method>
<name>attribute</name>
<args>string attribute</args>
<desc>Get attribute value if it exists.
@param attribute The desired SimXMLDocument attribute
@return Returns the value of the attribute as a string, or an empty string on failure</desc>
</method>
<method>
<name>attributeExists</name>
<args>string attribute</args>
<desc>Get true if named attribute exists.
@param attribute The desired attribute's name
@return Returns true if attribute exists and false otherwise</desc>
</method>
<method>
<name>attributeF32</name>
<args>string attribute</args>
<desc>Get attribute value if it exists.
@param attribute The desired SimXMLDocument attribute
@return Returns the value of the attribute converted to 32-bit floating-point value from string</desc>
</method>
<method>
<name>attributeS32</name>
<args>string attribute</args>
<desc>Get attribute value if it exists.
@param attribute The desired SimXMLDocument attribute
@return Returns the value of the attribute converted to 32-bit integer value from string</desc>
</method>
<method>
<name>clear</name>
<desc>Clear contents of XML document.
@return No return value</desc>
</method>
<method>
<name>clearError</name>
<desc>Clear error description.
@return No return value</desc>
</method>
<method>
<name>elementValue</name>
<desc>Get element value if it exists.
@return A string with the desired value, or empty if not found.</desc>
</method>
<method>
<name>firstAttribute</name>
<desc>Obtain the name of the current element's first attribute.
@return A string with the name of the first attribute</desc>
</method>
<method>
<name>getData</name>
<desc>Gets the text from the current stack element.
@return Returns the desired text or empty string if failed (no text)</desc>
</method>
<method>
<name>getErrorDesc</name>
<desc>Get current error description.
@return Returns a string with the error description</desc>
</method>
<method>
<name>getText</name>
<desc>Gets the text from the current stack element.
@return Returns the desired text, or empty string on failure</desc>
</method>
<method>
<name>lastAttribute</name>
<desc>Obtain the name of the current element's last attribute.
@return A string with the name of the last attribute</desc>
</method>
<method>
<name>loadFile</name>
<args>string fileName</args>
<desc>Load file from given filename.
@param fileName The name of the desired file
@return Returns 1 on success and 0 otherwise</desc>
</method>
<method>
<name>nextAttribute</name>
<desc>Get the name of the next attribute for the current element after a call to firstAttribute().
@return A string with the name of the next attribute</desc>
</method>
<method>
<name>nextSiblingElement</name>
<args>string name</args>
<desc>Set top element on stack to next element with given name.
@param name The name of the element.
@return Returns true on success, false otherwise</desc>
</method>
<method>
<name>parse</name>
<args>string txtXML</args>
<desc>Create document from XML string.
@param txtXML The text of the XML document
@return Returns 1 on success</desc>
</method>
<method>
<name>popElement</name>
<desc>Pop last element off of stack.
@return No return value</desc>
</method>
<method>
<name>prevAttribute</name>
<desc>Get the name of the previous attribute for the current element after a call to lastAttribute().
@return A string with the name of the previous attribute</desc>
</method>
<method>
<name>pushChildElement</name>
<args>int index</args>
<desc>Push the child element at the given index onto stack.
@param index A nonnegative integer representing the index of the child element
@return Returns true on success, and false otherwise</desc>
</method>
<method>
<name>pushFirstChildElement</name>
<args>string name</args>
<desc>Push first child element with given name onto stack.
@param name The name of the child element@return returns true on success, false otherwise.</desc>
</method>
<method>
<name>pushNewElement</name>
<args>string name</args>
<desc>Create new element as child of current stack element and push new element on to stack.
@param name The anme of the new element
@return No return value</desc>
</method>
<method>
<name>readComment</name>
<args>S32 index</args>
<desc>Returns the comment at the specified index.
@param index The index of the desired comment as a nonnegative integer value
@return The comment as a string</desc>
</method>
<method>
<name>removeText</name>
<desc>Remove any text on the current stack element.
@return No return value</desc>
</method>
<method>
<name>reset</name>
<desc>Set this to default state at construction.
@return No return value</desc>
</method>
<method>
<name>saveFile</name>
<args>string fileName</args>
<desc>Save file to given filename.
@param fileName A string presenting the filename to save the XML document as
@return Returns 1 on success, and 0 otherwise</desc>
</method>
<method>
<name>setAttribute</name>
<args>string attributeName, string attributeValue</args>
<desc>Set attribute of top stack element to given value.
@param attributeName The name of the attribute of the element you wish to set
@param attributeValue The value you wish to set the given attribute to
@return No return value.</desc>
</method>
<method>
<name>setObjectAttributes</name>
<args>string attributeValue</args>
<desc>Set attribute of top stack element to given value.
@param attributeValue The value you wish to set the given attribute to
@return No return value.</desc>
</method>
</class>
<class>
<name>StreamObject</name>
<base>SimObject</base>
<method>
<name>copyFrom</name>
<args>StreamObject other</args>
<desc>Copies stream contents from current position
@param other The StreamObject from which to copy
@return Returns true on success, and false otherwise.</desc>
</method>
<method>
<name>getPosition</name>
<desc>@return Returns the current position in the stream as an integer or zero if failed</desc>
</method>
<method>
<name>getStatus</name>
<desc>Gets the current status of the StreamObject@return The current status as a string (Ok, IOError, EOS, IllegalCall, Closed, UnknownError, Invalid)</desc>
</method>
<method>
<name>getStreamSize</name>
<desc>Get the size of the stream@return The size of the stream as an integer</desc>
</method>
<method>
<name>isEOF</name>
<desc>Test for end of file stream (identical to isEOS()@return Returns true if at the end of the stream, false otherwise.@sa isEOS</desc>
</method>
<method>
<name>isEOS</name>
<desc>Test for end of stream@return Returns true if at the end of the stream, false otherwise.</desc>
</method>
<method>
<name>readLine</name>
<desc>Read the stream until '\n' or EOS
@return A string containing the read line or an empty string if failed</desc>
</method>
<method>
<name>readLongString</name>
<args>maxLength</args>
<desc>Reads a string of provided length from the stream buffer.
@param The maximum length to read in
@return The requested string</desc>
</method>
<method>
<name>readString</name>
<desc>Reads a string from a stream buffer
@return The string or an empty string if failed.</desc>
</method>
<method>
<name>readSTString</name>
<args>[caseSensitive = false]</args>
<desc>Read a String and insert it into a StringTable
@param caseSensitive A boolean representing whether the parser should ignore case or not (default false)
@return Returns the string, or empty string if failed</desc>
</method>
<method>
<name>setPosition</name>
<args>newPosition</args>
<desc>Resets the current stream position
@param The desired index
@return Returns true if succeeded, flase otherwise</desc>
</method>
<method>
<name>writeLine</name>
<args>line</args>
<desc>Writes a line of text to the stream buffer
@param The line to write
@return No return value.</desc>
</method>
<method>
<name>writeLongString</name>
<args>maxLength, string</args>
<desc>Writes a string to buffer or provided length
@param maxLength The maximum length to write
@param string The string to write
@return No return value</desc>
</method>
<method>
<name>writeString</name>
<args>string, [maxLength = 255]</args>
<desc>Write a string to the stream buffer
@param string The string to write
@param maxLength The maximum length to write (default 255).
@return No return value.</desc>
</method>
</class>
<class>
<name>t2dActiveTile</name>
<base>SimObject</base>
</class>
<class>
<name>t2dActiveTileDatablock</name>
<base>t2dBaseDatablock</base>
</class>
<class>
<name>t2dAnimatedSprite</name>
<base>t2dSceneObject</base>
<method>
<name>getAnimation</name>
<desc>- Gets current animation.
@return (string Animation) The current animation</desc>
</method>
<method>
<name>getAnimationFrame</name>
<desc>- Gets current animation frame.
@return (int frame) The current animation frame</desc>
</method>
<method>
<name>getAnimationName</name>
<desc>- Gets current animation.
@return (string Animation) The current animation</desc>
</method>
<method>
<name>getAnimationTime</name>
<desc>- Gets current animation time.
@return (float time) The current animation time</desc>
</method>
<method>
<name>getIsAnimationFinished</name>
<desc>- Checks animation status.
@return (bool finished) Whether or not the animation is finished</desc>
</method>
<method>
<name>playAnimation</name>
<args>string animationName, [bool autoRestore], [int frameIndex], [bool mergeTime]</args>
<desc>- Plays an animation.
@param animationName The animation to play
@param autoRestore If true, the previous animation will be played when this new animation finishes.
@param frameIndex The animation frame to start playing from.
@param mergeTime Where to merge the previous animation with the new one
@return Returns true on success.</desc>
</method>
<method>
<name>setAnimation</name>
<args>string animationName</args>
<desc>- Sets the current animation.
@param animationName The animation to play
@return No return value.</desc>
</method>
<method>
<name>setAnimationFrame</name>
<args>int frame</args>
<desc>- Sets the current animation frame.
@param frame Which frame of the animation to display
@return No return value.</desc>
</method>
<method>
<name>setFrameChangeCallback</name>
<args>bool enabled</args>
<desc>- Sets the frame-change callback status.
@param enabled Whether or not to call the onFrameChange callback
@return No return value.</desc>
</method>
<field>
<name>animationName</name>
<desc>string animationName</desc>
</field>
</class>
<class>
<name>t2dAnimationDatablock</name>
<base>t2dBaseDatablock</base>
<method>
<name>calculateAnimation</name>
<desc>Calculates the animation based on the number of frames and the timesteps.@return No return value.</desc>
</method>
<field>
<name>animationCycle</name>
<desc>bool animationCycle</desc>
</field>
<field>
<name>animationFrames</name>
<desc>string animationFrames</desc>
</field>
<field>
<name>animationPingPong</name>
<desc>bool animationPingPong</desc>
</field>
<field>
<name>animationReverse</name>
<desc>bool animationReverse</desc>
</field>
<field>
<name>animationTime</name>
<desc>float animationTime</desc>
</field>
<field>
<name>imageMap</name>
<desc>string imageMap</desc>
</field>
<field>
<name>randomStart</name>
<desc>bool randomStart</desc>
</field>
<field>
<name>startFrame</name>
<desc>int startFrame</desc>
</field>
</class>
<class>
<name>t2dBaseDatablock</name>
<base>SimDataBlock</base>
<method>
<name>getDatablockClassName</name>
<desc>Gets datablocks unique classname.
@return The class name as a string.</desc>
</method>
<method>
<name>getDefaultConfigDatablock</name>
<desc>Gets the datablock being applied to objects using this image map.@return Returns the block as a string.</desc>
</method>
<method>
<name>getIsValid</name>
<desc>@return Returns a boolean value for whether or not the datablock is valid</desc>
</method>
<method>
<name>setDefaultConfigDatablock</name>
<args>block</args>
<desc>Sets the datablock to be applied to objects using this image map.@param block The block you wish to set.@return No return value.</desc>
</method>
<field>
<name>defaultConfig</name>
<desc>string defaultConfig</desc>
</field>
</class>
<class>
<name>t2dChunkedImageDatablock</name>
<base>t2dBaseDatablock</base>
<field>
<name>imageName</name>
<desc>filename imageName</desc>
</field>
</class>
<class>
<name>t2dChunkedSprite</name>
<base>t2dSceneObject</base>
<method>
<name>setChunkedImage</name>
<args>chunkedImageName$</args>
<desc>- Sets Chunked-Image.
@return Returns true on success.</desc>
</method>
<method>
<name>setRepeat</name>
<args>repeatX / repeatY</args>
<desc>- Sets the Repeat X/Y repetition.
@param x,y X and Y repeats values as either ("x y") or (x,y))
@return No return value.</desc>
</method>
</class>
<class>
<name>t2dCollisionMaterialDatablock</name>
<base>t2dBaseDatablock</base>
<field>
<name>AutoMassInertia</name>
<desc>bool AutoMassInertia</desc>
</field>
<field>
<name>damping</name>
<desc>float damping</desc>
</field>
<field>
<name>Density</name>
<desc>float Density</desc>
</field>
<field>
<name>ForceScale</name>
<desc>float ForceScale</desc>
</field>
<field>
<name>Friction</name>
<desc>float Friction</desc>
</field>
<field>
<name>Immovable</name>
<desc>bool Immovable</desc>
</field>
<field>
<name>inertialmoment</name>
<desc>float inertialmoment</desc>
</field>
<field>
<name>Mass</name>
<desc>float Mass</desc>
</field>
<field>
<name>Restitution</name>
<desc>float Restitution</desc>
</field>
</class>
<class>
<name>t2dGunTurret</name>
<base>t2dActiveTile</base>
<method>
<name>setFrame</name>
<args>frame</args>
<desc>- Sets imageMap frame.</desc>
</method>
<method>
<name>setImageMap</name>
<args>imageMapName, [int frame]</args>
<desc>- Sets imageMap/Frame.</desc>
</method>
<method>
<name>setTrackObject</name>
<args>t2dSceneObject</args>
<desc>- Sets Object to Track.</desc>
</method>
</class>
<class>
<name>t2dImageMapDatablock</name>
<base>t2dBaseDatablock</base>
<method>
<name>compile</name>
<desc>Compile Image-Map.
@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>getFilterMode</name>
<desc>Get Filter Mode.
@return Returns the filter mode as a string</desc>
</method>
<method>
<name>getForce16Bit</name>
<desc>Get Force 16 bit flag.
@return Returns the flag as a boolean</desc>
</method>
<method>
<name>getFrameCount</name>
<desc>Get ImageMap Frame Count.
@return Returns the count as an integer</desc>
</method>
<method>
<name>getFrameSize</name>
<args>int frame</args>
<desc>- Get ImageMap Frame Size.
@param frame The number of the frame to check
@return Returns the frame's size as a string formatted as "width height"</desc>
</method>
<method>
<name>getFrameTexturePage</name>
<args>int frame</args>
<desc>- Get ImageMap Frame Texture Page.
@param frame The frame number
@return The image mapo texture page index.</desc>
</method>
<method>
<name>getImageMapMode</name>
<desc>Get ImageMap Mode.
@return Returns the mode as a string.</desc>
</method>
<method>
<name>getSrcBitmapName</name>
<desc>Get Source Bitmap Name.
@return Returns the bitmap name as a string.</desc>
</method>
<method>
<name>getSrcBitmapSize</name>
<desc>Get Source Bitmap Size.
@return Returns the size as a string formatted as "width height"</desc>
</method>
<method>
<name>getTexturePageCount</name>
<desc>Get ImageMap Texture-Page Count.
@return The number of texture-pages</desc>
</method>
<method>
<name>getTexturePageFrameCount</name>
<args>int texturePage</args>
<desc>- Get ImageMap Texture-Page Frame Count.
@param texturePage The index of the texturePage
@return Returns the numbers of frames in the page.</desc>
</method>
<method>
<name>getTexturePageSize</name>
<args>int texturePage</args>
<desc>- Get ImageMap Texture-Page Size.
@param texturePage The index of texture-page.
@return Returns the size of the object as a string formatted as "width height"</desc>
</method>
<method>
<name>setFilterMode</name>
<args>mode</args>
<desc>Set Filter Mode.
@return No return value.</desc>
</method>
<field>
<name>allowUnload</name>
<desc>bool allowUnload</desc>
</field>
<field>
<name>cellCountX</name>
<desc>int cellCountX</desc>
</field>
<field>
<name>cellCountY</name>
<desc>int cellCountY</desc>
</field>
<field>
<name>cellHeight</name>
<desc>int cellHeight</desc>
</field>
<field>
<name>cellOffsetX</name>
<desc>int cellOffsetX</desc>
</field>
<field>
<name>cellOffsetY</name>
<desc>int cellOffsetY</desc>
</field>
<field>
<name>cellRowOrder</name>
<desc>bool cellRowOrder</desc>
</field>
<field>
<name>cellStrideX</name>
<desc>int cellStrideX</desc>
</field>
<field>
<name>cellStrideY</name>
<desc>int cellStrideY</desc>
</field>
<field>
<name>cellWidth</name>
<desc>int cellWidth</desc>
</field>
<field>
<name>filterMode</name>
<desc>enumval filterMode</desc>
</field>
<field>
<name>filterPad</name>
<desc>bool filterPad</desc>
</field>
<field>
<name>force16Bit</name>
<desc>bool force16Bit</desc>
</field>
<field>
<name>frameCount</name>
<desc>int frameCount</desc>
</field>
<field>
<name>imageMode</name>
<desc>enumval imageMode</desc>
</field>
<field>
<name>imageName</name>
<desc>filename imageName</desc>
</field>
<field>
<name>linkImageMaps</name>
<desc>string linkImageMaps</desc>
</field>
<field>
<name>preferPerf</name>
<desc>bool preferPerf</desc>
</field>
<field>
<name>preload</name>
<desc>bool preload</desc>
</field>
</class>
<class>
<name>t2dParticleEffect</name>
<base>t2dSceneObject</base>
<method>
<name>addDataKey</name>
<args>time, value</args>
<desc>Add Data-Key to Graph.
@param time The time key
@param value The value at given time
@return Returns the index of the Data-Key or -1 on failure.</desc>
</method>
<method>
<name>addEmitter</name>
<args>emitter</args>
<desc>- Adds an Emitter to the Effect creating a new one if necessary.
@return On success it returns the ID of the emitter, or 0 if failed.</desc>
</method>
<method>
<name>clearDataKeys</name>
<desc>Clears all Data-Key(s) from Graph.
@return Returns true on success (false means you do not have a graph selected).</desc>
</method>
<method>
<name>clearEmitters</name>
<desc>Clear all Emitters from the Effect.
@return No return Value.</desc>
</method>
<method>
<name>findEmitterObject</name>
<args>emitterName$</args>
<desc>Finds Emitter Object by name from Effect.
@param emitterName The name of the desired effect emitter
@return The emitter's name as a string.</desc>
</method>
<method>
<name>findParticlePeak</name>
<args>searchTime, timeStep, peakLimit</args>
<desc>Finds the time of a particle effect at which there are a peak number of particles emitted.
@param searchTime The amount of time into the effect to search.
@param timeStep The time step at which the effect will be checked. Smaller time steps will give more accurate results, but take more time.
@param peakLimit The maximum number of particles to find. The search will stop when this number of particles is found.
@return On success it returns a string formatted as "true peakCount peakTime". On fail it returns "false"</desc>
</method>
<method>
<name>getDataKey</name>
<args>keyIndex</args>
<desc>Get Data-Key Time/Value from Graph.
@param keyIndex The index of the desired data-key
@return Returns the data-key as a string formatted as "time value" or false if failed</desc>
</method>
<method>
<name>getDataKeyCount</name>
<desc>@return Returns the current Data-Key count from selected graph (or false if failed).</desc>
</method>
<method>
<name>getEffectCollisionStatus</name>
<desc>@return Returns the effect collision status (true if effect processes collisions, or false if individual particles are).</desc>
</method>
<method>
<name>getEffectLifeMode</name>
<desc>@return Returns the Effect Life Mode (either INFINITE CYCLE KILL or STOP).</desc>
</method>
<method>
<name>getEmitterCount</name>
<desc>Gets Emitter Count for Effect.
@return Returns the number of emitters as an integer.</desc>
</method>
<method>
<name>getEmitterObject</name>
<args>emitterIndex</args>
<desc>Gets Emitter Object from Effect.
@param emitterIndex The index value for the desired emitter
@return The object ID</desc>
</method>
<method>
<name>getGraphValue</name>
<args>time</args>
<desc>Get value at given time from selected graph.
@param time The desired graph time step
@return Returns the value set at given time (or false if failed).</desc>
</method>
<method>
<name>getIsEffectPlaying</name>
<desc>@return Returns true if effect is playing</desc>
</method>
<method>
<name>getMaxTime</name>
<desc>@return Returns Max-Value from Graph (or false if failed).</desc>
</method>
<method>
<name>getMaxValue</name>
<desc>@return Max-Value from Graph (or false if failed).</desc>
</method>
<method>
<name>getMinTime</name>
<desc>@return Returns Min-Time from Graph (or false if failed).</desc>
</method>
<method>
<name>getMinValue</name>
<desc>@return Returns Min-Value from Graph (or false if failed).</desc>
</method>
<method>
<name>getTimeRepeat</name>
<desc>@return Returns Time-Repeat for Graph (or false if failed).</desc>
</method>
<method>
<name>getValueScale</name>
<desc>@return Returns Value-Scale for Graph (or false if failed).</desc>
</method>
<method>
<name>loadEffect</name>
<args>effectFile$</args>
<desc>Loads a Particle Effect.
@param effectFile File name from which to load desired effect
@return Returns true on success.</desc>
</method>
<method>
<name>moveEffectTo</name>
<args>moveTime, timeStep</args>
<desc>Moves an effect's playback to a particular time.
@param moveTime The time to move the effect to.
@param timeStep The time steps at which the effect will be processed in moving to the move time.
@return On success it returns a string formatted as "true peakCount peakTime". On fail it returns "false"</desc>
</method>
<method>
<name>moveEmitter</name>
<args>fromEmitterIndex, toEmitterIndex</args>
<desc>Moves the Emitter Object.
@param fromEmitterIndex Original index of desired emitter
@param toEmitterIndex Desired destination index.
@return No return value.</desc>
</method>
<method>
<name>playEffect</name>
<args>[resetParticles]</args>
<desc>Plays the Particle Effect.
@param resetParticles Flag for whether to reset particles before playback (default true)
@return Returns true on success and false otherwise</desc>
</method>
<method>
<name>removeDataKey</name>
<args>keyIndex</args>
<desc>Remove Data-Key from Graph.
@param keyIndex The index of the data-key you want to remove
@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>removeEmitter</name>
<args>emitterObject, [bool deleteEmitter]</args>
<desc>- Removes an Emitter from the Effect.
@return No return value.</desc>
</method>
<method>
<name>saveEffect</name>
<args>effectFile$</args>
<desc>Saves a Particle Effect to file.
@param effectFile The name of the file to save the effect to.
@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>selectGraph</name>
<args>graphName</args>
<desc>Select Graph by Name.
@param graphName Name of desired graph
@return No return value.</desc>
</method>
<method>
<name>setDataKeyValue</name>
<args>keyIndex, value</args>
<desc>Set Data-Key Value in Graph.
@param keyIndex The index of the key you wish to modify.
@param value The value you wish to reset the given data-key to.
@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>setEffectCollisionStatus</name>
<args>status</args>
<desc>Set the effect collision status.
@param status True if the effect as a whole is processing collisions, false if the individual particles are processing collisions.
@return No return value.</desc>
</method>
<method>
<name>setEffectLifeMode</name>
<args>lifeMode, [time]</args>
<desc>- Sets the Effect Life Mode/Time.
@param lifeMode The lifemode of the effect (either INFINITE CYCLE KILL or STOP)
@param time The lifetime of the effect. This has different effects depending on the life mode (required for CYCLE or KILL).@return No return value.</desc>
</method>
<method>
<name>setTimeRepeat</name>
<args>timeRepeat</args>
<desc>Set Time-Repeat For Graph.
@return Returns true on success (or false if failed).</desc>
</method>
<method>
<name>setValueScale</name>
<args>valueScale</args>
<desc>- Set Value-Scale For Graph.
@return Returns true on success (or false if failed).</desc>
</method>
<method>
<name>stopEffect</name>
<args>[waitForParticles?, killEffect?]</args>
<desc>- Stops the Particle Effect.
@param waitForParticles Whether or not the effect should wait until all of its particles have run their course, or just stop immediately and delete the particles (default true).
@param killEffect Whether or not the effect should be deleted after it has stopped (default false).
@return No return value.</desc>
</method>
<field>
<name>effectFile</name>
<desc>filename effectFile</desc>
</field>
<field>
<name>effectMode</name>
<desc>enumval effectMode</desc>
</field>
<field>
<name>effectTime</name>
<desc>float effectTime</desc>
</field>
<field>
<name>useEffectCollisions</name>
<desc>bool useEffectCollisions</desc>
</field>
</class>
<class>
<name>t2dParticleEmitter</name>
<base>SimObject</base>
<method>
<name>addDataKey</name>
<args>time, value</args>
<desc>- Add Data-Key to Graph.</desc>
</method>
<method>
<name>clearDataKeys</name>
<desc>Clear Data-Key(s) from Graph.</desc>
</method>
<method>
<name>getAlignAngleOffset</name>
<desc>Get Align-Orientation Angle-Offset.</desc>
</method>
<method>
<name>getAlignKeepAligned</name>
<desc>Get Align-Orientation Keep-Aligned Flag.</desc>
</method>
<method>
<name>getAnimationName</name>
<desc>Get Animation Name.</desc>
</method>
<method>
<name>getAttachPositionToEmitter</name>
<desc>Get Attach-Position-To-Emitter Flag.</desc>
</method>
<method>
<name>getAttachRotationToEmitter</name>
<desc>Get Attach-Rotation-To-Emitter Flag.</desc>
</method>
<method>
<name>getBlending</name>
<desc>Gets the Rendering Blend Options.</desc>
</method>
<method>
<name>getDataKey</name>
<args>keyIndex</args>
<desc>- Get Data-Key Time/Value from Graph.</desc>
</method>
<method>
<name>getDataKeyCount</name>
<desc>Get Data-Key Count from Graph.</desc>
</method>
<method>
<name>getEffectCollisionStatus</name>
<desc>Get the emitter collision status.</desc>
</method>
<method>
<name>getEmitterName</name>
<desc>Get the Emitters Name.</desc>
</method>
<method>
<name>getEmitterType</name>
<desc>Get Emitter Type.</desc>
</method>
<method>
<name>getFirstInFrontOrder</name>
<desc>Get First-In-Front-Order Flag.</desc>
</method>
<method>
<name>getFixedAngleOffset</name>
<desc>Get Fixed-Orientation Angle-Offset.</desc>
</method>
<method>
<name>getFixedAspect</name>
<desc>Get Fixed-Aspect.</desc>
</method>
<method>
<name>getFixedForceAngle</name>
<desc>Get Fixed-Force-Direction.</desc>
</method>
<method>
<name>getGraphValue</name>
<args>time</args>
<desc>- Get Value from Graph.</desc>
</method>
<method>
<name>getImageMapNameFrame</name>
<desc>Get ImageMap Name and Frame.</desc>
</method>
<method>
<name>getIntenseParticles</name>
<desc>Get Intense-Particles Flag.</desc>
</method>
<method>
<name>getLinkEmissionRotation</name>
<desc>Get Link-Emission-Rotation Flag.</desc>
</method>
<method>
<name>getMaxTime</name>
<desc>Get Max-Value from Graph.</desc>
</method>
<method>
<name>getMaxValue</name>
<desc>Get Max-Value from Graph.</desc>
</method>
<method>
<name>getMinTime</name>
<desc>Get Min-Time from Graph.</desc>
</method>
<method>
<name>getMinValue</name>
<desc>Get Min-Value from Graph.</desc>
</method>
<method>
<name>getParentEffect</name>
<desc>@return Returns the effect containing this emitter.</desc>
</method>
<method>
<name>getParticleOrientation</name>
<desc>Get Particle Orientation.</desc>
</method>
<method>
<name>getParticleOrientationMode</name>
<desc>Get Particle Orientation.</desc>
</method>
<method>
<name>getPivotPoint</name>
<desc>Get Pivot-Point.</desc>
</method>
<method>
<name>getRandomAngleOffset</name>
<desc>Get Random-Orientation Angle-Offset.</desc>
</method>
<method>
<name>getRandomArc</name>
<desc>Get Random-Orientation Arc.</desc>
</method>
<method>
<name>getSingleParticle</name>
<desc>Get Single-Particle Flag.</desc>
</method>
<method>
<name>getTimeRepeat</name>
<desc>Get Time-Repeat for Graph.</desc>
</method>
<method>
<name>getUseEffectEmission</name>
<desc>Get Use-Effect-Emission Flag.</desc>
</method>
<method>
<name>getUsingAnimation</name>
<desc>Get Using Animation Flag.</desc>
</method>
<method>
<name>getValueScale</name>
<desc>Get Value-Scale for Graph.</desc>
</method>
<method>
<name>getVisible</name>
<desc>Get the Emitters Visibility.</desc>
</method>
<method>
<name>loadEmitter</name>
<args>emitterFile$</args>
<desc>- Loads a Particle Emitter.</desc>
</method>
<method>
<name>removeDataKey</name>
<args>keyIndex</args>
<desc>- Remove Data-Key from Graph.</desc>
</method>
<method>
<name>saveEmitter</name>
<args>emitterFile$</args>
<desc>- Save a Particle Emitter.</desc>
</method>
<method>
<name>selectGraph</name>
<args>graphName</args>
<desc>- Select Graph Name.</desc>
</method>
<method>
<name>setAlignAngleOffset</name>
<args>alignAngleOffset</args>
<desc>- Set Align-Orientation Angle Offset.</desc>
</method>
<method>
<name>setAlignKeepAligned</name>
<args>keepAligned</args>
<desc>- Set Align-Orientation Keep-Aligned Flag.</desc>
</method>
<method>
<name>setAnimationName</name>
<args>animationName$</args>
<desc>- Set the Animation.</desc>
</method>
<method>
<name>setAttachPositionToEmitter</name>
<args>attachPositionToEmitter</args>
<desc>- Set Attach-Position-To-Emitter Flag.</desc>
</method>
<method>
<name>setAttachRotationToEmitter</name>
<args>attachRotationToEmitter</args>
<desc>- Set Attach-Rotation-To-Emitter Flag.</desc>
</method>
<method>
<name>setBlending</name>
<args>blendStatus?, [srcBlendFactor], [dstBlendFactor]</args>
<desc>- Sets the Rendering Blend Options.</desc>
</method>
<method>
<name>setDataKeyValue</name>
<args>keyIndex, value</args>
<desc>- Set Data-Key Value in Graph.</desc>
</method>
<method>
<name>setEmitterCollisionStatus</name>
<desc>Set the emitter collision status.</desc>
</method>
<method>
<name>setEmitterName</name>
<args>emitterName$</args>
<desc>- Set the Emitters Name.</desc>
</method>
<method>
<name>setEmitterType</name>
<args>emitterType$</args>
<desc>- Set Emitter Type.</desc>
</method>
<method>
<name>setFirstInFrontOrder</name>
<args>firstInFrontOrder</args>
<desc>- Set First-InFront-Order Flag.</desc>
</method>
<method>
<name>setFixedAngleOffset</name>
<args>randomAngle</args>
<desc>- Set Fixed-Orientation Angle-Offset.</desc>
</method>
<method>
<name>setFixedAspect</name>
<args>fixedAspect</args>
<desc>- Set Fixed-Aspect.</desc>
</method>
<method>
<name>setFixedForceAngle</name>
<args>fixedForceAngle</args>
<desc>- Set Fixed-Force Angle.</desc>
</method>
<method>
<name>setImageMap</name>
<args>imageMapName$, [int frame]</args>
<desc>- Set the ImageMap/Frame.</desc>
</method>
<method>
<name>setIntenseParticles</name>
<args>intenseParticles</args>
<desc>- Set Intense-Particles Flag.</desc>
</method>
<method>
<name>setLinkEmissionRotation</name>
<args>linkEmissionRotation</args>
<desc>- Set Link-Emission-Rotation Flag.</desc>
</method>
<method>
<name>setParticleOrientationMode</name>
<args>particleOrientationMode$</args>
<desc>- Set Particle Orientation.</desc>
</method>
<method>
<name>setPivotPoint</name>
<args>pivotX / pivotY</args>
<desc>- Set the Pivot-Point.</desc>
</method>
<method>
<name>setRandomAngleOffset</name>
<args>randomAngle</args>
<desc>- Set Random-Orientation Angle-Offset.</desc>
</method>
<method>
<name>setRandomArc</name>
<args>randomArc</args>
<desc>- Set Random-Orientation Arc.</desc>
</method>
<method>
<name>setSingleParticle</name>
<args>singleParticle</args>
<desc>- Set Single-Particle Flag.</desc>
</method>
<method>
<name>setTimeRepeat</name>
<args>timeRepeat</args>
<desc>- Set Time-Repeat for Graph.</desc>
</method>
<method>
<name>setUseEffectEmission</name>
<args>useEffectEmission</args>
<desc>- Set Use-Effect-Emission Flag.</desc>
</method>
<method>
<name>setValueScale</name>
<args>valueScale</args>
<desc>- Set Value-Scale For Graph.</desc>
</method>
<method>
<name>setVisible</name>
<args>status?</args>
<desc>- Set the Emitters Visibility.</desc>
</method>
</class>
<class>
<name>t2dPath</name>
<base>t2dSceneObject</base>
<method>
<name>addNode</name>
<args>position, [location], [rotation], [weight]</args>
<desc>Add node to path
@param position Spatial position of node.
@param location Where in path array it should be placed (default -1 ie beginning)
@param rotation The rotation of the node.
@param weight The weight of the node
@return Returns the node count</desc>
</method>
<method>
<name>attachObject</name>
<args>obj, speed, [dir], [start], [end], [pathMode], [loops], [sendToStart]</args>
<desc>Attach an object to the path
@param obj The object to attach.
@param speed The movement speed along path.
@param [dir] The direction of movement, either positive or negative (default positive).
@param [start] The start point (default 0)
@param [end] The end point (default 0)
@param [pathMode] The path mode (default T2D_PATH_WRAP)
@param [loops] Number of loops to make around path (default 0)
@param [sendToStart] Start position at startnode (default false)
@return No return value.</desc>
</method>
<method>
<name>clear</name>
<desc>Clears all nodes in Path
@return No return value.</desc>
</method>
<method>
<name>detachObject</name>
<args>object</args>
<desc>Detach object from path
@param object The object to detach.
@return No return value.</desc>
</method>
<method>
<name>getAttachedObject</name>
<args>S32 index</args>
<desc>@return Returns the object at the specified index.</desc>
</method>
<method>
<name>getAttachedObjectCount</name>
<desc>@return Returns the number of objects attached to the path.</desc>
</method>
<method>
<name>getEndNode</name>
<args>object</args>
<desc>Gets the end node on path for given object.
@param object Object to get path setting
@return Returns the node index of the end node.</desc>
</method>
<method>
<name>getFollowMode</name>
<args>object</args>
<desc>Gets the follow mode of the object on path
@param object Object to get path setting
@return Returns the follow mode of the object.</desc>
</method>
<method>
<name>getLoops</name>
<args>object</args>
<desc>Gets the number of loops of the object on path
@param object Object to get path setting
@return Returns the number of loops of the object.</desc>
</method>
<method>
<name>getMoveForward</name>
<args>object</args>
<desc>Gets the direction on path for given object.
@param object Object to get path setting
@return Returns the direction of the object (1 is forward, -1 backward).</desc>
</method>
<method>
<name>getNode</name>
<args>index</args>
<desc>Gets the nodes position, rotation, and weight.
@param index The index of the node to get information for.
@return Returns the position, rotation, and weight formatted as "pos rot weight"</desc>
</method>
<method>
<name>getNodeCount</name>
<desc>@return Returns the number of nodes in path</desc>
</method>
<method>
<name>getOrient</name>
<args>object</args>
<desc>Gets the orientation on path for given object.
@param object Object to get path setting
@return Returns the orientation of the object.</desc>
</method>
<method>
<name>getPathType</name>
<desc>Gets the interpolation type.
@return Returns the interpolation type as a string.</desc>
</method>
<method>
<name>getRotationOffset</name>
<args>object</args>
<desc>Gets the rotation offset of object on path
@param object Object to get path setting
@return Returns the offset of the object.</desc>
</method>
<method>
<name>getSpeed</name>
<args>object</args>
<desc>Gets the speed on path for given object.
@param object Object to get path setting
@return Returns the speed of the object.</desc>
</method>
<method>
<name>getStartNode</name>
<args>object</args>
<desc>Gets the start node on path for given object.
@param object Object to get path setting
@return Returns the node index of the start node.</desc>
</method>
<method>
<name>removeNode</name>
<args>index</args>
<desc>Removes the node at given index
@return Returns node count.</desc>
</method>
<method>
<name>setEndNode</name>
<args>object, node</args>
<desc>Sets the end node on path for given object.
@param object Object to modify path settings
@param node Node to set as end
@return No return value.</desc>
</method>
<method>
<name>setFollowMode</name>
<args>object, pathMode</args>
<desc>Sets the follow mode on path for given object.
@param object Object to modify path settings
@param pathMode Desired follow style for object
@return No return value.</desc>
</method>
<method>
<name>setLoops</name>
<args>object, loops</args>
<desc>Sets the loop number on path for given object.
@param object Object to modify path settings
@param loops Desired number of loops
@return No return value.</desc>
</method>
<method>
<name>setMoveForward</name>
<args>object, forward</args>
<desc>Sets the direction to forward (or not) on path for given object.
@param object Object to modify path settings
@param forward Bool. Whether to set direction as forward
@return No return value.</desc>
</method>
<method>
<name>setOrient</name>
<args>object, orient</args>
<desc>Sets the orientation for given object.
@param object Object to modify path settings
@param orient Object orientation
@return No return value.</desc>
</method>
<method>
<name>setPathType</name>
<args>type</args>
<desc>Sets the interpolation type for the path.
@param type Interpolation type (either LINEAR, BEZIER, CATMULL, or CUSTOM)
@return No return value.</desc>
</method>
<method>
<name>setRotationOffset</name>
<args>object, offset</args>
<desc>Sets the offset on path for given object.
@param object Object to modify path settings
@param offset Desired offset
@return No return value.</desc>
</method>
<method>
<name>setSpeed</name>
<args>object, speed</args>
<desc>Sets the speed on path for given object.
@param object Object to modify path settings
@param speed Desired speed
@return No return value.</desc>
</method>
<method>
<name>setStartNode</name>
<args>object, node</args>
<desc>Sets the start node on path for given object.
@param object Object to modify path settings
@param node Node to set as start
@return No return value.</desc>
</method>
<field>
<name>pathModeEnum</name>
<desc>enumval pathModeEnum</desc>
</field>
<field>
<name>pathType</name>
<desc>enumval pathType</desc>
</field>
</class>
<class>
<name>t2dSceneGraph</name>
<base>SimSet</base>
<method>
<name>addToScene</name>
<args>object</args>
<desc>Add t2dSceneObject to Scene.
@param object The t2dSceneObject's ID
@return No return value.</desc>
</method>
<method>
<name>clearScene</name>
<args>[deleteObjects]</args>
<desc>Clear Scene of all t2dSceneObject objects.
@param deleteObjects A boolean flag that sets whether to delete the objects as well as remove them from the scene (default is true).
@return No return value.</desc>
</method>
<method>
<name>getConstantForce</name>
<desc>Gets the scene constant-force.
@return Returns the scene's set constant force in Cartesian coordinatesas a string formatted as "forceX forceY"</desc>
</method>
<method>
<name>getDebugOn</name>
<args>debugMode</args>
<desc>Gets the state of the debug mode
@param The specific debug mode to check active state of.
@return Returns true if active, false if not.</desc>
</method>
<method>
<name>getGlobalTileMap</name>
<desc>@return Returns the ID of the scene graph's global tile map.</desc>
</method>
<method>
<name>getSceneObject</name>
<args>objectIndex</args>
<desc>Gets the selected Scene Object.
@param objectIndex The index of the desired object
@return The ID of the object.</desc>
</method>
<method>
<name>getSceneObjectCount</name>
<desc>Gets the Scene Object-Count.
@return Returns the number of scene objects in current scenegraph as an integer.</desc>
</method>
<method>
<name>getSceneObjectList</name>
<desc>Gets the Scene Object-List.
@return Returns a string with a list of object IDs</desc>
</method>
<method>
<name>getScenePause</name>
<desc>Gets scene pause status.
@return Returns a boolean value. True if pause status, false otherwise.</desc>
</method>
<method>
<name>getSceneTime</name>
<desc>Gets the Scene Graph Time.
@return Returns the time as a floating point number</desc>
</method>
<method>
<name>initialise</name>
<args>containerBinSize, containerBinCount, useLayerSorting, lastInFrontSorting</args>
<desc>Initialise Scene Graph.
@param containerBinSize The desired size of the scene graph's bins.
@param containerBinCount The number of bins to create
@param useLayerSorting Boolean flag to set whether to use by-layer sorting.
@param lastInFrontSorting Boolean flag to set whather to set the last item in the list to render in front of those before it
@return No return value.</desc>
</method>
<method>
<name>loadScene</name>
<args>file</args>
<desc>Loads a Scene from a Disk File.
@param file The name of the scene file to load.
@return Returns true on success, false otherwise (ie filenotfound or unable to open for read)</desc>
</method>
<method>
<name>performPostInit</name>
<desc>Performs mount and other post initialization tasks
@return No return value.</desc>
</method>
<method>
<name>pickLine</name>
<args>startx/y, endx/y, [groupMask], [layerMask], [showInvisible?], [excludeObject] </args>
<desc>Picks objects intersecting line with optional group/layer masks.
@param startx/y The coordinates of the start point as either ("x y") or (x,y)
@param endx/y The coordinates of the end point as either ("x y") or (x,y)
@param groupMask Optional group mask.
@param layerMask Optional layer mask.
@param showInvisible Object visibility setting
@param excludeObject Object to exclude from check
@return Returns list of object IDs or NULL on failure</desc>
</method>
<method>
<name>pickPoint</name>
<args>x / y, [groupMask], [layerMask], [showInvisible?], [excludeObject] </args>
<desc>Picks objects intersecting point with optional group/layer masks.
@param x/y The coordinate of the point as either ("x y") or (x,y)
@param groupMask Optional group mask.
@param layerMask Optional layer mask.
@param showInvisible Object visibility setting
@param excludeObject Object to exclude from check
@return Returns list of object IDs or NULL on failure</desc>
</method>
<method>
<name>pickRadius</name>
<args>x / y, radius, [groupMask], [layerMask], [showInvisible?], [excludeObject] </args>
<desc>Picks objects intersecting circle with optional group/layer masks.
@param x/y The coordinates of the center point as either ("x y") or (x,y)
@param radius The radius of the circular region
@param groupMask Optional group mask.
@param layerMask Optional layer mask.
@param showInvisible Object visibility setting
@param excludeObject Set whether to exclude object from list.
@return Returns list of object IDs or NULL on failure</desc>
</method>
<method>
<name>pickRect</name>
<args>startx/y, endx/y, [groupMask], [layerMask], [showInvisible?], [excludeObject] </args>
<desc>Picks objects intersecting rectangle with optional group/layer masks.
@param startx/y The coordinates of the start point as either ("x y") or (x,y)
@param endx/y The coordinates of the end point as either ("x y") or (x,y)
@param groupMask Optional group mask.
@param layerMask Optional layer mask.
@param showInvisible Object visibility setting
@param excludeObject Set whether to exclude object from list.
@return Returns list of object IDs or NULL on failure</desc>
</method>
<method>
<name>removeFromScene</name>
<args>object</args>
<desc>Remove t2dSceneObject from Scene.
@param object The ID of the t2dSceneObject.
@return No return value.</desc>
</method>
<method>
<name>resizeContainerBins</name>
<args>containerBinSize, containerBinCount</args>
<desc>Resize Container Bins.
@param containerBinSize The desired size of the scene graph's bins.
@param containerBinCount The number of bins to create
@return No return value.</desc>
</method>
<method>
<name>saveScene</name>
<args>file</args>
<desc>Saves a Scene to a Disk File.
@param file Name of file to write to.
@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>setConstantForce</name>
<args>forceX / forceY, [gravitic]</args>
<desc>Apply a continuous force.
@param forceX/forceY The direction and magnitude of the force in each direction. Formatted as either ("forceX forceY") or (forceX, forceY)
@param gravitic An optional boolean flag for whether the force is gravitic in nature (default is false).
@return No return value.</desc>
</method>
<method>
<name>setConstantForcePolar</name>
<args>angle, force, [gravitic?]</args>
<desc>Apply a continuous polar force.
@param angle The angle component of the force (polar form)
@param force The polar magnitude of the force.
@param gravitic An optional boolean flag for whether the force is gravitic in nature (default is false).
@return No return value.</desc>
</method>
<method>
<name>setDebugOff</name>
<args>debugMask</args>
<desc>Sets Debug Off Mode(s).
@param debugMask Either a list of debug modes to turn off (comma separated) or a string (space separated)
@return No return value.</desc>
</method>
<method>
<name>setDebugOn</name>
<args>debugMask</args>
<desc>Sets Debug On Mode(s).
@param debugMask Either a list of debug modes (comma separated), or a string with the modes (space separated)
@return No return value.</desc>
</method>
<method>
<name>setLayerDrawOrder</name>
<args>object, orderCommand</args>
<desc>Sets the Layer Draw Order for Specified Object.
@param object The ID of the desired t2dSceneObject
@param orderCommand A mnemonic representing the ordering option (FRONT, BACK, FORWARD, BACKWARD)
@return Returns true on success.</desc>
</method>
<method>
<name>setSceneDrawOrder</name>
<args>object, orderCommand</args>
<desc>Sets the Scene Draw Order for Specified Object.
@param object The ID of the desired t2dSceneObject
@param orderCommand A mnemonic representing the ordering option (FRONT, BACK, FORWARD, BACKWARD)
@return Return true on success.</desc>
</method>
<method>
<name>setScenePause</name>
<args>status</args>
<desc>Sets scene pause status.
@return No return value.</desc>
</method>
<method>
<name>stopConstantForce</name>
<desc>Stops any continuous force.
@return No return value.</desc>
</method>
<field>
<name>config</name>
<desc>t2dBaseDatablock config</desc>
</field>
<field>
<name>DebugRendering</name>
<desc>int DebugRendering</desc>
</field>
<field>
<name>layerSortMode0</name>
<desc>enumval layerSortMode0</desc>
</field>
<field>
<name>layerSortMode1</name>
<desc>enumval layerSortMode1</desc>
</field>
<field>
<name>layerSortMode10</name>
<desc>enumval layerSortMode10</desc>
</field>
<field>
<name>layerSortMode11</name>
<desc>enumval layerSortMode11</desc>
</field>
<field>
<name>layerSortMode12</name>
<desc>enumval layerSortMode12</desc>
</field>
<field>
<name>layerSortMode13</name>
<desc>enumval layerSortMode13</desc>
</field>
<field>
<name>layerSortMode14</name>
<desc>enumval layerSortMode14</desc>
</field>
<field>
<name>layerSortMode15</name>
<desc>enumval layerSortMode15</desc>
</field>
<field>
<name>layerSortMode16</name>
<desc>enumval layerSortMode16</desc>
</field>
<field>
<name>layerSortMode17</name>
<desc>enumval layerSortMode17</desc>
</field>
<field>
<name>layerSortMode18</name>
<desc>enumval layerSortMode18</desc>
</field>
<field>
<name>layerSortMode19</name>
<desc>enumval layerSortMode19</desc>
</field>
<field>
<name>layerSortMode2</name>
<desc>enumval layerSortMode2</desc>
</field>
<field>
<name>layerSortMode20</name>
<desc>enumval layerSortMode20</desc>
</field>
<field>
<name>layerSortMode21</name>
<desc>enumval layerSortMode21</desc>
</field>
<field>
<name>layerSortMode22</name>
<desc>enumval layerSortMode22</desc>
</field>
<field>
<name>layerSortMode23</name>
<desc>enumval layerSortMode23</desc>
</field>
<field>
<name>layerSortMode24</name>
<desc>enumval layerSortMode24</desc>
</field>
<field>
<name>layerSortMode25</name>
<desc>enumval layerSortMode25</desc>
</field>
<field>
<name>layerSortMode26</name>
<desc>enumval layerSortMode26</desc>
</field>
<field>
<name>layerSortMode27</name>
<desc>enumval layerSortMode27</desc>
</field>
<field>
<name>layerSortMode28</name>
<desc>enumval layerSortMode28</desc>
</field>
<field>
<name>layerSortMode29</name>
<desc>enumval layerSortMode29</desc>
</field>
<field>
<name>layerSortMode3</name>
<desc>enumval layerSortMode3</desc>
</field>
<field>
<name>layerSortMode30</name>
<desc>enumval layerSortMode30</desc>
</field>
<field>
<name>layerSortMode31</name>
<desc>enumval layerSortMode31</desc>
</field>
<field>
<name>layerSortMode4</name>
<desc>enumval layerSortMode4</desc>
</field>
<field>
<name>layerSortMode5</name>
<desc>enumval layerSortMode5</desc>
</field>
<field>
<name>layerSortMode6</name>
<desc>enumval layerSortMode6</desc>
</field>
<field>
<name>layerSortMode7</name>
<desc>enumval layerSortMode7</desc>
</field>
<field>
<name>layerSortMode8</name>
<desc>enumval layerSortMode8</desc>
</field>
<field>
<name>layerSortMode9</name>
<desc>enumval layerSortMode9</desc>
</field>
<field>
<name>UseLayerSorting</name>
<desc>bool UseLayerSorting</desc>
</field>
</class>
<class>
<name>t2dSceneGraphDatablock</name>
<base>t2dBaseDatablock</base>
<field>
<name>containerBinCount</name>
<desc>int containerBinCount</desc>
</field>
<field>
<name>containerBinSize</name>
<desc>float containerBinSize</desc>
</field>
<field>
<name>lastInFrontSorting</name>
<desc>bool lastInFrontSorting</desc>
</field>
<field>
<name>UseLayerSorting</name>
<desc>bool UseLayerSorting</desc>
</field>
</class>
<class>
<name>t2dSceneObject</name>
<base>BehaviorComponent</base>
<method>
<name>addLinkPoint</name>
<args>[float offsetX / float offsetY]</args>
<desc>- Adds a Link-Point.
@param offsetX the local x offset to create the point at.
@param offsetY the local y offset to create the point at.
@return (integer linkPointID) The link point ID if created properly, otherwise -1.</desc>
</method>
<method>
<name>addToScene</name>
<args>t2dSceneGraph scenegraph</args>
<desc>Add the object to a scenegraph.
@param scenegraph the scenegraph you wish to add this object to.@return No return value.</desc>
</method>
<method>
<name>attachGui</name>
<args>guiControl guiObject, t2dSceneWindow window, [sizeControl? = false]</args>
<desc>- Attach a GUI Control to the object.
@param guiObject The GuiControl to attach.
@param window The t2dSceneWindow to bind the GuiControl to.
@param sizeControl Whether or not to size the GuiControl to the size of this object.
@return No return Value.</desc>
</method>
<method>
<name>behavior</name>
<args>string behaviorName</args>
<desc>- Gets the behavior instance ID off of the object based on the behavior name passed.
@param behaviorName The name of the behavior you want to get the instance ID of.
@return (integer behaviorID) The id of the behavior instance.</desc>
</method>
<method>
<name>castCollision</name>
<args>float elapsedTime</args>
<desc>- Returns collision details for object over elapsed-time.
@param elapsedTime The number of seconds into the future to check for collisions. If this number is 0.0, the collision will be done based on the current position of all objects. If it is greater than 0.0, the engine will perform the collision detection across a simulated time period of length %time and return the first collision detected.
@return (space seperated list) If no collision occurs, the return value is an empty string. Otherwise, the list is in the form 'object time contactX contactY normalX normalY'. 'object' is the object collided with, 'time' is the number of seconds in the future the collision took place as a float (this number will always be less than the %time parameter), 'contact' is the position the objects collided at as a vector, and 'normal' is the normal of the collision as a vector.</desc>
</method>
<method>
<name>castCollisionList</name>
<args>float elapsedTime</args>
<desc>- Returns list of objects collided with over elapsed-time.
@param elapstedTime The number of seconds into the future to check for collisions. If this number is 0.0, the collision will be done based on the current position of all objects. If it is greater than 0.0, the engine will perform the collision detection across a simulated time period of length %time and return the first collision detected.
@return (space seperated list) The objects that would be collided with.</desc>
</method>
<method>
<name>clone</name>
<args>bool copyFields? = false</args>
<desc>- Clone Object.
@param copyFields Whether or not to copy the dynamic fields of the object to the newly cloned object.@return (integer newObjectID) The newly cloned object's id if successful, otherwise a 0.</desc>
</method>
<method>
<name>cloneWithBehaviors</name>
<args>bool disable? = false</args>
<desc>- Clones the object and its behaviors.
@param disable Optional argument that controls if the newly created object is enabled. Defaults to true.@return (newObjectID) The newly cloned object's id if successful, otherwise a 0.</desc>
</method>
<method>
<name>copy</name>
<args>t2dSceneObject object, [copyFields? = false]</args>
<desc>- Copies one object from another.
The object being copied to needs to be of the same class as the object being copied from.
@param object The t2dSceneObject to copy this object to.
@param copyFields Specifies whether or not the object's dynamic fields should be copied to the new object.
@return (bool) Whether or not the copy was successful.</desc>
</method>
<method>
<name>detachGui</name>
<desc>- Detach any GUI Control.
@return No return Value.</desc>
</method>
<method>
<name>disableUpdateCallback</name>
<desc>- Disables calling of the onUpdate callback
@return No return Value.</desc>
</method>
<method>
<name>dismount</name>
<desc>- Dismounts object.
@return (bool dismounted) Returns true if it properly dismounted, false if it didn't.</desc>
</method>
<method>
<name>enableUpdateCallback</name>
<desc>- Enables calling of the onUpdate callback
@return No return Value.</desc>
</method>
<method>
<name>getAllLinkpointIDs</name>
<desc>- Gets the linkpoint IDs of the linkpoints on this object.
@return (list mountedChildren) The space-separated list of LinkpointIDs this has</desc>
</method>
<method>
<name>getAllMountedChildren</name>
<desc>- Gets the objects mounted to this object.
@return (list mountedChildren) The space-separated list of objects mounted to this object</desc>
</method>
<method>
<name>getAngularVelocity</name>
<desc>- Gets Object Angular Velocity.
@return (float velocity) The speed at which the object is rotating.</desc>
</method>
<method>
<name>getArea</name>
<desc>Gets the object's area.
@return (float x1/float y1/float x2/float y2) A space seperated list of the upper left corner x and y position and the lower right corner x and y positions.</desc>
</method>
<method>
<name>getAreaMax</name>
<args>float x2/float y2</args>
<desc>The lower right corner x and y position of the object.</desc>
</method>
<method>
<name>getAreaMin</name>
<desc>Gets the upper left point of the object.
@return (float x1/float y1) The upper left corner x and y position of the object.</desc>
</method>
<method>
<name>getAtRest</name>
<desc>- Gets whether the Object is at Rest.
@return (bool atRest) Whether or not the object is at rest.</desc>
</method>
<method>
<name>getAttachedToPath</name>
<desc>- Gets the t2dPath that this object is attached to.
@return (t2dPath path) The path that this object is attached to, or 0 if it is not attached to a path.</desc>
</method>
<method>
<name>getAutoMassInertia</name>
<desc>- Gets Object Auto Mass/Inertia Mode.
@return (bool status) Whether or not to auto calculate the mass and inertia.</desc>
</method>
<method>
<name>getAutoMountRotation</name>
<desc>Gets the objects auto mount rotation.
@return float (autoMountRotationSpeed) The auto mount rotation speed.</desc>
</method>
<method>
<name>getAutoRotation</name>
<desc>Gets the objects auto rotation.
@return (float autoRotationSpeed) The object's auto rotation speed.</desc>
</method>
<method>
<name>getBlendAlpha</name>
<desc>- Gets the Rendering Alpha (transparency).
@return (float alpha) The alpha value, a range from 0.0 to 1.0.</desc>
</method>
<method>
<name>getBlendColor</name>
<args>float red / float green / float blue / float alpha</args>
<desc>The red, green, blue, and alpha values of this object's blending color (a range from 0.0 to 1.0).</desc>
</method>
<method>
<name>getBlendColour</name>
<desc>- Gets the Rendering Blend Colour.
@return (float red / float green / float blue / float alpha) The red, green, blue, and alpha values of this object's blending color (a range from 0.0 to 1.0).</desc>
</method>
<method>
<name>getBlending</name>
<desc>- Gets the Rendering Blend Options.
@return (bool blendStatus / srcBlendFactor / dstBlendFactor) Whether or not the blending is enabled as well as the source and destination blending factors.</desc>
</method>
<method>
<name>getBlendingStatus</name>
<desc>- Returns the blending status.
@return (bool status) Whether or not the object is using blending.</desc>
</method>
<method>
<name>getChildrenOfLinkpoint</name>
<args>int linkpoint</args>
<desc>- Gets the objects mounted to this object on the specified linkpoint.
@return (list mountedChildren) The space-separated list of objects mounted to this object at that linkpoint</desc>
</method>
<method>
<name>getCollisionActive</name>
<desc>Gets the collision active directions.</desc>
</method>
<method>
<name>getCollisionActiveReceive</name>
<args>bool recieve</args>
<desc>The receive collision active status.</desc>
</method>
<method>
<name>getCollisionActiveSend</name>
<args>bool send</args>
<desc>The send collision active status.</desc>
</method>
<method>
<name>getCollisionCallback</name>
<desc>Gets the collision callback status.
@return (bool status) Whether or not the collision callback will be called.</desc>
</method>
<method>
<name>getCollisionCircleScale</name>
<args>float scale</args>
<desc>The circle scale factor.</desc>
</method>
<method>
<name>getCollisionCircleSuperscribed</name>
<desc>Gets the current setting for the superscript mode.@return Returns true if the mode if active, false if not.</desc>
</method>
<method>
<name>getCollisionDetection</name>
<desc>Get the Collision-Detection mode.
@return (string detectionMode) The current collision detection mode, see setCollisionDetection() for the modes.</desc>
</method>
<method>
<name>getCollisionGroups</name>
<desc>- Gets the collision groups.
@return (collisionGroups) A list of collision groups.</desc>
</method>
<method>
<name>getCollisionLayers</name>
<desc>- Gets the collision layers.
@return (collisionLayers) A list of collision layers.</desc>
</method>
<method>
<name>getCollisionMasks</name>
<args>groupMask/layerMask</args>
<desc>The Graph Groups and Rendering Layers the object is enabled to collide with.</desc>
</method>
<method>
<name>getCollisionMaxIterations</name>
<desc>Gets the Objects Maximum Collision Iterations.
Gets the maximum number of iterations that will be taken through the collision detection and resolution systems in a single frame.
@return (integer iterationCount) the max number of iterations.</desc>
</method>
<method>
<name>getCollisionPhysics</name>
<desc>Gets the collision physics directions.
@return (bool send/bool recieve) The send and receive physics status.</desc>
</method>
<method>
<name>getCollisionPhysicsReceive</name>
<desc>Gets the collision physics receive status.
@return (bool recieve) The receive physics status.</desc>
</method>
<method>
<name>getCollisionPhysicsSend</name>
<desc>Gets the collision physics send status.
@return (bool send) The send physics status.</desc>
</method>
<method>
<name>getCollisionPoly</name>
<args>poly-Definition</args>
<desc>The vertices of the collision polygon in object space.</desc>
</method>
<method>
<name>getCollisionPolyCount</name>
<args>integer poly-count</args>
<desc>The edge count of the collision polygon.</desc>
</method>
<method>
<name>getCollisionPolyScale</name>
<desc>Gets the collision-polygon Scale.
@return (float widthScale/float heightScale) The width and height poly scale values.</desc>
</method>
<method>
<name>getCollisionResponse</name>
<desc>Get the Collision-Response mode.
@return (responseMode) The current collision response mode, see setCollisionResponse for the modes.</desc>
</method>
<method>
<name>getCollisionSuppress</name>
<desc>Gets the collision suppress status.
@return (bool status) Whether to supress the collision or not.</desc>
</method>
<method>
<name>getConfigDatablock</name>
<desc>- Gets the configuration datablock this object is using.
@return (configDatablock) The configuration datablock name.</desc>
</method>
<method>
<name>getConstantForce</name>
<desc>- Gets the objects constant-force.
@return (float forceX / float forceY) The x and y components of the constant force.</desc>
</method>
<method>
<name>getConstantForceX</name>
<desc>@return (float forceX) The x component of the constant force.</desc>
</method>
<method>
<name>getConstantForceY</name>
<desc>@return (float forceY) The y component of the constant force.</desc>
</method>
<method>
<name>getDamping</name>
<desc>- Gets Object Damping.
@return (float damping) The damping value of the object.</desc>
</method>
<method>
<name>getDensity</name>
<desc>- Gets Object Density.
@return (float density) The density value of the object.</desc>
</method>
<method>
<name>getDstBlendFactor</name>
<desc>- Returns the dst blend factor.
@return (dstBlend) The destination blend factor.</desc>
</method>
<method>
<name>getFlip</name>
<desc>Gets the flip for each axis.
@return (bool flipX/bool flipY) Whether or not the object is flipped along the x and y axis.</desc>
</method>
<method>
<name>getFlipX</name>
<desc>Gets whether or not the object is flipped horizontally.
@return (bool flipX) Whether or not the object is flipped along the x axis.</desc>
</method>
<method>
<name>getFlipY</name>
<desc>Gets whether or not the object is flipped vertically.@return (bool flipY) Whether or not the object is flipped along the y axis.</desc>
</method>
<method>
<name>getForceScale</name>
<desc>- Gets the objects force-scale.
@return (float scale) The scale factor.</desc>
</method>
<method>
<name>getForwardMovementOnly</name>
<desc>Gets the object forward movement only status.
@return (bool forwardMovementOnly) Whether or not the object should only move forward.</desc>
</method>
<method>
<name>getFriction</name>
<desc>- Gets Object Friction.
@return (float friction) The friction value of the object.</desc>
</method>
<method>
<name>getGraphGroup</name>
<desc>Gets the Objects Group.
@return (integer group) The group the object is on.</desc>
</method>
<method>
<name>getGraviticConstantForce</name>
<desc>@return (bool gravitic) Whether the constant force is gravitic or not.</desc>
</method>
<method>
<name>getHeight</name>
<desc>Gets the height of the object.
@return (float height) The height of the object.</desc>
</method>
<method>
<name>getImmovable</name>
<desc>- Gets the immovable status.
@return (bool status) Whether or not the object is immovable.</desc>
</method>
<method>
<name>getInertialMoment</name>
<desc>- Gets Object Inertial Moment.
@return (float intertia) The intertia value of the object.</desc>
</method>
<method>
<name>getIsChild</name>
<desc>Gets the objects Child status.
@return (bool isChild) Whether or not the object is a child.</desc>
</method>
<method>
<name>getIsMounted</name>
<desc>- Get 'Is Mounted' Status.
@return (bool isMounted) Whether or not the object is mounted.</desc>
</method>
<method>
<name>getIsPointInObject</name>
<args>worldX, worldY</args>
<desc>- Returns whether point intersects with object.
@param worldX The x component of the world position to check.
@param worldY The y component of the world position to check.
@return (bool isInside) True if the point is inside the object, false otherwise.</desc>
</method>
<method>
<name>getLayer</name>
<desc>Gets the Objects Layer.
@return (integer layer) The layer the object is on.</desc>
</method>
<method>
<name>getLifetime</name>
<desc>Gets the Objects Lifetime.
@return (float lifetime) The objects lifetime left before it is automatically deleted.</desc>
</method>
<method>
<name>getLinearVelocity</name>
<desc>- Gets Object Linear Velocity.
@return (float velocityX, float velocityY) The x and y velocities of the object.</desc>
</method>
<method>
<name>getLinearVelocityPolar</name>
<desc>- Gets Objects Linear Velocity using Polar angle/speed.
@return (float angle, float speed) The angle and speed the object is moving at.</desc>
</method>
<method>
<name>getLinearVelocityX</name>
<desc>- Gets Object Linear Velocity X.
@return (float velocityX) The object's velocity along the x axis.</desc>
</method>
<method>
<name>getLinearVelocityY</name>
<desc>- Gets Object Linear Velocity Y.
@return (float velocityY) The object's velocity along the y axis.</desc>
</method>
<method>
<name>getLinkCount</name>
<desc>- Gets the Link-Point Count.
@return (integer linkPointCount) The count of link points.</desc>
</method>
<method>
<name>getLinkPoint</name>
<args>integer mountID</args>
<desc>- Gets a Link-Point.
@return (float worldX / float worldY) The world position at which the link point is.</desc>
</method>
<method>
<name>getLocalPoint</name>
<args>float worldX, float worldY</args>
<desc>- Returns local-point for object.
Converts a point in world space to object space.
@param worldX The world position x you want to convert into local x.@param worldY The world position y you want to convert into local y.@return (float localX / float local Y) The local position that was converted from the world position passed.</desc>
</method>
<method>
<name>getMass</name>
<desc>- Gets Object Mass.
@return (float mass) The mass value of the object.</desc>
</method>
<method>
<name>getMaxAngularVelocity</name>
<desc>- Gets the Objects Max Angular Velocity.
@return (float maxAngularVelocity) The maximum angular velocity the object is allowed to move.</desc>
</method>
<method>
<name>getMaxLinearVelocity</name>
<desc>- Gets the Objects Max Linear Velocity.
@return (float maxLinearVelocity) The maximum velocity the object is allowed to move.</desc>
</method>
<method>
<name>getMinAngularVelocity</name>
<desc>- Gets the Objects Min Angular Velocity.
@return (float minAngularVelocity) The minimum angular velocity the object is allowed to move.</desc>
</method>
<method>
<name>getMinLinearVelocity</name>
<desc>- Gets the Objects Min Linear Velocity.
@return (float minLinearVelocity) The minimum velocity the object is allowed to move.</desc>
</method>
<method>
<name>getMountedParent</name>
<desc>- Get Parent we're mounted-to.
@return (integer parentID) The parent's object ID if it is mounted, otherwise 0.</desc>
</method>
<method>
<name>getMountForce</name>
<desc>- Returns the mount force.
@return (float mountForce The mountForce value.</desc>
</method>
<method>
<name>getMountInheritAttributes</name>
<desc>- Returns the inherit attributes status.
@return (bool inheritAttributes) Whether or not this object is inheriting attributes from the object it is mounted to.</desc>
</method>
<method>
<name>getMountOwned</name>
<desc>- Returns the mount owned status.
@return (bool ownedByMount) Whether or not the object is deleted when the object it is mounted to is deleted.</desc>
</method>
<method>
<name>getMountRotation</name>
<desc>Gets the object's mount rotation.
@return (float mountRotation) The object's current mount rotation.</desc>
</method>
<method>
<name>getMountTrackRotation</name>
<desc>- Returns the track rotation status.
@return (bool trackRotation) Whether or not the mount is set to track rotation.</desc>
</method>
<method>
<name>getMouseLocked</name>
<desc>Gets the mouse locked status of the object
@return (bool status) Whether the mouse is locked or not.</desc>
</method>
<method>
<name>getPaused</name>
<desc>Gets the object's paused status.
@return (bool status) Whether or not the object is currently paused.</desc>
</method>
<method>
<name>getPhysicsSuppress</name>
<desc>- Gets the Objects Physics Suppress Status.
@return (bool status) Whether or not the physics for this object are supressed.</desc>
</method>
<method>
<name>getPosition</name>
<desc>Gets the object's position.
@return (float x/float y) The x and y (horizontal and vertical) position of the object.</desc>
</method>
<method>
<name>getPositionX</name>
<desc>Gets the object's x position.
@return (float x) The horizontal position of the object</desc>
</method>
<method>
<name>getPositionY</name>
<desc>Gets the object's y position.
@return (float y) The vertical position of the object</desc>
</method>
<method>
<name>getRenderPosition</name>
<desc>Gets the current render position.
@return (float x/float y) The x and y (horizontal and vertical) render position of the object.</desc>
</method>
<method>
<name>getRenderRotation</name>
<desc>Gets the object's render rotation.
0 is the default object rotation.
@return (float rotation) The object's current render rotation (angle).</desc>
</method>
<method>
<name>getRestitution</name>
<desc>- Gets Object Restitution.
@return (float restitution) The restitution value of the object.</desc>
</method>
<method>
<name>getRotation</name>
<desc>Gets the object's rotation.
0 is the default object rotation.
@return (float rotation) The object's current rotation (angle).</desc>
</method>
<method>
<name>getSceneGraph</name>
<desc>Get the scenegraph the object is in.
@return (t2dSceneGraph scenegraph) The scenegraph this object is currently in.</desc>
</method>
<method>
<name>getSize</name>
<desc>Gets the objects size.
@return (float width/float height) The width and height of the object.</desc>
</method>
<method>
<name>getSizeX</name>
<desc>Gets the width of the object.
@return (float width) The width of the object.</desc>
</method>
<method>
<name>getSizeY</name>
<desc>Gets the height of the object.
@return (float height) The height of the object.</desc>
</method>
<method>
<name>getSortPoint</name>
<desc>Gets the layer draw order sorting point.
@return (float x/float y) The local x and y position of the sort point.</desc>
</method>
<method>
<name>getSortPointX</name>
<desc>Gets the x component of the layer draw order sorting point.
@return (float x) The local x position of the sort point.</desc>
</method>
<method>
<name>getSortPointY</name>
<desc>Gets the y component of the layer draw order sorting point.
@return (float y) The local y position of the sort point.</desc>
</method>
<method>
<name>getSrcBlendFactor</name>
<desc>- Returns the src blend factor.
@return (srcBlend) The source blend factor.</desc>
</method>
<method>
<name>getUseMouseEvents</name>
<desc>- Gets whether mouses-events are monitored by this object.
@return (bool mouseStatus) Whether mouse-events are monitored by this object.</desc>
</method>
<method>
<name>getVisible</name>
<desc>- Gets the object's visible status.
@return (bool status) Whether or not the object is visible.</desc>
</method>
<method>
<name>getWidth</name>
<desc>Gets the width of the object.
@return (float width) The width of the object.</desc>
</method>
<method>
<name>getWorldLimit</name>
<desc>Get the World Limit.
@return (limitMode / float minX / float minY / float maxX / float maxY / bool callback) The return is a space seperated string containing the mode, the top left corner x and y position, the bottom right x and y position, and then whether or not the callback is enabled.</desc>
</method>
<method>
<name>getWorldPoint</name>
<args>float localX, float localY</args>
<desc>- Returns world-point from object.
Converts a point in object space to world space.
@param localX The local x position you want to convert into world x.@param localY The local y position you want to convert into world y.@return (float worldX / float worldY) The world position that was converted from the local position passed.</desc>
</method>
<method>
<name>loadCopy</name>
<args>objectFile$</args>
<desc>- Loads a copy of the object from disk.
Loads a previously saved object into this one.
@param objectFile The filename to load from.@return (bool) Whether or not the loading was successful.</desc>
</method>
<method>
<name>mount</name>
<args>t2dSceneObject object, [float offsetX = 0], [float offsetY = 0], [float mountForce = 0], [bool trackRotation? = true], [bool sendToMount? = true], [bool ownedByMount? = true], [bool inheritAttributes? = true] </args>
<desc>- Mounts onto a specified object.
Object's can be mounted to any other object regardless of whether they have other mounts, or are mounted themselves. The only restriction is that there cannot be any cyclical mounting (two objects mounted to each other, for example).
The functions listed other than mount only work if the object is already mounted to another object.
@param object The object to mount to.
@param offsetX The x position to mount to in the object space of %object.
@param offsetY The y position to mount to in the object space of %object.
@param mountForce The magnitude of the force constantly applied to the object to keep it at the mount point. A value of 0 makes the mount rigid, and thus stuck to the object it is mounted to.
@param trackRotation Whether or not to track the rotation of the object this is being mounted to.
@param sendToMount Whether or not to send the object directly to the mount point.
@param ownedByMount Whether or not the object is deleted when the object it is mounted to is deleted.
@param inheritAttributes Whether or not to inherit certain attributes from the object this is being mounted to. The inherited attributes are enabled, visible, paused, and flip.
@return (integer mountID) The mount ID if successful or -1 if the mount fails.</desc>
</method>
<method>
<name>mountToLinkpoint</name>
<args>t2dSceneObject object, int linkpointID, [float mountForce = 0], [bool trackRotation? = true], [bool sendToMount? = true], [bool ownedByMount? = true], [bool inheritAttributes? = true] </args>
<desc>- Mounts onto a specified object at the linkpoint specified.
Object's can be mounted to any other object regardless of whether they have other mounts, or are mounted themselves. The only restriction is that there cannot be any cyclical mounting (two objects mounted to each other, for example).
The functions listed other than mount only work if the object is already mounted to another object.
@param object The object to mount to.
@param linkpointID the linkpoint on that object that we're mounting to.
@param mountForce The magnitude of the force constantly applied to the object to keep it at the mount point. A value of 0 makes the mount rigid, and thus stuck to the object it is mounted to.
@param trackRotation Whether or not to track the rotation of the object this is being mounted to.
@param sendToMount Whether or not to send the object directly to the mount point.
@param ownedByMount Whether or not the object is deleted when the object it is mounted to is deleted.
@param inheritAttributes Whether or not to inherit certain attributes from the object this is being mounted to. The inherited attributes are enabled, visible, paused, and flip.
@return (integer mountID) The mount ID if successful or -1 if the mount fails.</desc>
</method>
<method>
<name>moveTo</name>
<args>t2dVector positionTarget, float linearSpeed, [bool autoStop = true], [bool callback = false], [bool snap = true], [float targetMargin = 0.1]</args>
<desc>Sets a position target for the object and moves toward it.
The object is not actually forced to the target position, it is merely sent there. So, if a collision or some other outside force interferes with the object, it may not make it to the target position. However, the target is still set, so the object may still reach the target in the future.
@param positionTarget The x and y position of the position target.
@param linearSpeed The speed at which the object is setn to the target.
@param autoStop Whether or not to autoStop upon reaching the taret.
@param callback Whether or not to perform a script callback (onPositionTarget()) upon reaching the designated target.
@param snap Whether or not to snap the object to the target when it is within margin.
@param targetMargin The proximity to the target necessary to qualify as reaching the target.
@return No return value.</desc>
</method>
<method>
<name>removeAllLinkPoints</name>
<desc>- Removes all Link-Points.
@return No return Value.</desc>
</method>
<method>
<name>removeFromScene</name>
<desc>Remove the object from the scenegraph.@return No return value.</desc>
</method>
<method>
<name>removeLinkPoint</name>
<args>integer mountID</args>
<desc>- Removes a Link-Point.
@param mountID The id of the link point to remove.
@return No return Value.</desc>
</method>
<method>
<name>rotateTo</name>
<args>float rotationTarget, float angularSpeed, [bool autoStop = true], [bool callback = false], [bool snap = true], [float targetMargin = 0.1]</args>
<desc>Sets a rotation target for the object and rotates toward it.
The object is not forced to the target rotation. It just has an angular velocity set that sends it toward the target. If it is interrupted by a collision or some other means, the target will be set, but the object may not reach it.
@param rotationTarget The rotation target.
@param angularSpeed The speed at which you want the object to rotate to the target.
@param autoStop Whether or not to autoStop upon reaching the taret.
@param callback Whether or not to perform a script callback (onRotationTarget()) upon reaching the designated target rotation.
@param snap Whether or not to snap the object to the target when it is within margin.
@param targetMargin The proximity to the target necessary to qualify as reaching the target.
@return No return value.</desc>
</method>
<method>
<name>safeDelete</name>
<desc>- Safely deletes object.
@return No return Value.</desc>
</method>
<method>
<name>saveCopy</name>
<args>objectFile$</args>
<desc>- Saves a copy of the object to disk.
@param objectFile The filename to load from.@return (bool) Whether or not the saving was successful.</desc>
</method>
<method>
<name>setAngularVelocity</name>
<args>float velocity</args>
<desc>- Sets Objects Angular Velocity.
Auto rotation and angular velocity are two different values, though both of them affect the speed at which the object rotates. Auto rotation is not affected by any of the object's physics, whereas angular velocity is. If an auto rotation is set, it will be used instead of angular velocity.
@param velocity The speed at which the object will rotate.
@return No return Value.</desc>
</method>
<method>
<name>setArea</name>
<args>float x1, float y1, float x2, float y2</args>
<desc>Sets the objects area.
@param x1 The upper left corner x position.
@param y1 The upper left corner y position.
@param x2 The lower right corner x position.
@param y2 The lower right corner y position.
@return No return value.</desc>
</method>
<method>
<name>setAtRest</name>
<desc>- Set Object at Rest.
Both linear velocities and angular velocities are set to 0 so the object will be at rest right after the function is called. However, if any forces are applied to the object after it is set at rest, it will move again.

@return No return Value.</desc>
</method>
<method>
<name>setAutoMassInertia</name>
<args>bool status?</args>
<desc>- Sets Auto Mass/Inertia Calculations.
Sets whether or not mass and inertia should be automatically calculated based on the size and density of the object.
@param status Whether or not to auto calculate the mass and inertia.
@return No return Value.</desc>
</method>
<method>
<name>setAutoMountRotation</name>
<args>float autoMountRotationSpeed</args>
<desc>Sets the objects auto mount rotation speed.
@param autoMountRotationSpeed The auto mount rotation speed.@return No return value.</desc>
</method>
<method>
<name>setAutoRotation</name>
<args>float autoRotationSpeed</args>
<desc>Sets the objects auto rotation speed.
@param autoRotationSpeed the speed of the auto rotation.@return No return value.</desc>
</method>
<method>
<name>setBlendAlpha</name>
<args>float alpha</args>
<desc>- Sets the Rendering Alpha (transparency).
The alpha value specifies directly the transparency of the image. A value of 1.0 will not affect the object and a value of 0.0 will make the object completely transparent.
@param alpha The alpha value.
@return No return Value.</desc>
</method>
<method>
<name>setBlendColor</name>
<args>float red, float green, float blue, [float alpha = 1.0]</args>
<desc>- Sets the Rendering Blend Color.The blend color specifies how much of each color in the original image to show. A red value of 0.5 will cut the amount of red shown in half. A blend color of (1.0, 1.0, 1.0) will not affect the image and a blend color of (0.0, 0.0, 0.0) will make the image black.
The alpha value specifies directly the transparency of the image. A value of 1.0 will not affect the object and a value of 0.0 will make the object completely transparent.Blending must be enabled (as set in setBlending) for this to have any effect. It is enabled by default.
@param red The red value.
@param green The green value.
@param blue The blue value.
@param alpha The alpha value.
@return No return Value.</desc>
</method>
<method>
<name>setBlendColour</name>
<args>float red, float green, float blue, [float alpha = 1.0]</args>
<desc>- Sets the Rendering Blend Colour.The blend color specifies how much of each color in the original image to show. A red value of 0.5 will cut the amount of red shown in half. A blend color of (1.0, 1.0, 1.0) will not affect the image and a blend color of (0.0, 0.0, 0.0) will make the image black.
The alpha value specifies directly the transparency of the image. A value of 1.0 will not affect the object and a value of 0.0 will make the object completely transparent.Blending must be enabled (as set in setBlending) for this to have any effect. It is enabled by default.
@param red The red value.
@param green The green value.
@param blue The blue value.
@param alpha The alpha value.
@return No return Value.</desc>
</method>
<method>
<name>setBlending</name>
<args>bool blendStatus?, [srcBlendFactor = GL_SRC_ALPHA], [dstBlendFactor = GL_ONE_MINUS_SRC_ALPHA]</args>
<desc>- Sets the Rendering Blend Options.
Blending controls how colors will be blended when they are overlapping in the scene. setBlending(%status) should only be used to turn blending off with setBlending(false). A subsequent call with setBlending(true) will reset srcFactor to SRC_ALPHA and dstFactor to ONE_MINUS_SRC_ALPHA.
@param blendStatus Enables or disables blending.
@param srcBlendFactor The source blend factor.
@param dstBlendFactor The destination blend factor.
@return No return Value.</desc>
</method>
<method>
<name>setBlendingStatus</name>
<args>bool blendStatus</args>
<desc>- Enables blending.
@param blendStatus Whether or not the object should use blending.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionActive</name>
<args>bool send, bool receive</args>
<desc>- Sets the collision check directions.
Object's can both collide with other objects and be collided with by other objects. Setting an object to send collisions makes it able to collide, and setting an object to receive collisions makes it able to be collided with. So, an object that is sending collisions will only be able to collide with objects that are receiving collisions and vice versa.
A single object can be set to both send and receive collisions.
@param send Whether or not the object can collide with other objects.
@param receive Whether or not the object can be collided with by other objects.
@return No return value.</desc>
</method>
<method>
<name>setCollisionActiveReceive</name>
<args>bool receive</args>
<desc>- Sets the collision active receive status.
@param receive Whether or not the object can be collided with by other objects.@return No return value.</desc>
</method>
<method>
<name>setCollisionActiveSend</name>
<args>bool send</args>
<desc>- Sets the collision active send status.
@param send Whether or not the object can collide with other objects.
@return No return value.</desc>
</method>
<method>
<name>setCollisionAgainst</name>
<args>t2dSceneObject object, [clearMasks? = false]</args>
<desc>- Sets the collision masks against a specific object.
@param object The t2dSceneobject to set collision masks against
@param clearMasks Whether or not to clear the collision masks before setting them against the object.@return No return value.</desc>
</method>
<method>
<name>setCollisionCallback</name>
<args>bool status?</args>
<desc>- Sets the collision callback status.
Sets whether or not the onCollision() callback will be called for this object when it is part of a collision.
@param status Whether or not to call a collision callback.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionCircleScale</name>
<args>float scale</args>
<desc>- Sets the collision-circle scale.
This value is not cumulative. So, if a scale factor of 0.5 is applied twice, the second one will have no affect on the collision circle.
@param scale Float in the range (0.0, 1.0]
@return No return Value.</desc>
</method>
<method>
<name>setCollisionCircleSuperscribed</name>
<args>superscribeMode?</args>
<desc>- Sets the Collision-Circle superscribed mode.
@param superscribeMode Whether to enable or disable the superscribed mode.
@return No return value.</desc>
</method>
<method>
<name>setCollisionDetection</name>
<args>detectionMode</args>
<desc>- Sets the Collision-Detection mode.
@param detectionMode &lt;br&gt;Possible Values&lt;br&gt; -FULL: A superscribed circle is used first to filter objects that are obviously not colliding. If the bounding circles of objects are colliding, a further polygon check is done to see if a collision actually occurred.&lt;br&gt; -CIRCLE: Only the collision circle is used in determining collisions.&lt;br&gt; -POLYGON: Only the collision polygon is used in determining collisions.&lt;br&gt; -CUSTOM: A custom function is called to detect whether or not collision has occurred between two objects. This function is defined by the user in the engine.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionGroups</name>
<args>groups$</args>
<desc>- Sets the collision group(s).
@param groups A list of collision group numbers to collide with.
@return No return value.</desc>
</method>
<method>
<name>setCollisionLayers</name>
<args>layers$</args>
<desc>- Sets the collision layers(s).
@param layers A list of layers numbers to collide with.
@return No return value.</desc>
</method>
<method>
<name>setCollisionMasks</name>
<args>groupMask, [layerMask]</args>
<desc>- Sets the collision masks.
Collision masks limit the objects that are collided with based on their Graph Group and Rendering Layer. In order for two objects to collide, the sending object must have the receiving object's Graph Group and Rendering Layer in its masks. The receiving object's masks, however, do not have to contain the sending object's Graph Group and Rendering Layer.
@param groupMask The Graph Groups to enable collision with.
@param layerMask The Rendering Layers to enable collision with. If layerMask is not specified all Rendering Layers will be included.@return No return value.</desc>
</method>
<method>
<name>setCollisionMaterial</name>
<args>collisionMaterial</args>
<desc>- Sets Collision Material.
@param collisionMateral
@return No return Value.</desc>
</method>
<method>
<name>setCollisionMaxIterations</name>
<args>iterationCount</args>
<desc>- Sets the Objects Maximum Collision Iterations.
Sets the maximum number of iterations that will be taken through the collision detection and resolution systems in a single frame.
@param iterationCount the max number of iterations.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionPhysics</name>
<args>bool send, bool receive</args>
<desc>- Sets the collision physics directions.
@param send Whether or not to use physics in sent collisions.
@param receive Whether or not to use physics in received collisions.@return No return value.</desc>
</method>
<method>
<name>setCollisionPhysicsReceive</name>
<args>bool receive</args>
<desc>- Sets the collision physics receive status.
@param receive Whether or not to use physics in received collisions.@return No return value.</desc>
</method>
<method>
<name>setCollisionPhysicsSend</name>
<args>bool send</args>
<desc>- Gets the collision physics send status.
@param send Whether or not to use physics in sent collisions.
@return No return value.</desc>
</method>
<method>
<name>setCollisionPolyCustom</name>
<args>integer poly-count, poly-Definition$</args>
<desc>- Sets Custom Collision Polygon.
The collision polygon must be convex. While 1 or 2 edges doesn't make a polygon, it is perfectly valid to use these numbers for %edgeCount in order to specify a single point or a line for collision detection.The higher the number of edges in the collision polygon, the longer collision detection will take. The polygon should contain the fewest edges possible while still accurately representing the desired collision area.
@param poly-count Integer in the range [1, 64]. The number of edges in the polygon.
@param poly-Definition Each of these parameters is a vertex of the collision polygon in object space.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionPolyPrimitive</name>
<args>integer poly-count</args>
<desc>- Sets Primitive Collision Polygon.
While 1 or 2 edges doesn't make a polygon, it is perfectly valid to use these numbers for %edgeCount in order to specify a single point or a line for collision detection.The polygon is subscribed within the bounding box of the object.The higher the number of edges in the collision polygon, the longer collision detection will take. The polygon should contain the fewest edges possible while still accurately representing the desired collision area.
@param poly-count Integer in the range [1, 64].
@return No return Value.</desc>
</method>
<method>
<name>setCollisionPolyScale</name>
<args>float widthScale / [float heightScale]</args>
<desc>- Sets the collision-polygon scale.
This value is not cumulative. So, if a scale factor of 0.5 is applied twice, the second one will have no affect on the collision polygon.
@param widthScale The scale factor for the collision polygon width.
@param heightScale The scale factor for the collision polygon height.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionResponse</name>
<args>responseMode</args>
<desc>- Sets the Collision-Response mode.
The collision response is only used if collision physics are active for the collision.
@param responseMode &lt;br&gt;Possible values&lt;br&gt; -RIGID: The object uses rigid body physics.&lt;br&gt; -BOUNCE: The object bounces off the object it collided with.&lt;br&gt; -CLAMP: The object is kept from penetrating the object it collided with.&lt;br&gt; -STICKY: The object sticks to the collision point.&lt;br&gt; -KILL: The object is deleted.&lt;br&gt; -CUSTOM: A custom function is called to resolve collisions between two objects. This function is defined by the user in the engine.
@return No return Value.</desc>
</method>
<method>
<name>setCollisionSuppress</name>
<args>bool status?</args>
<desc>- Sets the collision suppress status.
@param status Whether to suppress the collision or not.
@return No return Value.</desc>
</method>
<method>
<name>setConfigDatablock</name>
<args>configDatablock</args>
<desc>- Applies a configuration datablock to this object.
@param configDatablock The configuration datablock name.
@return No return Value.</desc>
</method>
<method>
<name>setConstantForce</name>
<args>float forceX / float forceY, [gravitic? = false]</args>
<desc>- Apply a continuous force.
Sets a constant force to be applied to the object.
@param forceX The x component of the constant force.
@param forceY The y component of the constant force.
@param gravitic Whether to set the constant force as gravitic.
@return No return Value.</desc>
</method>
<method>
<name>setConstantForcePolar</name>
<args>float angle, float force, [bool gravitic? = false]</args>
<desc>- Apply a continuous polar force.
Sets a constant force to be applied to the object in polar form.
@param angle The direction of the force.
@param force The magnitude of the force.
@param gravitic Whether to set the constant force as gravitic.
@return No return Value.</desc>
</method>
<method>
<name>setConstantForceX</name>
<args>float forceX</args>
<desc>@param forceX The x component of the constant force.
@return No return Value.</desc>
</method>
<method>
<name>setConstantForceY</name>
<args>float forceY</args>
<desc>@param forceY The y component of the constant force.
@return No return Value.</desc>
</method>
<method>
<name>setDamping</name>
<args>float damping</args>
<desc>- Set Objects Damping.
Damping is a percentage value of the amount of linear and angular velocity the object loses per second. A damping value of 1.0 will cause the object to be completely still after 1 second.
@param damping The damping value for the object.
@return No return Value.</desc>
</method>
<method>
<name>setDebugOff</name>
<args>debugMask</args>
<desc>- Sets Debug Off Mask.
Disables debug modes.
@param debugMask A list of debug modes to disable, see setDebugOn() for a list of modes you can pass.
@return No return Value.</desc>
</method>
<method>
<name>setDebugOn</name>
<args>debugMode</args>
<desc>- Sets Debug On Mode(s).
The debug banner (debug mode 0) has no effect on t2dSceneObjects. It is only relevant to t2dSceneGraphs.
@param debugMode The debug modes to enable, this can be one or all in a comma seperated list.  &lt;br&gt;Possible Values&lt;br&gt; -1. Bounding, Collision, and Clipping Boxes: Displays the axis aligned bounding box in dark cyan, the axis aligned collision bounding box in light cyan, and various clipping rectangles.&lt;br&gt; -2. Mount Nodes: Shows, as yellow crosses, all the mount nodes.&lt;br&gt; -3. Mount Force Lines: Shows, in red, the force lines for mounted objects.&lt;br&gt; -4. World Limit: Shows, in white, the world limit rectangle.&lt;br&gt; -5. Collision Bounds: Shows, in green, the object collision polygon or circle.
@return No return Value.</desc>
</method>
<method>
<name>setDefaultWorldLimit</name>
<desc>- Set to the world limit to default values.
@return No return Value.</desc>
</method>
<method>
<name>setDensity</name>
<args>float density</args>
<desc>- Set Object Density.
Density is only used when auto mass inertia is active. It is used in calculating the mass and inertia of the object. The higher the density, the larger the mass and inertia. Very low values, in the vicinity of 0.01, are recommended.
@param density The density of the object.
@return No return Value.</desc>
</method>
<method>
<name>setDstBlendFactor</name>
<args>dstBlend</args>
<desc>- Sets the blending properties of the object.
@param dstBlend The source blend factor.
@return No return Value.</desc>
</method>
<method>
<name>setEnabled</name>
<args>bool status</args>
<desc>Enables or disables the object.
@param status Whether to enable or disable the object.@return No return value.</desc>
</method>
<method>
<name>setFlip</name>
<args>bool flipX, bool flipY</args>
<desc>Sets flipping for each axis.
@param flipX Whether or not to flip the object along the x (horizontal) axis.
@param flipY Whether or not to flip the object along the y (vertical) axis.
@return No return value.</desc>
</method>
<method>
<name>setFlipX</name>
<args>bool flipX</args>
<desc>Sets whether or not the object is flipped horizontally.
@param flipX Whether or not to flip the object along the x (horizontal) axis.@return No return value.</desc>
</method>
<method>
<name>setFlipY</name>
<args>bool flipY</args>
<desc>Sets whether or not the object is flipped vertically.
@param flipY Whether or not to flip the object along the y (vertical) axis.@return No return value.</desc>
</method>
<method>
<name>setForceScale</name>
<args>float scale</args>
<desc>- Sets the scale factor for all forces applied to this object.
@param scale The scale factor.
@return No return Value.</desc>
</method>
<method>
<name>setForwardMovementOnly</name>
<args>bool forwardMovementOnly</args>
<desc>Sets the object to only move forward.
@param forwardMovementOnly Whether or not the object should only move forward.@return No return value.</desc>
</method>
<method>
<name>setForwardSpeed</name>
<args>float forwardSpeed</args>
<desc>- Sets the forward speed of the object.
@param forwardSpeed The foward speed of the object.@return No return value.</desc>
</method>
<method>
<name>setFriction</name>
<args>float friction</args>
<desc>- Set Object Friction.
This is kinetic friction, which is the force that resists the movement of the object along the surface of another object. Larger numbers will slow down the object more.
@param friction The kinetic friction.
@return No return Value.</desc>
</method>
<method>
<name>setGraphGroup</name>
<args>integer group</args>
<desc>- Sets the objects group (0-31).
The graph group to place the object in.
@param group Integer in the range [0-31].
@return No return Value.</desc>
</method>
<method>
<name>setGraviticConstantForce</name>
<args>bool gravitic</args>
<desc>@param gravitic Whether to set the constant force as gravitic.
@return No return Value.</desc>
</method>
<method>
<name>setHeight</name>
<args>float height</args>
<desc>Sets the height of the object.@param height The height of the object.@return No return value.</desc>
</method>
<method>
<name>setImmovable</name>
<args>bool status</args>
<desc>- Set the Object Immovable.
Completely stops the object and makes it immovable. An immovable object will not react to any forces or velocities applied to it.
The object can still be moved or rotated directly with setPosition() and setRotation().
@param status Whether or not the object should be immovable.
@return No return Value.</desc>
</method>
<method>
<name>setImpulseForce</name>
<args>float impulseForceX / float impulseForceY, [bool gravitic? = false]</args>
<desc>Applies a one time force to the object.
@param impulseForceX The x component of the impulse force
@param impulseForceY The y component of the impulse force
@param gravitic Whether or not the force should be gravitic.
@return No return Value.</desc>
</method>
<method>
<name>setImpulseForcePolar</name>
<args>float angle, float force, [bool gravitic? = false]</args>
<desc>- Apply an instantaneous polar force.
@param angle The angle of direction you want to apply the force to.
@param force The force value you want to apply
@param gravitic Whether or not the force should be gravitic.
@return No return Value.</desc>
</method>
<method>
<name>setInertialMoment</name>
<args>float inertia</args>
<desc>- Set Object Inertial Moment.
The inertia is used in determining the effect of angular forces applied to the object.
@param inertia The inertial moment.
@return No return Value.</desc>
</method>
<method>
<name>setLayer</name>
<args>integer layer</args>
<desc>Sets the objects layer (0-31).
The layer on which to place the object.
@param layer Integer in the range [0-31].
@return No return Value.</desc>
</method>
<method>
<name>setLifetime</name>
<args>float lifetime</args>
<desc>- Set Objects' Lifetime.
@param lifetime The amount of time, in seconds, before the object is automatically deleted.
@return No return Value.</desc>
</method>
<method>
<name>setLinearVelocity</name>
<args>float velocityX, float velocityY</args>
<desc>- Sets Objects Linear Velocity.
Sets the velocity at which the object will move.
@param velocityX The x component of the velocity.
@param velocityY The y component of the velocity.

@return No return Value.</desc>
</method>
<method>
<name>setLinearVelocityPolar</name>
<args>float angle, float speed</args>
<desc>- Sets Objects Linear Velocity using Polar-speed.
Sets the speed and direction at which the object will move.
This has the same effect as setLinearVelocity(), it just sets the velocity in a different way.
@param angle The angle of the direction at which the object to move.
@param speed The speed at which the object will move.
@return No return Value.</desc>
</method>
<method>
<name>setLinearVelocityX</name>
<args>float velocityX</args>
<desc>- Sets Objects Linear Velocity X-Component.
@param velocityX The x component of the velocity.
@return No return Value.</desc>
</method>
<method>
<name>setLinearVelocityY</name>
<args>float velocityY</args>
<desc>- Sets Objects Linear Velocity Y-Component.
@param velocityY The y component of the velocity.
@return No return Value.</desc>
</method>
<method>
<name>setLinkPoint</name>
<args>integer mountID, float offsetX, float offsetY</args>
<desc>- Sets a Link-Point Position.
@param mountID The id of the link point.
@param offsetX the local x offset to move the point to.
@param offsetY the local y offset to move the point to.
@return No return Value.</desc>
</method>
<method>
<name>setMass</name>
<args>float mass</args>
<desc>- Set Object Mass.
The mass is used in determining the effect of linear forces applied to the object.
@param mass The mass of the object.
@return No return Value.</desc>
</method>
<method>
<name>setMaxAngularVelocity</name>
<args>float maxAngularVelocity</args>
<desc>- Set Object Max Angular Velocity.
@param maxAngularVelocity The maximum angular velocity the object is allowed to move.
@return No return Value.</desc>
</method>
<method>
<name>setMaxLinearVelocity</name>
<args>float maxLinearVelocity</args>
<desc>- Set Object Max Linear Velocity.
@param maxLinearVelocity The maximum velocity the object is allowed to move.
@return No return Value.</desc>
</method>
<method>
<name>setMinAngularVelocity</name>
<args>float minAngularVelocity</args>
<desc>- Set Object Min Angular Velocity.
@param minAngularVelocity The minimum angular velocity the object is allowed to move.
@return No return Value.</desc>
</method>
<method>
<name>setMinLinearVelocity</name>
<args>float minLinearVelocity</args>
<desc>- Set Object Min Linear Velocity.
Sets the minimum velocity at which the object is allowed to move.
@param minLinearVelocity The minimum velocity for the object.
@return No return Value.</desc>
</method>
<method>
<name>setMountForce</name>
<args>float mountForce</args>
<desc>- Sets the mount force.
@param mountForce The magnitude of the force constantly applied to the object to keep it at the mount point. A value of 0 makes the mount rigid, and thus stuck to the object it is mounted to.
@return No return Value.</desc>
</method>
<method>
<name>setMountInheritAttributes</name>
<args>bool inheritAttributes</args>
<desc>- Sets the mount inherit attributes status.
@param inheritAttributes Whether or not to inherit certain attributes from the object this is being mounted to. The inherited attributes are enabled, visible, paused, and flip.
@return No return Value.</desc>
</method>
<method>
<name>setMountOwned</name>
<args>bool ownedByMount</args>
<desc>- Sets the mount owned status.
@param ownedByMount Whether or not the object is deleted when the object it is mounted to is deleted.
@return No return Value.</desc>
</method>
<method>
<name>setMountRotation</name>
<args>float mountRotation</args>
<desc>Sets the objects Mount rotation.
@param mountRotation The mount rotation.@return No return value.</desc>
</method>
<method>
<name>setMountTrackRotation</name>
<args>bool trackRotation</args>
<desc>- Sets the track rotation status.
@param trackRotation Whether or not to track the rotation of the object this is being mounted to.
@return No return Value.</desc>
</method>
<method>
<name>setMouseLocked</name>
<args>bool status</args>
<desc>Allows the object to receive all mouse events, regardless of whether it is under the mouse.
@param setMouseLocked Whether to lock or unlock the mouse.@return No return value.</desc>
</method>
<method>
<name>setPaused</name>
<args>bool status</args>
<desc>- Pauses or unpauses the object.
@param status Whether to pause or unpause the object.@return No return value.</desc>
</method>
<method>
<name>setPhysicsSuppress</name>
<args>bool status?</args>
<desc>- Sets the Objects Physics Suppress Status.
@param status True to disable physics, false to enable them.
@return No return Value.</desc>
</method>
<method>
<name>setPosition</name>
<args>float x, float y</args>
<desc>- Sets the objects position.
@param x The position of the object along the horizontal axis.
@param y The position of the object along the vertical axis.
@return No return value.</desc>
</method>
<method>
<name>setPositionTarget</name>
<args>t2dVector positionTarget, [bool autoStop = true], [bool callback = false], [bool snap = true], [float targetMargin = 0.1]</args>
<desc>Sets a position target for the object.
This function does not actually move the object. Instead, it allows an object to be stopped or execute a callback upon reaching a destination position. To have an object automatically move to a target position, use moveTo().
@param positionTarget The x and y position of the position target.
@param autoStop Whether or not to autoStop upon reaching the taret.
@param callback Whether or not to perform a script callback (onPositionTarget()) upon reaching the designated target.
@param snap Whether or not to snap the object to the target when it is within margin.
@param targetMargin The proximity to the target necessary to qualify as reaching the target.
@return No return value.</desc>
</method>
<method>
<name>setPositionTargetOff</name>
<desc>Cancels the objects position target.@return No return value.</desc>
</method>
<method>
<name>setPositionX</name>
<args>float x</args>
<desc>Sets the objects x position.
@param x The horizontal position of the object.@return No return value.</desc>
</method>
<method>
<name>setPositionY</name>
<args>float y</args>
<desc>Sets the objects y position.
@param y The vertical position of the object.@return No return value.</desc>
</method>
<method>
<name>setRestitution</name>
<args>float restitution</args>
<desc>- Set Object Restitution.
A restitution of 1.0 will cause the object to bounce with perfect elasticity, while a value 0.0 will cause the object to not bounce at all.
@param restitution Float in the range [0.0, 1.0], the restitution.
@return No return Value.</desc>
</method>
<method>
<name>setRotation</name>
<args>float rotation</args>
<desc>- Sets the objects rotation.
0 is the default object rotation.
@param rotation The rotation (angle) of the object.@return No return value.</desc>
</method>
<method>
<name>setRotationTarget</name>
<args>float rotationTarget, [bool autoStop = true], [bool callback = false], [bool snap = true], [float targetMargin = 0.1]</args>
<desc>Sets a rotation target for the object.
This function does not actually rotate the object. It merely provides a target rotation for the object. To actually rotate an object to a target use rotateTo().
@param rotationTarget The rotation target.
@param autoStop Whether or not to autoStop upon reaching the taret.
@param callback Whether or not to perform a script callback (onRotationTarget()) upon reaching the designated target rotation.
@param snap Whether or not to snap the object to the target when it is within margin.
@param targetMargin The proximity to the target necessary to qualify as reaching the target.
@return No return value.</desc>
</method>
<method>
<name>setRotationTargetOff</name>
<desc>Removes the objects rotation target.@return No return value.</desc>
</method>
<method>
<name>setSize</name>
<args>float width, float height</args>
<desc>Sets the objects size.
@param width The width of the object.
@param height The height of the object.
@return No return value.</desc>
</method>
<method>
<name>setSizeX</name>
<args>float width</args>
<desc>Sets the width of the object.
@param width The width of the object.@return No return value.</desc>
</method>
<method>
<name>setSizeY</name>
<args>float height</args>
<desc>Sets the height of the object.
@param height The height of the object.@return No return value.</desc>
</method>
<method>
<name>setSortPoint</name>
<args>float x, float y</args>
<desc>Sets the layer draw order sorting point.
@param x The x position local to the object of the sort point.
@param y The y position local to the object of the sort point.
@return No return value.</desc>
</method>
<method>
<name>setSortPointX</name>
<args>float x</args>
<desc>Sets the x-component of the layer draw order sorting point.
@param x The x position local to the object of the sort point.
@return No return value.</desc>
</method>
<method>
<name>setSortPointY</name>
<args>float y</args>
<desc>Sets the y-component of the layer draw order sorting point.
@param y The y position local to the object of the sort point.
@return No return value.</desc>
</method>
<method>
<name>setSrcBlendFactor</name>
<args>srcBlend</args>
<desc>- Sets the blending properties of the object.
@param srcBlend The source blend factor.
@return No return Value.</desc>
</method>
<method>
<name>setTimerOff</name>
<desc>- Stops the periodic timer for this object.
@return No return Value.</desc>
</method>
<method>
<name>setTimerOn</name>
<args>float timePeriod</args>
<desc>- Starts a periodic timer for this object.
Sets a timer on the object that, when it expires, will cause the object to execute the onTimer() callback.
The timer event will continue to occur at regular intervals until setTimerOff() is called.
@param timePeriod The period of time, in milliseconds, between each callback.
@return No return Value.</desc>
</method>
<method>
<name>setUseMouseEvents</name>
<args>bool mouseStatus</args>
<desc>- Sets whether mouses-events are monitored by this object.
The t2dSceneWindow that is attached to the t2dSceneGraph this object is in must have 'use object mouse events' enabled as set in setUseObjectMouseEvents.
@param mouseStatus Whether or not to monitor mouse events.
@return No return Value.</desc>
</method>
<method>
<name>setVisible</name>
<args>bool status</args>
<desc>- Show or hide the object.
@param status Whether to enable or disable visiblity on the object.@return No return value.</desc>
</method>
<method>
<name>setWidth</name>
<args>float width</args>
<desc>Sets the width of the object.
@param width The width of the object.@return No return value.</desc>
</method>
<method>
<name>setWorldLimit</name>
<args>limitMode, [float minX / float minY / float maxX / float maxY], [bool callback?]</args>
<desc>- Set World Limit.
@param limitMode &lt;br&gt;Possible Values:&lt;br&gt; -OFF: Turns the limit off.&lt;br&gt; -NULL: Nothing is done, but the callback is still called.&lt;br&gt; -RIGID: The objects responds with a rigid collision response.&lt;br&gt; -BOUNCE: The object bounces off the limit bounds.&lt;br&gt; -CLAMP: The object is clamped to the edge of the limit bounds.&lt;br&gt; -STICKY: The object sticks to the spot it hit the limit bounds.&lt;br&gt; -KILL: The object is deleted when it collides with any limit bound.&lt;br&gt;@param minX The top left x position.@param minY The top left y position.@param maxX The bottom right x position.@param maxY The bottom right y position.@param callback Whether or not to trigger the onWorldLimit() callback.
@return No return Value.</desc>
</method>
<method>
<name>stopConstantForce</name>
<desc>- Stops any continuous force.
@return No return Value.</desc>
</method>
<field>
<name>AngularVelocity</name>
<desc>float AngularVelocity</desc>
</field>
<field>
<name>AutoMassInertia</name>
<desc>bool AutoMassInertia</desc>
</field>
<field>
<name>AutoMountRotation</name>
<desc>float AutoMountRotation</desc>
</field>
<field>
<name>AutoRotation</name>
<desc>float AutoRotation</desc>
</field>
<field>
<name>BlendColor</name>
<desc>ColorF BlendColor</desc>
</field>
<field>
<name>BlendingEnabled</name>
<desc>bool BlendingEnabled</desc>
</field>
<field>
<name>CollisionActiveReceive</name>
<desc>bool CollisionActiveReceive</desc>
</field>
<field>
<name>CollisionActiveSend</name>
<desc>bool CollisionActiveSend</desc>
</field>
<field>
<name>CollisionCallback</name>
<desc>bool CollisionCallback</desc>
</field>
<field>
<name>CollisionCircleScale</name>
<desc>float CollisionCircleScale</desc>
</field>
<field>
<name>CollisionCircleSuperscribed</name>
<desc>bool CollisionCircleSuperscribed</desc>
</field>
<field>
<name>CollisionDetectionMode</name>
<desc>enumval CollisionDetectionMode</desc>
</field>
<field>
<name>CollisionGroups</name>
<desc>int CollisionGroups</desc>
</field>
<field>
<name>CollisionLayers</name>
<desc>int CollisionLayers</desc>
</field>
<field>
<name>CollisionMaxIterations</name>
<desc>int CollisionMaxIterations</desc>
</field>
<field>
<name>CollisionPhysicsReceive</name>
<desc>bool CollisionPhysicsReceive</desc>
</field>
<field>
<name>CollisionPhysicsSend</name>
<desc>bool CollisionPhysicsSend</desc>
</field>
<field>
<name>CollisionPolyList</name>
<desc>point2FList CollisionPolyList</desc>
</field>
<field>
<name>CollisionPolyScale</name>
<desc>Point2F CollisionPolyScale</desc>
</field>
<field>
<name>CollisionResponseMode</name>
<desc>enumval CollisionResponseMode</desc>
</field>
<field>
<name>config</name>
<desc>SimObjectPtr config</desc>
</field>
<field>
<name>ConstantForce</name>
<desc>Point2F ConstantForce</desc>
</field>
<field>
<name>ConstantForceGravitic</name>
<desc>bool ConstantForceGravitic</desc>
</field>
<field>
<name>damping</name>
<desc>float damping</desc>
</field>
<field>
<name>Density</name>
<desc>float Density</desc>
</field>
<field>
<name>DstBlendFactor</name>
<desc>enumval DstBlendFactor</desc>
</field>
<field>
<name>FlipX</name>
<desc>bool FlipX</desc>
</field>
<field>
<name>FlipY</name>
<desc>bool FlipY</desc>
</field>
<field>
<name>ForceScale</name>
<desc>float ForceScale</desc>
</field>
<field>
<name>ForwardOnly</name>
<desc>bool ForwardOnly</desc>
</field>
<field>
<name>Friction</name>
<desc>float Friction</desc>
</field>
<field>
<name>GraphGroup</name>
<desc>int GraphGroup</desc>
</field>
<field>
<name>Immovable</name>
<desc>bool Immovable</desc>
</field>
<field>
<name>Inertia</name>
<desc>float Inertia</desc>
</field>
<field>
<name>Layer</name>
<desc>int Layer</desc>
</field>
<field>
<name>Lifetime</name>
<desc>float Lifetime</desc>
</field>
<field>
<name>LinearVelocity</name>
<desc>Point2F LinearVelocity</desc>
</field>
<field>
<name>LinkPoints</name>
<desc>point2FList LinkPoints</desc>
</field>
<field>
<name>Mass</name>
<desc>float Mass</desc>
</field>
<field>
<name>MaxAngularVelocity</name>
<desc>float MaxAngularVelocity</desc>
</field>
<field>
<name>MaxLinearVelocity</name>
<desc>float MaxLinearVelocity</desc>
</field>
<field>
<name>MinAngularVelocity</name>
<desc>float MinAngularVelocity</desc>
</field>
<field>
<name>MinLinearVelocity</name>
<desc>float MinLinearVelocity</desc>
</field>
<field>
<name>MountForce</name>
<desc>float MountForce</desc>
</field>
<field>
<name>MountInheritAttributes</name>
<desc>bool MountInheritAttributes</desc>
</field>
<field>
<name>MountOffset</name>
<desc>Point2F MountOffset</desc>
</field>
<field>
<name>MountOwned</name>
<desc>bool MountOwned</desc>
</field>
<field>
<name>MountRotation</name>
<desc>float MountRotation</desc>
</field>
<field>
<name>MountTrackRotation</name>
<desc>bool MountTrackRotation</desc>
</field>
<field>
<name>Paused</name>
<desc>bool Paused</desc>
</field>
<field>
<name>Position</name>
<desc>Point2F Position</desc>
</field>
<field>
<name>Restitution</name>
<desc>float Restitution</desc>
</field>
<field>
<name>Rotation</name>
<desc>float Rotation</desc>
</field>
<field>
<name>scenegraph</name>
<desc>SimObjectPtr scenegraph</desc>
</field>
<field>
<name>size</name>
<desc>Point2F size</desc>
</field>
<field>
<name>SortPoint</name>
<desc>Point2F SortPoint</desc>
</field>
<field>
<name>SrcBlendFactor</name>
<desc>enumval SrcBlendFactor</desc>
</field>
<field>
<name>useMouseEvents</name>
<desc>bool useMouseEvents</desc>
</field>
<field>
<name>Visible</name>
<desc>bool Visible</desc>
</field>
<field>
<name>WorldLimitCallback</name>
<desc>bool WorldLimitCallback</desc>
</field>
<field>
<name>WorldLimitMax</name>
<desc>Point2F WorldLimitMax</desc>
</field>
<field>
<name>WorldLimitMin</name>
<desc>Point2F WorldLimitMin</desc>
</field>
<field>
<name>WorldLimitMode</name>
<desc>enumval WorldLimitMode</desc>
</field>
</class>
<class>
<name>t2dSceneObjectDatablock</name>
<base>t2dBaseDatablock</base>
<field>
<name>AngularVelocity</name>
<desc>float AngularVelocity</desc>
</field>
<field>
<name>AutoMassInertia</name>
<desc>bool AutoMassInertia</desc>
</field>
<field>
<name>AutoMountRotation</name>
<desc>float AutoMountRotation</desc>
</field>
<field>
<name>AutoRotation</name>
<desc>float AutoRotation</desc>
</field>
<field>
<name>BlendColor</name>
<desc>ColorF BlendColor</desc>
</field>
<field>
<name>BlendingEnabled</name>
<desc>bool BlendingEnabled</desc>
</field>
<field>
<name>CollisionActiveReceive</name>
<desc>bool CollisionActiveReceive</desc>
</field>
<field>
<name>CollisionActiveSend</name>
<desc>bool CollisionActiveSend</desc>
</field>
<field>
<name>CollisionCallback</name>
<desc>bool CollisionCallback</desc>
</field>
<field>
<name>CollisionCircleScale</name>
<desc>float CollisionCircleScale</desc>
</field>
<field>
<name>CollisionCircleSuperscribed</name>
<desc>bool CollisionCircleSuperscribed</desc>
</field>
<field>
<name>CollisionDetectionMode</name>
<desc>enumval CollisionDetectionMode</desc>
</field>
<field>
<name>CollisionGroups</name>
<desc>int CollisionGroups</desc>
</field>
<field>
<name>CollisionLayers</name>
<desc>int CollisionLayers</desc>
</field>
<field>
<name>CollisionMaxIterations</name>
<desc>int CollisionMaxIterations</desc>
</field>
<field>
<name>CollisionPhysicsReceive</name>
<desc>bool CollisionPhysicsReceive</desc>
</field>
<field>
<name>CollisionPhysicsSend</name>
<desc>bool CollisionPhysicsSend</desc>
</field>
<field>
<name>CollisionPolyList</name>
<desc>point2FList CollisionPolyList</desc>
</field>
<field>
<name>CollisionPolyScale</name>
<desc>Point2F CollisionPolyScale</desc>
</field>
<field>
<name>CollisionResponseMode</name>
<desc>enumval CollisionResponseMode</desc>
</field>
<field>
<name>ConstantForce</name>
<desc>Point2F ConstantForce</desc>
</field>
<field>
<name>ConstantForceGravitic</name>
<desc>bool ConstantForceGravitic</desc>
</field>
<field>
<name>damping</name>
<desc>float damping</desc>
</field>
<field>
<name>Density</name>
<desc>float Density</desc>
</field>
<field>
<name>DstBlendFactor</name>
<desc>enumval DstBlendFactor</desc>
</field>
<field>
<name>Enabled</name>
<desc>bool Enabled</desc>
</field>
<field>
<name>FlipX</name>
<desc>bool FlipX</desc>
</field>
<field>
<name>FlipY</name>
<desc>bool FlipY</desc>
</field>
<field>
<name>ForceScale</name>
<desc>float ForceScale</desc>
</field>
<field>
<name>ForwardOnly</name>
<desc>bool ForwardOnly</desc>
</field>
<field>
<name>Friction</name>
<desc>float Friction</desc>
</field>
<field>
<name>GraphGroup</name>
<desc>int GraphGroup</desc>
</field>
<field>
<name>Immovable</name>
<desc>bool Immovable</desc>
</field>
<field>
<name>Inertia</name>
<desc>float Inertia</desc>
</field>
<field>
<name>Layer</name>
<desc>int Layer</desc>
</field>
<field>
<name>Lifetime</name>
<desc>float Lifetime</desc>
</field>
<field>
<name>LinearVelocity</name>
<desc>Point2F LinearVelocity</desc>
</field>
<field>
<name>LinkPoints</name>
<desc>point2FList LinkPoints</desc>
</field>
<field>
<name>Mass</name>
<desc>float Mass</desc>
</field>
<field>
<name>MaxAngularVelocity</name>
<desc>float MaxAngularVelocity</desc>
</field>
<field>
<name>MaxLinearVelocity</name>
<desc>float MaxLinearVelocity</desc>
</field>
<field>
<name>MinAngularVelocity</name>
<desc>float MinAngularVelocity</desc>
</field>
<field>
<name>MinLinearVelocity</name>
<desc>float MinLinearVelocity</desc>
</field>
<field>
<name>MountForce</name>
<desc>float MountForce</desc>
</field>
<field>
<name>MountInheritAttributes</name>
<desc>bool MountInheritAttributes</desc>
</field>
<field>
<name>MountOffset</name>
<desc>Point2F MountOffset</desc>
</field>
<field>
<name>MountOwned</name>
<desc>bool MountOwned</desc>
</field>
<field>
<name>MountRotation</name>
<desc>float MountRotation</desc>
</field>
<field>
<name>MountTrackRotation</name>
<desc>bool MountTrackRotation</desc>
</field>
<field>
<name>Paused</name>
<desc>bool Paused</desc>
</field>
<field>
<name>Position</name>
<desc>Point2F Position</desc>
</field>
<field>
<name>Restitution</name>
<desc>float Restitution</desc>
</field>
<field>
<name>Rotation</name>
<desc>float Rotation</desc>
</field>
<field>
<name>size</name>
<desc>Point2F size</desc>
</field>
<field>
<name>SortPoint</name>
<desc>Point2F SortPoint</desc>
</field>
<field>
<name>SrcBlendFactor</name>
<desc>enumval SrcBlendFactor</desc>
</field>
<field>
<name>useMouseEvents</name>
<desc>bool useMouseEvents</desc>
</field>
<field>
<name>Visible</name>
<desc>bool Visible</desc>
</field>
<field>
<name>WorldLimitCallback</name>
<desc>bool WorldLimitCallback</desc>
</field>
<field>
<name>WorldLimitMax</name>
<desc>Point2F WorldLimitMax</desc>
</field>
<field>
<name>WorldLimitMin</name>
<desc>Point2F WorldLimitMin</desc>
</field>
<field>
<name>WorldLimitMode</name>
<desc>enumval WorldLimitMode</desc>
</field>
</class>
<class>
<name>t2dSceneObjectGroup</name>
<base>t2dSceneObjectSet</base>
</class>
<class>
<name>t2dSceneObjectSet</name>
<base>SimSet</base>
<method>
<name>getFlipX</name>
<desc>@return Returns flip x.</desc>
</method>
<method>
<name>getFlipY</name>
<desc>@return Returns flip y.</desc>
</method>
<method>
<name>getGraphGroup</name>
<desc>@return Returns the graph group.</desc>
</method>
<method>
<name>getHeight</name>
<desc>@return Returns height.</desc>
</method>
<method>
<name>getLayer</name>
<desc>@return Returns the layer.</desc>
</method>
<method>
<name>getPosition</name>
<desc>@return Returns position.</desc>
</method>
<method>
<name>getPositionX</name>
<desc>Returns x position.</desc>
</method>
<method>
<name>getPositionY</name>
<desc>@return Returns y position.</desc>
</method>
<method>
<name>getRotation</name>
<desc>@return Returns rotation.</desc>
</method>
<method>
<name>getSize</name>
<desc>@return Returns size.</desc>
</method>
<method>
<name>getWidth</name>
<desc>@return Returns width.</desc>
</method>
<method>
<name>setFlipX</name>
<args>flipX</args>
<desc>Set the flipX flag
@return No return value.</desc>
</method>
<method>
<name>setFlipY</name>
<args>flipY</args>
<desc>Set the flipY flag
@return No return value.</desc>
</method>
<method>
<name>setGraphGroup</name>
<args>graphgroup</args>
<desc>Sets the graphgroup of the set.
@return No return value.</desc>
</method>
<method>
<name>setHeight</name>
<args>height</args>
<desc>Set the height of the object
@return No return value.</desc>
</method>
<method>
<name>setLayer</name>
<args>layer</args>
<desc>Sets the layer of the set.
@return No return value.</desc>
</method>
<method>
<name>setPositionX</name>
<args>xpos</args>
<desc>Set the x component of the position of the object
@return No return value.</desc>
</method>
<method>
<name>setPositionY</name>
<args>ypos</args>
<desc>Set the y component of the position of the object
@return No return value.</desc>
</method>
<method>
<name>setRotation</name>
<args>angle</args>
<desc>Set the rotation angle of the object
@param The rotation angle in degrees@return No return value.</desc>
</method>
<method>
<name>setWidth</name>
<args>width</args>
<desc>Set the width of the object
@return No return value.</desc>
</method>
</class>
<class>
<name>t2dSceneWindow</name>
<base>GuiControl</base>
<method>
<name>completeCameraMove</name>
<desc>Moves camera directly to target.
@return No return value.</desc>
</method>
<method>
<name>dismount</name>
<desc>Dismounts Camera from object.@return No return value</desc>
</method>
<method>
<name>getCanvasPoint</name>
<args>X / Y</args>
<desc>- Returns Canvas coordinate of Window coordinate.@param x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")@return Returns the desired canvas coordinates as a string formatted as "x y"</desc>
</method>
<method>
<name>getCurrentCameraArea</name>
<desc>Get current camera Area.
@return The camera area formatted as "x1 y1 x2 y2"</desc>
</method>
<method>
<name>getCurrentCameraPosition</name>
<desc>Get current camera Position.
@return Returns the camera's position as a string formatted as "x y"</desc>
</method>
<method>
<name>getCurrentCameraSize</name>
<desc>Get current camera Size.
@return Returns the cameras width and height as a string formatted as "width height"</desc>
</method>
<method>
<name>getCurrentCameraZoom</name>
<desc>Get current camera Zoom.
@return Returns the camera zoom factor as a 32-bit floating point value.</desc>
</method>
<method>
<name>getDontRenderObject</name>
<desc>Gets the object that won't be rendered in this scene window.@return The ID of the object that won't be rendered.</desc>
</method>
<method>
<name>getIsCameraMounted</name>
<desc>Check the camera mounted status.
@return Returns a boolean value as to whether or not the camera is mounted.</desc>
</method>
<method>
<name>getIsCameraMoving</name>
<desc>Check the camera moving status.
@return Returns a boolean value as to whether or not the camera is moving.</desc>
</method>
<method>
<name>getIsWindowPoint</name>
<args>X / Y</args>
<desc>Checks if World coordinate is inside Window.@param x,y The coordinates in world coordinates you wish to check. Accepts either (x,y) or ("x y")@return Returns true if the coordinates are within the window, and false otherwise.</desc>
</method>
<method>
<name>getLockMouse</name>
<desc>Gets the window mouse-lock status.</desc>
</method>
<method>
<name>getMousePosition</name>
<desc>Gets Current Mouse Position.@return Returns a string with the current mouse cursor coordinates formatted as "x y"</desc>
</method>
<method>
<name>getRenderGroupMask</name>
<desc>- Gets the group mask which controls what is rendered.@returns The bit mask corresponding to the groups which are to be rendered</desc>
</method>
<method>
<name>getRenderLayerMask</name>
<desc>- Gets the layer mask which controls what is rendered.@returns The bit mask corresponding to the layers which are to be rendered</desc>
</method>
<method>
<name>getSceneGraph</name>
<desc>- Returns the t2dSceneGraph associated with this window.@return Returns the scenegraph ID as a string</desc>
</method>
<method>
<name>getUseObjectMouseEvents</name>
<desc>Gets whether mouses-events are monitored by the scene-objects.
@return Returns a boolean value. If true mouse events are being monitored by the object, if false they aren't</desc>
</method>
<method>
<name>getUseWindowMouseEvents</name>
<desc>Gets whether mouses-events are monitored by the window.
@return A boolean value. If true mouse events are being monitored by the window, if false they aren't</desc>
</method>
<method>
<name>getWindowExtents</name>
<desc>Fetch Window Extents (Position/Size).@return Returns the window dimensions as a string formatted as follows: &lt;position.x&gt; &lt;position.y&gt; &lt;width&gt; &lt;height&gt;</desc>
</method>
<method>
<name>getWindowPoint</name>
<args>X / Y</args>
<desc>- Returns Window coordinate of World coordinate.@param x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")@return Returns the desired window coordinates as a string formatted as "x y"</desc>
</method>
<method>
<name>getWorldPoint</name>
<args>X / Y</args>
<desc>- Returns World coordinate of Window coordinate.@param x,y The coordinates in window coordinates you wish to convert to world coordinates. Accepts either (x,y) or ("x y")@return Returns the desired world coordinates as a string formatted as "x y"</desc>
</method>
<method>
<name>mount</name>
<args>t2dSceneObject, [offsetX / offsetY], [mountForce], [sendToMount?]</args>
<desc>- Mounts Camera onto a specified object.@return No return value</desc>
</method>
<method>
<name>resetSceneGraph</name>
<desc>Detaches the window from any t2dSceneGraph Object.
@return No return value</desc>
</method>
<method>
<name>setCameraInterpolationMode</name>
<args>interpolationMode</args>
<desc>- Set camera interpolation mode.@return No return value.</desc>
</method>
<method>
<name>setCameraInterpolationTime</name>
<args>interpolationTime</args>
<desc>- Set camera interpolation time.@return No return value</desc>
</method>
<method>
<name>setCurrentCameraArea</name>
<args>x1 / y1 / x2 / y2</args>
<desc>- Set current camera area.@param x1,y1,x2,y2 The coordinates of the minimum and maximum points (top left, bottom right)
The input can be formatted as either "x1 y1 x2 y2", "x1 y1, x2 y2", "x1, y1, x2, y2"
@return No return value.</desc>
</method>
<method>
<name>setCurrentCameraPosition</name>
<args>x / y / [width / height]</args>
<desc>- Set current camera position.
@param There are 5 possible formats for input: (x1, y1), ("x1 y1"), (x, y, width, height) ("x1 y1", "width height") (x1, y1, x2, y2)@return No return value.</desc>
</method>
<method>
<name>setCurrentCameraZoom</name>
<args>zoomFactor</args>
<desc>- Set current camera Zoom Factor.
@param zoomFactor A float value representing the zoom factor
@return No return value.</desc>
</method>
<method>
<name>setDebugBanner</name>
<args>fontName, fontSize, textR/G/B/[A]$, backgroundR/G/B/[A]$</args>
<desc>- Set Debug Font/Size/textColour/backgroundColour</desc>
</method>
<method>
<name>setDontRenderObject</name>
<args>t2dSceneObject obj</args>
<desc>- Sets obj as to not render in this scene window.
@param obj The object you wish not to render in the window.@return Always returns true.</desc>
</method>
<method>
<name>setLockMouse</name>
<args>bool lockSet</args>
<desc>Sets the window mouse-lock status.@return No return value.</desc>
</method>
<method>
<name>setMousePosition</name>
<args>x/y</args>
<desc>Sets Current Mouse Position.@param x,y The coordinates to set the mousecursor. Accepts either (x,y) or ("x y")</desc>
</method>
<method>
<name>setObjectMouseEventFilter</name>
<args>groupMask, layerMask, [useInvisible?]</args>
<desc>Sets Filter for Object Mouse-Events.</desc>
</method>
<method>
<name>setObjectMouseEventGroupFilter</name>
<args>groups$</args>
<desc>Sets the group filter to the specified mask.
@param List of groups to set.
@return No return value.</desc>
</method>
<method>
<name>setObjectMouseEventInvisibleFilter</name>
<args>bool useInvisible</args>
<desc>Sets the use invisible flag</desc>
</method>
<method>
<name>setObjectMouseEventLayerFilter</name>
<args>layers$</args>
<desc>Sets the layer filter.@param The list of layers to set.
@return No return value.</desc>
</method>
<method>
<name>setRenderGroups</name>
<args>groups$</args>
<desc>- Sets the render group(s).
@param groups The list of groups you wish to set.
@return No return value.</desc>
</method>
<method>
<name>setRenderLayers</name>
<args>layers$</args>
<desc>- Sets the render layers(s).@param The layer numbers you wish to set.
@return No return value.</desc>
</method>
<method>
<name>setRenderMasks</name>
<args>layerMask, groupMask</args>
<desc>- Sets the layer/group mask which control what is rendered.@param layermask The bitmask for setting the layers to render
@param groupmask The bitmask for setting the groups to render
@return No return value.</desc>
</method>
<method>
<name>setSceneGraph</name>
<args>t2dSceneGraph</args>
<desc>Associates t2dSceneGraph Object.@param t2dScenegraph The scenegraph ID or name.
@return No return value.</desc>
</method>
<method>
<name>setTargetCameraArea</name>
<args>x / y / width / height</args>
<desc>- Set target camera area.@return No return value.</desc>
</method>
<method>
<name>setTargetCameraPosition</name>
<args>x / y / [width / height]</args>
<desc>- Set target camera position.@return No return value.</desc>
</method>
<method>
<name>setTargetCameraZoom</name>
<args>zoomFactor</args>
<desc>- Set target camera Zoom Factor.@return No return value.</desc>
</method>
<method>
<name>setUseObjectMouseEvents</name>
<args>mouseStatus</args>
<desc>Sets whether mouses-events are monitored by the scene-Objects.
@param mouseStatus A boolean value. If true mouse events won't be monitored by the object, if false they will</desc>
</method>
<method>
<name>setUseWindowMouseEvents</name>
<args>mouseStatus</args>
<desc>Sets whether mouses-events are monitored by the window.
@param mouseStatus A boolean value. If true mouse events won't be monitored by the window, if false they will
@return No return value.</desc>
</method>
<method>
<name>setViewLimitOff</name>
<desc>Set View Limit Off.@return No return value</desc>
</method>
<method>
<name>setViewLimitOn</name>
<args>[minX / minY / maxX / maxY]</args>
<desc>- Set View Limit On.@return No return value</desc>
</method>
<method>
<name>startCameraMove</name>
<args>[interpolationTime]</args>
<desc>- Start Camera Move.@return No return value.</desc>
</method>
<method>
<name>startCameraShake</name>
<args>shakeMagnitude, time</args>
<desc>- Starts the camera shaking.@param shakeMagnitude The intensity of the shaking
@param time The length of the shake@return No return value</desc>
</method>
<method>
<name>stopCameraMove</name>
<desc>Stops current camera movement@return No return value.</desc>
</method>
<method>
<name>stopCameraShake</name>
<desc>Stops the camera shaking.@return No return value</desc>
</method>
<method>
<name>undoCameraMove</name>
<args>[interpolationTime]</args>
<desc>- Reverses previous camera movement.@return No return value.</desc>
</method>
<field>
<name>lockMouse</name>
<desc>bool lockMouse</desc>
</field>
<field>
<name>useObjectMouseEvents</name>
<desc>bool useObjectMouseEvents</desc>
</field>
<field>
<name>useWindowMouseEvents</name>
<desc>bool useWindowMouseEvents</desc>
</field>
</class>
<class>
<name>t2dScroller</name>
<base>t2dSceneObject</base>
<method>
<name>getImageMap</name>
<desc>@return Returns the image map.</desc>
</method>
<method>
<name>getRepeatX</name>
<desc>@return Returns repeat X value</desc>
</method>
<method>
<name>getRepeatY</name>
<desc>@return Returns repeat Y value</desc>
</method>
<method>
<name>getScrollPositionX</name>
<desc>Returns  texture's position in x direction</desc>
</method>
<method>
<name>getScrollPositionY</name>
<desc>Returns texture's position in y direction</desc>
</method>
<method>
<name>getScrollX</name>
<desc>@return Returns Scroll speed in x direction.</desc>
</method>
<method>
<name>getScrollY</name>
<desc>@return Returns Scroll speed in y direction.</desc>
</method>
<method>
<name>setImageMap</name>
<args>imageMapName$</args>
<desc>- Sets the imageMap Name.@return No return value.</desc>
</method>
<method>
<name>setRepeat</name>
<args>repeatX / repeatY</args>
<desc>Sets the Repeat X/Y repetition in each direction.
@param repeatX/Y The number of times to repeat in each direction as either ("x y") or (x, y)
@return No return value.</desc>
</method>
<method>
<name>setRepeatX</name>
<args>repeatX</args>
<desc>Sets the number of times to repeat the texture over x direction
@return No return value.</desc>
</method>
<method>
<name>setRepeatY</name>
<args>repeatY</args>
<desc>Sets the number of timnes to repeat the texture in y direction.
@return No return value.</desc>
</method>
<method>
<name>setScroll</name>
<args>offsetX / offsetY</args>
<desc>Sets the Scroll speed.@param offsetX/Y The scroll speed in each direction as either ("x y") or (x, y)
@return No return value.</desc>
</method>
<method>
<name>setScrollPolar</name>
<args>angle, scrollSpeed</args>
<desc>Sets Auto-Pan Polarwise.
@param angle Polar angle.
@param scrollSpeed Speed as polar magnitude
@return No return value.</desc>
</method>
<method>
<name>setScrollPosition</name>
<args>positionX / positionY</args>
<desc>Sets the Scroll position X/Y.@param positionX/Y The scroll texture position as either ("x y") or (x, y)
@return No return value.</desc>
</method>
<method>
<name>setScrollPositionX</name>
<args>ScrollPositionX</args>
<desc>Set the texture's position in x direction
@return No return value.</desc>
</method>
<method>
<name>setScrollPositionY</name>
<args>ScrollPositionY</args>
<desc>Set the texture's position in y direction
@return No return value.</desc>
</method>
<method>
<name>setScrollX</name>
<args>ScrollX</args>
<desc>Sets the scroll speed in x direction
@return No return value.</desc>
</method>
<method>
<name>setScrollY</name>
<args>ScrollY</args>
<desc>Sets the scroll speed in the Y direction
@return No return value.</desc>
</method>
<method>
<name>setSourceRect</name>
<args>S32 x, S32 y, S32 w, S32 h</args>
<desc>Set the source rect for the object</desc>
</method>
<field>
<name>imageMap</name>
<desc>string imageMap</desc>
</field>
<field>
<name>repeatX</name>
<desc>float repeatX</desc>
</field>
<field>
<name>repeatY</name>
<desc>float repeatY</desc>
</field>
<field>
<name>scrollPositionX</name>
<desc>float scrollPositionX</desc>
</field>
<field>
<name>scrollPositionY</name>
<desc>float scrollPositionY</desc>
</field>
<field>
<name>scrollX</name>
<desc>float scrollX</desc>
</field>
<field>
<name>scrollY</name>
<desc>float scrollY</desc>
</field>
<field>
<name>sourceRect</name>
<desc>RectF sourceRect</desc>
</field>
<field>
<name>useSourceRect</name>
<desc>bool useSourceRect</desc>
</field>
</class>
<class>
<name>t2dShape3D</name>
<base>t2dSceneObject</base>
<method>
<name>getCurrentDetailLevel</name>
<desc>Get the current detail level.
@return Returns the detail level as a integer.</desc>
</method>
<method>
<name>getCurrentIntraDetailLevel</name>
<desc>Get current Intra-Detail-Level.
@return Returns the intra-detail level as a floating point value between 0.0 and 1.0 (0.0 is return on failure)</desc>
</method>
<method>
<name>getDetailLevelCount</name>
<desc>Gets the number of detail levels defined in the dts shape.
@return Return the count as a nonnegative integer. Returns 0 on failure.</desc>
</method>
<method>
<name>getShapeAngularRotation</name>
<desc>@return Returns the angular rotation as a string formatted as "axis.x axis.y axis.z angle"</desc>
</method>
<method>
<name>getShapeAngularVelocity</name>
<desc>@return Returns the angular velocity as a string formatted as "val.x val.y val.z"</desc>
</method>
<method>
<name>getShapeOffset</name>
<desc>@return Returns the shape's offset as a string formatted as "val.x val.y val.z"</desc>
</method>
<method>
<name>getShapeRotation</name>
<desc>@return Returns the shape rotation as a string formatted as "val.x val.y val.z"</desc>
</method>
<method>
<name>getShapeScale</name>
<desc>@return Returns the shape's scale as a string formatted as "val.x val.y val.z"</desc>
</method>
<method>
<name>getTextureFileList</name>
<desc>@return Retrieves a tab separated list of all textures used by this shape.</desc>
</method>
<method>
<name>playAnimation</name>
<args> animationName, [startTime], [transitionTime] </args>
<desc>- Plays an Animation by Sequence Name.
@param animationName The internal name of the desired animation.
@param startTime (optional) The start time to set (default 0.0f)
@param transitionTime The transition time between animations (default 0.0f)
@return Returns true on success.</desc>
</method>
<method>
<name>playAnimationSequence</name>
<args> sequence, [startTime], [transitionTime]  </args>
<desc>- Plays an Animation by Sequence Index.@param sequence Index of desired animation.
@param startTime (optional) The start time to set (default 0.0f)
@param transitionTime The transition time (default 0.0f)
@return Returns true on success.</desc>
</method>
<method>
<name>setDetailLevel</name>
<args>detailLevel, [intraDetail] </args>
<desc>Sets Current Detail Level.
@param detailLevel The detail level to display. It must be defined within the dts shape.
@param intraDetail (optional) The intra detail level. This is the percentage to the next detail level. (default 1.0f)
@return Returns true on success. False otherwise.</desc>
</method>
<method>
<name>setShape</name>
<args> shapeFile$ </args>
<desc>- Loads a shape into the object.@param shapeFile The file where shape is stored.@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>setShapeAngularVelocity</name>
<args>x / y / z</args>
<desc>- Sets Shape Angular Velocity.@param x/y/z Directional components either as (x,y,z) or ("x y z")
@return Returns true on success.</desc>
</method>
<method>
<name>setShapeOffset</name>
<args>x / y / z</args>
<desc>- Sets Shape Offset.@param x/y/z Directional components either as (x,y,z) or ("x y z")
@return Returns true on success.</desc>
</method>
<method>
<name>setShapeRotation</name>
<args>x / y / z</args>
<desc>- Sets Shape Rotation
@param x/y/z Directional components either as (x,y,z) or ("x y z")
@return Returns true on success.</desc>
</method>
<method>
<name>setShapeScale</name>
<args>x [/ y / z]</args>
<desc>- Sets Shape Offset.@param x/y/z Scale components either as (x,y,z) or ("x y z")
@return Returns true on success.</desc>
</method>
<method>
<name>setSkin</name>
<args> skinSet$, skinName$ </args>
<desc>- Changes the skin to the specified texture
@param skinSet Set in which desired skin is located.
@param Name of desired texture.
@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>setTimeScale</name>
<args> timeScale </args>
<desc>Set the animation time-scale.
@param timeScale Desired time scale value.
@return Returns true on success.</desc>
</method>
<method>
<name>setTriggerActive</name>
<args>status</args>
<desc>Sets Trigger active/inactive.
@param status Boolean. Set true for active, false for inactive.
@return Returns true on success.</desc>
</method>
<field>
<name>animation</name>
<desc>string animation</desc>
</field>
<field>
<name>detailLevel</name>
<desc>int detailLevel</desc>
</field>
<field>
<name>intraDetailLevel</name>
<desc>int intraDetailLevel</desc>
</field>
<field>
<name>shape</name>
<desc>filename shape</desc>
</field>
<field>
<name>shapeAngularVelocity</name>
<desc>Point3F shapeAngularVelocity</desc>
</field>
<field>
<name>shapeOffset</name>
<desc>Point3F shapeOffset</desc>
</field>
<field>
<name>shapeRotation</name>
<desc>Point3F shapeRotation</desc>
</field>
<field>
<name>shapeScale</name>
<desc>Point3F shapeScale</desc>
</field>
</class>
<class>
<name>t2dShapeVector</name>
<base>t2dSceneObject</base>
<method>
<name>getFillColor</name>
<desc>Gets the Rendering Fill Color.
@return Returns the fill color as a string formatted with "Red Green Blue Alpha"</desc>
</method>
<method>
<name>getFillMode</name>
<desc>Gets the Rendering Fill Mode.
@return The fill mode as a boolean value.</desc>
</method>
<method>
<name>getLineColor</name>
<desc>Gets the Rendering Line Color.
@return Returns the fill color as a string formatted with "Red Green Blue Alpha"</desc>
</method>
<method>
<name>getPoly</name>
<desc>Gets Polygon.
@return (poly-Definition) The vertices of the polygon in object space.</desc>
</method>
<method>
<name>setFillAlpha</name>
<args>alpha</args>
<desc>Sets the Rendering Fill Alpha (transparency).
@param alpha The alpha value.
@return No return value.</desc>
</method>
<method>
<name>setFillColor</name>
<args>R / G / B / [A]</args>
<desc>- Sets the Rendering Fill Color (identical to setFillColour).
@param R/G/B/[A] Color values (0.0f - 1.0f) formatted as ("Red Green Blue [Alpha]"). Alpha is optional.
@return No return value.</desc>
</method>
<method>
<name>setFillColour</name>
<args>R / G / B / [A]</args>
<desc>Sets the Rendering Fill Colour (identical to setFillColor).
@param R/G/B/[A] Color values (0.0f - 1.0f) formatted as ("Red Green Blue [Alpha]"). Alpha is optional.
@return No return value.</desc>
</method>
<method>
<name>setFillMode</name>
<args>fillMode?</args>
<desc>Sets the Rendering Fill Mode.
@return No return value.</desc>
</method>
<method>
<name>setLineAlpha</name>
<args>alpha</args>
<desc>Sets the Rendering Line Alpha (transparency).
@param alpha The alpha value.
@return No return value.</desc>
</method>
<method>
<name>setLineColor</name>
<args>R / G / B / [A]</args>
<desc>- Sets the Rendering Line Color(identical to setLineColour).
@param R/G/B/[A] Color values (0.0f - 1.0f) formatted as ("Red Green Blue [Alpha]"). Alpha is optional.
@return No return value.</desc>
</method>
<method>
<name>setLineColour</name>
<args>R / G / B / [A]</args>
<desc>Sets the Rendering Line Colour (identical to setLineColor).
@param R/G/B/[A] Color values (0.0f - 1.0f) formatted as ("Red Green Blue [Alpha]"). Alpha is optional.
@return No return value.</desc>
</method>
<method>
<name>setPolyCustom</name>
<args>poly-count, poly-Definition$</args>
<desc>Sets Custom Polygon.
@return No return value.</desc>
</method>
<method>
<name>setPolyPrimitive</name>
<args>vertexCount</args>
<desc>Sets a regular polygon primitive.
@return No return value.</desc>
</method>
<method>
<name>setPolyScale</name>
<args>widthScale / [heightScale]</args>
<desc>- Sets the polygon scale.
@param width/heightScale The scale values of the given polygon. If no height is specified, the widthScale value is repeated.
@return No return value.</desc>
</method>
<field>
<name>fillColor</name>
<desc>ColorF fillColor</desc>
</field>
<field>
<name>FillMode</name>
<desc>bool FillMode</desc>
</field>
<field>
<name>LineColor</name>
<desc>ColorF LineColor</desc>
</field>
<field>
<name>PolyList</name>
<desc>point2FList PolyList</desc>
</field>
</class>
<class>
<name>t2dStaticSprite</name>
<base>t2dSceneObject</base>
<method>
<name>getFrame</name>
<desc>- Gets current imageMap Frame.
@return (int frame) The frame currently being displayed</desc>
</method>
<method>
<name>getImageMap</name>
<desc>- Gets current imageMap name.
@return (string imageMapName) The imagemap being displayed</desc>
</method>
<method>
<name>getSpriteSourceRect</name>
<desc>- Gets the source rect of this sprite.
@return (four component rect) X Y Width Height</desc>
</method>
<method>
<name>getUseSourceRect</name>
<desc>- Gets whether the source rects are used in this sprite.
@return (bool) YES or NO</desc>
</method>
<method>
<name>setFrame</name>
<args>int frame</args>
<desc>- Sets imageMap frame.
@param frame The frame to display
@return Returns true on success.</desc>
</method>
<method>
<name>setImageMap</name>
<args>string imageMapName, [int frame]</args>
<desc>- Sets imageMap/Frame.
@param imageMapName The imagemap to display
@param frame The frame of the imagemap to display
@return Returns true on success.</desc>
</method>
<method>
<name>setSpriteSourceRect</name>
<args>S32 x, S32 y, S32 w, S32 h</args>
<desc>Set the source rect for the object</desc>
</method>
<method>
<name>setUseSourceRect</name>
<desc>- Sets whether the source rects are used in this sprite.
@return (void))</desc>
</method>
<field>
<name>frame</name>
<desc>int frame</desc>
</field>
<field>
<name>imageMap</name>
<desc>string imageMap</desc>
</field>
<field>
<name>sourceRect</name>
<desc>RectF sourceRect</desc>
</field>
<field>
<name>useSourceRect</name>
<desc>bool useSourceRect</desc>
</field>
</class>
<class>
<name>t2dTestTile</name>
<base>t2dActiveTile</base>
</class>
<class>
<name>t2dTestTileDatablock</name>
<base>t2dActiveTileDatablock</base>
</class>
<class>
<name>t2dTextObject</name>
<base>t2dSceneObject</base>
<method>
<name>addAutoFontSize</name>
<args>S32 screenHeight, F32 cameraHeight, F32 characterHeight</args>
<desc>Adds a font size based on a screen height, camera height, and character height. The resulting font size is automatically calculated.
@param screenHeight The height of the screen to generate the font for.
@param cameraHeight The height of the camera to generate the font for.
@param characterHeight The height of the text in world units to generate the size for.
@return Whether or not the font was created successfully.</desc>
</method>
<method>
<name>addFontSize</name>
<args>S32 fontSize</args>
<desc>Adds a font size to the text object. Additional font sizes can make the font look better at more display sizes and resolutions.@param fontSize The font size to add to the text object.
@return Whether or not the creation of the font was successful.</desc>
</method>
<method>
<name>removeAllFontSizes</name>
<desc>Removes all of the font sizes from the text object. Effectively, all fonts will be removed, so, nothing will be rendered until a font size is added.
@return No return value.</desc>
</method>
<method>
<name>removeFontSize</name>
<args>S32 fontSize</args>
<desc>Removes a font from the text object.
@param fontSize The font size to remove from the text object.
@return No return value.</desc>
</method>
<field>
<name>aspectRatio</name>
<desc>The ratio of a characters width to its height.</desc>
</field>
<field>
<name>autoSize</name>
<desc>Whether or not the object should be scaled when the text is changed.</desc>
</field>
<field>
<name>bilinearFilter</name>
<desc>Whether or not the font uses bilinear filtering</desc>
</field>
<field>
<name>characterSpacing</name>
<desc>The amount of extra space to include between each character.</desc>
</field>
<field>
<name>font</name>
<desc>The name of the font to render the text with.</desc>
</field>
<field>
<name>fontSizes</name>
<desc>Space separated list of font sizes the text object should use.</desc>
</field>
<field>
<name>hideOverflow</name>
<desc>Whether or not text outside the object bounds should be hidden.</desc>
</field>
<field>
<name>lineHeight</name>
<desc>The height, in world units, of each line. Normally this would be specified by the font size, but the text object is designed to scale with resolution changes, so this parameter becomes necessary.</desc>
</field>
<field>
<name>lineSpacing</name>
<desc>The amount of extra space to include between each line.</desc>
</field>
<field>
<name>noUnicode</name>
<desc>Whether or not the text doesn't need to support Unicode conversions (ie. know that it is just numbers, standard english, etc.)</desc>
</field>
<field>
<name>snapToInteger</name>
<desc>Whether or not the font destination is clamped to start on an integer value</desc>
</field>
<field>
<name>text</name>
<desc>The text that is displayed by the object.</desc>
</field>
<field>
<name>textAlign</name>
<desc>The alignment of the text within the object bounds.&lt;br&gt;Possible Values&lt;br&gt; -Left: Each line begins at the left bounds of the object.&lt;br&gt; -Right: Each line ends at the right bounds of the object.&lt;br&gt; -Center: Each line of text is centered within the object bounds.&lt;br&gt; -Justify: Text on complete lines is spaced out to fill the object bounds.&lt;br&gt;</desc>
</field>
<field>
<name>textColor</name>
<desc>The color of the text.</desc>
</field>
<field>
<name>wordWrap</name>
<desc>Whether or not text should automatically wrap to the next line.</desc>
</field>
</class>
<class>
<name>t2dTileLayer</name>
<base>t2dSceneObject</base>
<method>
<name>clearLayer</name>
<desc>Deletes All Layer Tiles.
@return No return value.</desc>
</method>
<method>
<name>clearTile</name>
<args>int tileX, int tileY </args>
<desc>- Clears a Tile.
@param tileX The X coordinate of the tile to clear
@param tileY The Y coordinate of the tile to clear
@return No return value.</desc>
</method>
<method>
<name>createLayer</name>
<args>int tileCountX, int tileCountY, float tileSizeX, float tileSizeY</args>
<desc>- Creates a tile layer.
@param tileCountX The number of tiles in the X direction
@param tileCountY The number of tiles in the Y direction
@param tileSizeX The width of an individual tile
@param tileSizeY The height of an individual tile
@return No return value.</desc>
</method>
<method>
<name>getAutoPanX</name>
<desc>- Get the auto-pan rate
@return (float autoPanX) The rate of horizontal panning</desc>
</method>
<method>
<name>getAutoPanY</name>
<desc>- Get the auto-pan rate
@return (float autoPanY) The rate of vertical panning</desc>
</method>
<method>
<name>getPanPositionX</name>
<desc>- Get the X pan position
@return (float panX) The X pan position</desc>
</method>
<method>
<name>getPanPositionY</name>
<desc>- Get the Y pan position
@return (float panY) The Y pan position</desc>
</method>
<method>
<name>getTileCollision</name>
<args>int tileX, int tileY</args>
<desc>- Gets a tile collision options.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (string info) The collision information from the tile</desc>
</method>
<method>
<name>getTileCount</name>
<desc>- Gets Tile Count.
@return (t2dVector count) A two-element vector with the number of tiles in the X and Y direction</desc>
</method>
<method>
<name>getTileCountX</name>
<desc>- Get the number of tiles in the X direction
@return (int TileCountX) The number of tiles in the X direction</desc>
</method>
<method>
<name>getTileCountY</name>
<desc>- Get the number of tiles in the Y direction
@return (int TileCountY) The number of tiles in the Y direction</desc>
</method>
<method>
<name>getTileCustomData</name>
<args>int tileX, int tileY </args>
<desc>- Gets a tile custom-data.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (string data) The custom data from the tile</desc>
</method>
<method>
<name>getTileFlip</name>
<args>int tileX, int tileY </args>
<desc>- Gets a tile flip options.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (t2dVector flip) A two element vector that gives you the flipX and flipY values</desc>
</method>
<method>
<name>getTileScript</name>
<args>int tileX / int tileY </args>
<desc>- Gets a tile script.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (string script) The tileScript assigned to the tile</desc>
</method>
<method>
<name>getTileScriptActioned</name>
<args>int tileX, int tileY</args>
<desc>- Gets a tile script actioned-flag.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (bool actioned-flag) Whether the script actioned-flag has been set</desc>
</method>
<method>
<name>getTileSize</name>
<desc>- Gets Tile Size.
@return (t2dVector size) A two-element vector with the width and height of an individual tile</desc>
</method>
<method>
<name>getTileSizeX</name>
<desc>- Get the width of an individual tile
@return (float sizeX) The width of an individual tile</desc>
</method>
<method>
<name>getTileSizeY</name>
<desc>- Get the height of an individual tile
@return (float sizeY) The height of an individual tile</desc>
</method>
<method>
<name>getTileType</name>
<args>int tileX, int tileY </args>
<desc>- Gets a tile type.
@param tileX the X coordinate of the tile
@param tileY the Y coordinate of the tile
@return (string tileType) The type of the tyle (static, animated, active)</desc>
</method>
<method>
<name>getWrapX</name>
<desc>- Get Wrap Options.
@return (bool wrapX) Whether the tilelayer wraps in the X direction</desc>
</method>
<method>
<name>getWrapY</name>
<desc>- Get Wrap Options.
@return (bool wrapY) Whether the tilelayer wraps in the Y direction</desc>
</method>
<method>
<name>loadTileLayer</name>
<args>string tileLayerFile</args>
<desc>- Loads a Tile-Layer File.
@param tileLayerFile The tileLayer file to load@return Returns true on success.</desc>
</method>
<method>
<name>pickTile</name>
<args>int tileX, int tileY</args>
<desc>- Picks Tile from world position.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@return (t2dVector tileCoordinate) The tile at that world position</desc>
</method>
<method>
<name>resetLayer</name>
<desc>Resets dynamic properties of the Tile-Layer.
@return No return value.</desc>
</method>
<method>
<name>resizeLayer</name>
<args>int TileCountX, int TileCountY</args>
<desc>- Resize Tile Layer.
@param TileCountX The new number of tiles in the X direction
@param TileCountY The new number of tiles in the Y direction
@return No return value.</desc>
</method>
<method>
<name>saveTileLayer</name>
<args>string tileLayerFile</args>
<desc>- Saves a Tile-Layer File.
@param tileLayerFile The tileLayer file to save to
@return Returns true on success.</desc>
</method>
<method>
<name>setActiveTile</name>
<args>int tileX, int tileY, string activeTileClass, [string activeTileDatablockName]</args>
<desc>- Sets an Active Tile.
@param tileX the X coordinate of the tile to set
@param tileY the Y coordinate of the tile to set
@param activeTileClass The class of the active tile
@param activeTileDatablockName The datablock for the active tile
@return Returns ID of tile or 0 on fail.</desc>
</method>
<method>
<name>setAnimatedTile</name>
<args>int tileX, int tileY, string animationName, [bool forceUnique]</args>
<desc>- Sets an Animated Tile.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param animationName The animation to set the tile to
@param forceUnique
@return Return true on success</desc>
</method>
<method>
<name>setAutoPan</name>
<args>float autoPanX, float autoPanY</args>
<desc>- Sets Auto-Pan.
@param autoPanX The rate of horizontal panning
@param autoPanY The rate of vertical panning
@return No return value.</desc>
</method>
<method>
<name>setAutoPanPolar</name>
<args>float angle, float panSpeed</args>
<desc>- Sets Auto-Pan Polarwise.
@param angle The direction of panning
@param panSpeed The speed to pan in that direction
@return No return value.</desc>
</method>
<method>
<name>setAutoPanX</name>
<args>float autoPanX</args>
<desc>- Set the auto-pan in the X direction
@param autoPanX The rate of horizontal panning
@return No return value.</desc>
</method>
<method>
<name>setAutoPanY</name>
<args>float autoPanY</args>
<desc>- Set the auto-pan in the Y direction
@param autoPanY The rate of vertical panning
@return No return value.</desc>
</method>
<method>
<name>setCursorIconActive</name>
<args>bool status, float blinkTime</args>
<desc>- Set cursor-icon status.
@param status Whether the cursor is active
@param blinkTime The cursors blink time
@return No return value.</desc>
</method>
<method>
<name>setCursorPosition</name>
<args>int tileX, int tileY</args>
<desc>- Set cursor position.
@param tileX The X coordinate to position the cursor at
@param tileY the Y coordinate to position the cursor at
@return No return value.</desc>
</method>
<method>
<name>setCustomIconActive</name>
<args>bool status</args>
<desc>- Set custom-data-icon status.
@param status Whether the custom data icon is active or not
@return No return value.</desc>
</method>
<method>
<name>setGridActive</name>
<args>bool status</args>
<desc>- Set grid-lines status.
@param status Whether the grid-lines are on or off
@return No return value.</desc>
</method>
<method>
<name>setPanPosition</name>
<args>float panX, float panY</args>
<desc>- Sets Pan Position.
@param panX The X pan value
@param panY The Y pan value
@return No return value.</desc>
</method>
<method>
<name>setPanPositionX</name>
<args>float panX</args>
<desc>- Set the X pan position
@param panX The X pan value
@return No return value.</desc>
</method>
<method>
<name>setPanPositionY</name>
<args>float panY</args>
<desc>- Set the Y pan position
@param panY The Y pan value
@return No return value.</desc>
</method>
<method>
<name>setScriptIconActive</name>
<args>bool status</args>
<desc>- Set script-icon status.
@param status Whether or not the script-icon is active
@return No return value.</desc>
</method>
<method>
<name>setStaticTile</name>
<args>int tileX, int tileY, string imageMapName, [int frame] </args>
<desc>- Sets a Static Tile.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param imageMapName The imagemap to set the tile to
@param frame The frame of the imagemap to use
@return Returns true on success.</desc>
</method>
<method>
<name>setTileCollisionActive</name>
<args>int tileX, int tileY, bool receiveCollision</args>
<desc>- Sets Tile Receive Collisions.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param recieveCollision Whether or not the tile should recieve collisions
@return Returns true on success.</desc>
</method>
<method>
<name>setTileCollisionPolyCustom</name>
<desc>int tileX, int tileY, int poly-count, string poly-Definition) - Sets Tile Custom Collision Polygon.@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param poly-count The number of sides in the custom polygon
@param poly-definition The custom polygon to assign to the tile
@return Returns true on success.</desc>
</method>
<method>
<name>setTileCollisionPolyPrimitive</name>
<args>int tileX, int tileY, int poly-count</args>
<desc>- Sets Tile Primitive Collision Polygon.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param poly-count The number of sides of the regular polygon to set as the collision polygon for the tile
@return Returns true on success.</desc>
</method>
<method>
<name>setTileCollisionScale</name>
<args>int tileX, int tileY, float widthScale, [float heightScale]</args>
<desc>- Sets Tile collision scale.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param widthScale The widthScale to set
@param heightScale The heightScale to set
@return Returns true on success.</desc>
</method>
<method>
<name>setTileCountX</name>
<args>int TileCountX</args>
<desc>@param TileCountX The new number of tiles in the X direction
@return No return value.</desc>
</method>
<method>
<name>setTileCountY</name>
<args>int TileCountY</args>
<desc>@param TileCountY The new number of tiles in the Y direction
@return No return value.</desc>
</method>
<method>
<name>setTileCustomData</name>
<args>int tileX, int tileY, string data</args>
<desc>- Sets custom data on a Tile.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param data The custom data to assign to the tile
@return Returns true on success.</desc>
</method>
<method>
<name>setTileFlip</name>
<args>int tileX, int tileY, bool flipHorz, bool flipVert</args>
<desc>- Sets Tile Flipping.
@param tileX The X coordinate of the tile
@param tileY The Y coordinate of the tile
@param flipHorz Whether to flip the tile horizontally
@param flipVert Whether to flip the tile vertically
@return Returns true on success.</desc>
</method>
<method>
<name>setTileIcons</name>
<args>string tileIconImageMap</args>
<desc>- Set tile-icons imagemap.
@param tileIconImageMap The imagemap to use for the tile icons
@return No return value.</desc>
</method>
<method>
<name>setTileScript</name>
<args>int tileX, int tileY, string script</args>
<desc>- Sets a Script on a Tile.
@param tileX The X coordinate of the tile to set
@param tileY The Y coordinate of the tile to set
@param script The script to assign to the tile

@return Returns true on success.</desc>
</method>
<method>
<name>setTileSize</name>
<args>float tileSizeX, float tileSizeY</args>
<desc>- Sets Tile Size.
@param sizeX The width of an individual tile
@param sizeY The height of an individual tile
@return No return value.</desc>
</method>
<method>
<name>setTileSizeX</name>
<args>float sizeX</args>
<desc>- Set the tile size
@param sizeX The width of an individual tile
@return No return value.</desc>
</method>
<method>
<name>setTileSizeY</name>
<args>float sizeY</args>
<desc>- Set the tile size
@param sizeY The height of an individual tile
@return No return value.</desc>
</method>
<method>
<name>setWrap</name>
<args>bool wrapX, bool wrapY</args>
<desc>- Sets Wrap Options.
@param wrapX Whether to wrap in the X direction
@param wrapY Whether to wrap in the Y direction
@return No return value.</desc>
</method>
<method>
<name>setWrapX</name>
<args>bool wrapX</args>
<desc>- Sets Wrap Options.
@param wrapX Whether to wrap in the X direction
@return No return value.</desc>
</method>
<method>
<name>setWrapY</name>
<args>bool wrapY</args>
<desc>- Sets Wrap Options.
@param wrapY Whether to wrap in the Y direction
@return No return value.</desc>
</method>
<field>
<name>LayerFile</name>
<desc>filename LayerFile</desc>
</field>
</class>
<class>
<name>t2dTileMap</name>
<base>t2dSceneObject</base>
<method>
<name>addTileLayer</name>
<args>t2dTileLayer layer</args>
<desc>- Adds a layer to the map
@param layer The layer to add to the tilemap
@return No return value.</desc>
</method>
<method>
<name>createTileLayer</name>
<args>int tileCountX, int tileCountY, float tileSizeX, float tileSizeY</args>
<desc>- Creates a Tile Layer.
@param tileCountX The number of tiles in the X direction
@param tileCountY The number of tiles in the Y direction
@param tileSizeX The width of an individual tile
@param tileSizeY The height of an individual tile
@return Returns either the ID of the new layer or 0 on failure</desc>
</method>
<method>
<name>deleteAllLayers</name>
<desc>Deletes all Tile Layer(s).
@return No return value.</desc>
</method>
<method>
<name>deleteTileLayer</name>
<args>int layerIndex</args>
<desc>- Deletes a Tile Layer.
@param layerIndex The index of the layer to delete
@return No return value.</desc>
</method>
<method>
<name>deleteTileLayerId</name>
<args>int tileLayerID</args>
<desc>- Deletes a Tile Layer (by Id).
@param tileLayerID The ID of the layer to delete
@return No return value.</desc>
</method>
<method>
<name>getTileLayer</name>
<args>int layerIndex</args>
<desc>- Get a Tile Layer from the tilemap by Index.
@param layerIndex The index of the layer you want to get
@return (t2dTileLayer layer) the layer you requested</desc>
</method>
<method>
<name>getTileLayerCount</name>
<desc>Get the number of layers in the tilemap.
@return (int layerCount) The number of layers in the tilemap</desc>
</method>
<method>
<name>loadTileMap</name>
<args>string tileMapFile</args>
<desc>- Loads a Tilemap File.
@param tileMapFile The tilemap file to load
@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>loadTileMapDataBlock</name>
<args>string tileMapDatablock</args>
<desc>- Loads a Tilemap from a Datablock.
@param tileMapDatablock The tilemap datablock to load@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>removeTileLayer</name>
<args>t2dTileLayer layer</args>
<desc>Removes a layer from the map
@param layer The layer to remove
@return No return value.</desc>
</method>
<method>
<name>saveTileMap</name>
<args>string tileMapFile</args>
<desc>- Saves a Tilemap File.
@param tileMapFile Saves the tilemap to a file
@return Returns true on success, false otherwise.</desc>
</method>
<method>
<name>setAllLayersToParent</name>
<desc>- Synchronizes all tile-layers to parents position/size/rotation.@return No return value.</desc>
</method>
</class>
<class>
<name>t2dTrigger</name>
<base>t2dSceneObject</base>
<method>
<name>getEnterCallback</name>
<desc>@return Returns whether trigger checks onEnter events</desc>
</method>
<method>
<name>getLeaveCallback</name>
<desc>@return Returns whether trigger checks onLeave events</desc>
</method>
<method>
<name>getStayCallback</name>
<desc>@return Returns whether trigger checks onStay events</desc>
</method>
<method>
<name>setEnterCallback</name>
<args>[setting]</args>
<desc>Set whether trigger checks onEnter events
@param setting Default is true.
@return No return value.</desc>
</method>
<method>
<name>setLeaveCallback</name>
<args>[setting]</args>
<desc>Set whether trigger checks onLeave events
@param setting Default is true.
@return No return value.</desc>
</method>
<method>
<name>setStayCallback</name>
<args>[setting]</args>
<desc>Set whether trigger checks onStay events
@param setting Default is true.
@return No return value.</desc>
</method>
<field>
<name>EnterCallback</name>
<desc>bool EnterCallback</desc>
</field>
<field>
<name>LeaveCallback</name>
<desc>bool LeaveCallback</desc>
</field>
<field>
<name>StayCallback</name>
<desc>bool StayCallback</desc>
</field>
</class>
<class>
<name>TCPGroup</name>
<base>SimGroup</base>
</class>
<class>
<name>TCPObject</name>
<base>SimObject</base>
<method>
<name>connect</name>
<args> addr </args>
<desc>Use the connect method to request a connection to a remote agent at the address addr.
@param addr A string containing an address of the form: “A.B.C.D:Port”, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536.
@return No return value.
@sa disconnect</desc>
</method>
<method>
<name>disconnect</name>
<desc>Use the disconnect method to close a previously opened connection without destroying the requesting TCPOpbject.
This will close any open connection, but not destroy this object. Thus, the object can be used to open a new connection.
@return No return value.
@sa connect</desc>
</method>
<method>
<name>listen</name>
<args> port </args>
<desc>Use the listen method to allow this TCPObject to accept connections on the specified port.
@param port A value between 1000 and 65536.
@return No return value</desc>
</method>
<method>
<name>send</name>
<args> ... </args>
<desc>Use the send method to send any number of parameters, as strings, one at a time to the agent at the other end of the connection.
@param ... Any number of arguments, as strings. Each string is sent separately. i.e. The arguments are not concatenated.
@return No return value</desc>
</method>
</class>
<class>
<name>TextChunk</name>
<base>SimChunk</base>
<field>
<name>textData</name>
<desc>string textData</desc>
</field>
</class>
<class>
<name>TSShapeConstructor</name>
<base>SimDataBlock</base>
<field>
<name>baseShape</name>
<desc>filename baseShape</desc>
</field>
<field>
<name>sequence0</name>
<desc>filename sequence0</desc>
</field>
<field>
<name>sequence1</name>
<desc>filename sequence1</desc>
</field>
<field>
<name>sequence10</name>
<desc>filename sequence10</desc>
</field>
<field>
<name>sequence100</name>
<desc>filename sequence100</desc>
</field>
<field>
<name>sequence101</name>
<desc>filename sequence101</desc>
</field>
<field>
<name>sequence102</name>
<desc>filename sequence102</desc>
</field>
<field>
<name>sequence103</name>
<desc>filename sequence103</desc>
</field>
<field>
<name>sequence104</name>
<desc>filename sequence104</desc>
</field>
<field>
<name>sequence105</name>
<desc>filename sequence105</desc>
</field>
<field>
<name>sequence106</name>
<desc>filename sequence106</desc>
</field>
<field>
<name>sequence107</name>
<desc>filename sequence107</desc>
</field>
<field>
<name>sequence108</name>
<desc>filename sequence108</desc>
</field>
<field>
<name>sequence109</name>
<desc>filename sequence109</desc>
</field>
<field>
<name>sequence11</name>
<desc>filename sequence11</desc>
</field>
<field>
<name>sequence110</name>
<desc>filename sequence110</desc>
</field>
<field>
<name>sequence111</name>
<desc>filename sequence111</desc>
</field>
<field>
<name>sequence112</name>
<desc>filename sequence112</desc>
</field>
<field>
<name>sequence113</name>
<desc>filename sequence113</desc>
</field>
<field>
<name>sequence114</name>
<desc>filename sequence114</desc>
</field>
<field>
<name>sequence115</name>
<desc>filename sequence115</desc>
</field>
<field>
<name>sequence116</name>
<desc>filename sequence116</desc>
</field>
<field>
<name>sequence117</name>
<desc>filename sequence117</desc>
</field>
<field>
<name>sequence118</name>
<desc>filename sequence118</desc>
</field>
<field>
<name>sequence119</name>
<desc>filename sequence119</desc>
</field>
<field>
<name>sequence12</name>
<desc>filename sequence12</desc>
</field>
<field>
<name>sequence120</name>
<desc>filename sequence120</desc>
</field>
<field>
<name>sequence121</name>
<desc>filename sequence121</desc>
</field>
<field>
<name>sequence122</name>
<desc>filename sequence122</desc>
</field>
<field>
<name>sequence123</name>
<desc>filename sequence123</desc>
</field>
<field>
<name>sequence124</name>
<desc>filename sequence124</desc>
</field>
<field>
<name>sequence125</name>
<desc>filename sequence125</desc>
</field>
<field>
<name>sequence126</name>
<desc>filename sequence126</desc>
</field>
<field>
<name>sequence13</name>
<desc>filename sequence13</desc>
</field>
<field>
<name>sequence14</name>
<desc>filename sequence14</desc>
</field>
<field>
<name>sequence15</name>
<desc>filename sequence15</desc>
</field>
<field>
<name>sequence16</name>
<desc>filename sequence16</desc>
</field>
<field>
<name>sequence17</name>
<desc>filename sequence17</desc>
</field>
<field>
<name>sequence18</name>
<desc>filename sequence18</desc>
</field>
<field>
<name>sequence19</name>
<desc>filename sequence19</desc>
</field>
<field>
<name>sequence2</name>
<desc>filename sequence2</desc>
</field>
<field>
<name>sequence20</name>
<desc>filename sequence20</desc>
</field>
<field>
<name>sequence21</name>
<desc>filename sequence21</desc>
</field>
<field>
<name>sequence22</name>
<desc>filename sequence22</desc>
</field>
<field>
<name>sequence23</name>
<desc>filename sequence23</desc>
</field>
<field>
<name>sequence24</name>
<desc>filename sequence24</desc>
</field>
<field>
<name>sequence25</name>
<desc>filename sequence25</desc>
</field>
<field>
<name>sequence26</name>
<desc>filename sequence26</desc>
</field>
<field>
<name>sequence27</name>
<desc>filename sequence27</desc>
</field>
<field>
<name>sequence28</name>
<desc>filename sequence28</desc>
</field>
<field>
<name>sequence29</name>
<desc>filename sequence29</desc>
</field>
<field>
<name>sequence3</name>
<desc>filename sequence3</desc>
</field>
<field>
<name>sequence30</name>
<desc>filename sequence30</desc>
</field>
<field>
<name>sequence31</name>
<desc>filename sequence31</desc>
</field>
<field>
<name>sequence32</name>
<desc>filename sequence32</desc>
</field>
<field>
<name>sequence33</name>
<desc>filename sequence33</desc>
</field>
<field>
<name>sequence34</name>
<desc>filename sequence34</desc>
</field>
<field>
<name>sequence35</name>
<desc>filename sequence35</desc>
</field>
<field>
<name>sequence36</name>
<desc>filename sequence36</desc>
</field>
<field>
<name>sequence37</name>
<desc>filename sequence37</desc>
</field>
<field>
<name>sequence38</name>
<desc>filename sequence38</desc>
</field>
<field>
<name>sequence39</name>
<desc>filename sequence39</desc>
</field>
<field>
<name>sequence4</name>
<desc>filename sequence4</desc>
</field>
<field>
<name>sequence40</name>
<desc>filename sequence40</desc>
</field>
<field>
<name>sequence41</name>
<desc>filename sequence41</desc>
</field>
<field>
<name>sequence42</name>
<desc>filename sequence42</desc>
</field>
<field>
<name>sequence43</name>
<desc>filename sequence43</desc>
</field>
<field>
<name>sequence44</name>
<desc>filename sequence44</desc>
</field>
<field>
<name>sequence45</name>
<desc>filename sequence45</desc>
</field>
<field>
<name>sequence46</name>
<desc>filename sequence46</desc>
</field>
<field>
<name>sequence47</name>
<desc>filename sequence47</desc>
</field>
<field>
<name>sequence48</name>
<desc>filename sequence48</desc>
</field>
<field>
<name>sequence49</name>
<desc>filename sequence49</desc>
</field>
<field>
<name>sequence5</name>
<desc>filename sequence5</desc>
</field>
<field>
<name>sequence50</name>
<desc>filename sequence50</desc>
</field>
<field>
<name>sequence51</name>
<desc>filename sequence51</desc>
</field>
<field>
<name>sequence52</name>
<desc>filename sequence52</desc>
</field>
<field>
<name>sequence53</name>
<desc>filename sequence53</desc>
</field>
<field>
<name>sequence54</name>
<desc>filename sequence54</desc>
</field>
<field>
<name>sequence55</name>
<desc>filename sequence55</desc>
</field>
<field>
<name>sequence56</name>
<desc>filename sequence56</desc>
</field>
<field>
<name>sequence57</name>
<desc>filename sequence57</desc>
</field>
<field>
<name>sequence58</name>
<desc>filename sequence58</desc>
</field>
<field>
<name>sequence59</name>
<desc>filename sequence59</desc>
</field>
<field>
<name>sequence6</name>
<desc>filename sequence6</desc>
</field>
<field>
<name>sequence60</name>
<desc>filename sequence60</desc>
</field>
<field>
<name>sequence61</name>
<desc>filename sequence61</desc>
</field>
<field>
<name>sequence62</name>
<desc>filename sequence62</desc>
</field>
<field>
<name>sequence63</name>
<desc>filename sequence63</desc>
</field>
<field>
<name>sequence64</name>
<desc>filename sequence64</desc>
</field>
<field>
<name>sequence65</name>
<desc>filename sequence65</desc>
</field>
<field>
<name>sequence66</name>
<desc>filename sequence66</desc>
</field>
<field>
<name>sequence67</name>
<desc>filename sequence67</desc>
</field>
<field>
<name>sequence68</name>
<desc>filename sequence68</desc>
</field>
<field>
<name>sequence69</name>
<desc>filename sequence69</desc>
</field>
<field>
<name>sequence7</name>
<desc>filename sequence7</desc>
</field>
<field>
<name>sequence70</name>
<desc>filename sequence70</desc>
</field>
<field>
<name>sequence71</name>
<desc>filename sequence71</desc>
</field>
<field>
<name>sequence72</name>
<desc>filename sequence72</desc>
</field>
<field>
<name>sequence73</name>
<desc>filename sequence73</desc>
</field>
<field>
<name>sequence74</name>
<desc>filename sequence74</desc>
</field>
<field>
<name>sequence75</name>
<desc>filename sequence75</desc>
</field>
<field>
<name>sequence76</name>
<desc>filename sequence76</desc>
</field>
<field>
<name>sequence77</name>
<desc>filename sequence77</desc>
</field>
<field>
<name>sequence78</name>
<desc>filename sequence78</desc>
</field>
<field>
<name>sequence79</name>
<desc>filename sequence79</desc>
</field>
<field>
<name>sequence8</name>
<desc>filename sequence8</desc>
</field>
<field>
<name>sequence80</name>
<desc>filename sequence80</desc>
</field>
<field>
<name>sequence81</name>
<desc>filename sequence81</desc>
</field>
<field>
<name>sequence82</name>
<desc>filename sequence82</desc>
</field>
<field>
<name>sequence83</name>
<desc>filename sequence83</desc>
</field>
<field>
<name>sequence84</name>
<desc>filename sequence84</desc>
</field>
<field>
<name>sequence85</name>
<desc>filename sequence85</desc>
</field>
<field>
<name>sequence86</name>
<desc>filename sequence86</desc>
</field>
<field>
<name>sequence87</name>
<desc>filename sequence87</desc>
</field>
<field>
<name>sequence88</name>
<desc>filename sequence88</desc>
</field>
<field>
<name>sequence89</name>
<desc>filename sequence89</desc>
</field>
<field>
<name>sequence9</name>
<desc>filename sequence9</desc>
</field>
<field>
<name>sequence90</name>
<desc>filename sequence90</desc>
</field>
<field>
<name>sequence91</name>
<desc>filename sequence91</desc>
</field>
<field>
<name>sequence92</name>
<desc>filename sequence92</desc>
</field>
<field>
<name>sequence93</name>
<desc>filename sequence93</desc>
</field>
<field>
<name>sequence94</name>
<desc>filename sequence94</desc>
</field>
<field>
<name>sequence95</name>
<desc>filename sequence95</desc>
</field>
<field>
<name>sequence96</name>
<desc>filename sequence96</desc>
</field>
<field>
<name>sequence97</name>
<desc>filename sequence97</desc>
</field>
<field>
<name>sequence98</name>
<desc>filename sequence98</desc>
</field>
<field>
<name>sequence99</name>
<desc>filename sequence99</desc>
</field>
</class>
<class>
<name>UndoAction</name>
<base>SimObject</base>
<method>
<name>addToManager</name>
<args>[undoManager]</args>
<desc>Adds an UndoAction to the manager@param undoManager The manager to add the object to (default NULL)
@return No Return Value</desc>
</method>
<field>
<name>actionName</name>
<desc>A brief description of the action, for UI representation of this undo/redo action.</desc>
</field>
</class>
<class>
<name>UndoManager</name>
<base>SimObject</base>
<method>
<name>clearAll</name>
<desc>Clears the undo manager.@return No Return Value</desc>
</method>
<method>
<name>getNextRedoName</name>
</method>
<method>
<name>getNextUndoName</name>
</method>
<method>
<name>getRedoCount</name>
<desc>@return Returns the number of redo Actions stored as an integer</desc>
</method>
<method>
<name>getRedoName</name>
<args> S32 index </args>
<desc>Gets the name of the Action at given index.
@param index An integer index value for the desired redo
@return The name as a string</desc>
</method>
<method>
<name>getUndoCount</name>
<desc>@return Returns the number of UndoActions stored as an integer</desc>
</method>
<method>
<name>getUndoName</name>
<args> S32 index </args>
<desc>Gets the name of the UndoAction at given index.
@param index An integer index value for the desired undo
@return The name as a string</desc>
</method>
<method>
<name>redo</name>
</method>
<method>
<name>undo</name>
</method>
<field>
<name>numLevels</name>
<desc>Number of undo &amp; redo levels.</desc>
</field>
</class>
<class>
<name>UndoScriptAction</name>
<base>UndoAction</base>
</class>
<class>
<name>UnknownChunk</name>
<base>SimChunk</base>
</class>
<class>
<name>WayPointSet</name>
<base>SimSet</base>
</class>
<class>
<name>ZipObject</name>
<base>SimObject</base>
<method>
<name>addFile</name>
<args>filename, pathInZip[, replace = true]</args>
<desc>Add a file to the zip
@param filename The name of the file
@param pathInZip The internal (to the zip) path to the file
@param replace Set whether to replace the file if one already exists with the name in the path (default true)@return Returns true on success and false otherwise</desc>
</method>
<method>
<name>closeArchive</name>
<desc>Close the zip file
@return No return value.</desc>
</method>
<method>
<name>closeFile</name>
<args>stream</args>
<desc>Close a file within the zip@param stream The file stream ID
@return No return value.</desc>
</method>
<method>
<name>deleteFile</name>
<args>pathInZip</args>
<desc>Delete a file from the zip@param pathInZip The full internal path of the file
@return Returns true on success and false otherwise.</desc>
</method>
<method>
<name>extractFile</name>
<args>pathInZip, filename</args>
<desc>Extract a file from the zip@param pathInZip The internal path of the desired file
@param filename The file's name
@return Returns true on success and false otherwise</desc>
</method>
<method>
<name>getFileEntry</name>
<args>index</args>
<desc>Get file entry.
@param index Index to file entry
@return Returns tab separated string containing filename, uncompressed size, compressed size, compression method and CRC32</desc>
</method>
<method>
<name>getFileEntryCount</name>
<desc>Get number of files in the zip
@return Returns the number of files found in zip</desc>
</method>
<method>
<name>openArchive</name>
<args>filename, [accessMode = Read]</args>
<desc>Open a zip file@param filename The file's name
@param accessMode The mode in which to open the file (default Read)
@return Returns true on success, false otherwise@sa closeArchive, openFileForRead, openFileForWrite, closeFile</desc>
</method>
<method>
<name>openFileForRead</name>
<args>filename</args>
<desc>Open a file within the zip for reading
@param filename The file's name to open in current zip file
@return The file stream ID as an integer or zero on failure.</desc>
</method>
<method>
<name>openFileForWrite</name>
<args>filename</args>
<desc>Open a file within the zip for writing
@param filename The file's name to open in current zip file
@return The file stream ID as an integer or 0 on failure.</desc>
</method>
</class>
<function>
<name>activateDirectInput</name>
<desc>Use the activateDirectInput function to activate polling of direct input devices (keyboard, mouse, joystick, et cetera).
@return No return value.
@sa deactivateDirectInput</desc>
</function>
<function>
<name>activateKeyboard</name>
<desc>Use the activateKeyboard function to enable directInput polling of the keyboard.
@return Returns a true if polling was successfully enabled.
@sa deactivateKeyboard</desc>
</function>
<function>
<name>activatePackage</name>
<args> packageName </args>
<desc>Use the activatePackage function to activate a package definition and to re-define all functions named within this package with the definitions provided in the package body.
This pushes the newly activated package onto the top of the package stack.
@param packagename The name or ID of an existing package.
@return No return value.
@sa deactivatePackage, isPackage</desc>
</function>
<function>
<name>addBitToMask</name>
<args> mask, bit </args>
<desc>- Returns the mask with a bit added to it</desc>
</function>
<function>
<name>addCardProfile</name>
<args>string vendor, string renderer,bool safeMode, bool lockArray, bool subImage, bool fogTexture,bool noEnvColor, bool clipHigh, bool deleteContext, bool texCompressbool interiorLock, bool skipFirstFog, bool only16,bool noArraysAlpha, string proFile</args>
<desc>Register a card profile with the card profile manager.

Most of the parameters are fairly self-explanatory and very internal to the rendering code; however there are a few of note:
@param vendor   The vendor string the card claims.
@param renderer The renderer string the card claims.
@param proFile  Name of the file where further configuration information is kept.</desc>
</function>
<function>
<name>addMaterialMapping</name>
<args> materialName, map0 [ , ...-map97 ]</args>
<desc>Use the addMaterialMapping function to create a new material map instance. These maps are used by terrain and interiors for creating proper footstep sounds and dust puffs when an avatar treads upon a terrain block or interior surface using the associated texture.
There are fewer mapping types than the maximum number of maps this function will accept
@param materialName The unadorned texture name this map is associated with. For example, "sand.jpg" would have a materialName of "sand".
@param map0 At least one (required) map. See map chart below for format of these maps.
@param ... ap97 – Up to 96 additional maps.
@return No return value.</desc>
</function>
<function>
<name>addOSCardProfile</name>
<args>string vendor, string renderer, bool allowOpenGL, bool allowD3D, bool preferOpenGL</args>
<desc>Register with the profile manager what rendering mode is preferred with the specified card.</desc>
</function>
<function>
<name>addResPath</name>
<args>path, [ignoreZips=false]</args>
<desc>Add a path to the resource manager</desc>
</function>
<function>
<name>addTaggedString</name>
<args> string </args>
<desc>Use the addTaggedString function to tag a new string and add it to the NetStringTable.
@param string The string to tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag.
@return Returns a string (containing a numeric value) equivalent to the string ID for the newly tagged string</desc>
</function>
<function>
<name>alGetListener3f</name>
<args> ALEnum </args>
<desc>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri).
@sa alxGetSource*</desc>
</function>
<function>
<name>alGetListeneri</name>
<args> ALEnum </args>
<desc>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri).
@sa alxGetSource*</desc>
</function>
<function>
<name>alGetString</name>
<args> ALEnum </args>
<desc>Use the alGetString function to get the string equivalent to the specified OpenAL enumerated value.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns a string corresponding to the passed ALEnum</desc>
</function>
<function>
<name>alListener3f</name>
<args> ALEnum , x , y , z</args>
<desc>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@param x,y,z XYZ floating-point coordinates.
@return No return value.
@sa al*GetListener*, alxSource*</desc>
</function>
<function>
<name>allowConnections</name>
<args> enable </args>
<desc>Use the allowConnections to enable (or disable) remote connections to the local game server.
@param enable A boolean value enabling, or disabling connections to the local server.
@return No return value</desc>
</function>
<function>
<name>alxCreateSource</name>
<args>profile, [x,y,z]</args>
<desc>or (description, filename, [x,y,z]@param profile The ID (a non-negative integer) corresponding to the source audio profile.
@param x,y,z XYZ floating-point coordinates.
@return Returns handle to created source, or 0 on failure.</desc>
</function>
<function>
<name>alxGetChannelVolume</name>
<args> channelID </args>
<desc>Use the alxGetChannelVolume function to get the volume setting for a specified channel.
@param channelID An integer value, equal to or greater than 0, corresponding to a valid audio channel.
@return Returns volume [ 0.0, 1.0 ] for channel specified by channelID.
@sa alxSetChannelVolume</desc>
</function>
<function>
<name>alxGetListenerf</name>
<args> ALEnum </args>
<desc>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri).
@sa alxGetSource*</desc>
</function>
<function>
<name>alxGetSource3f</name>
<args> handle , ALEnum </args>
<desc>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name.
@return Returns current value of parameter specified by ALEnum for source identified by handle.
@sa alxSource*, al*GetListener*</desc>
</function>
<function>
<name>alxGetSourcef</name>
<args> handle , ALEnum </args>
<desc>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns current value of parameter specified by ALEnum for source identified by handle.
@sa alxSource*, al*GetListener*</desc>
</function>
<function>
<name>alxGetSourcei</name>
<args> handle , ALEnum </args>
<desc>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum.
Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@return Returns current value of parameter specified by ALEnum for source identified by handle.
@sa alxSource*, al*GetListener*</desc>
</function>
<function>
<name>alxGetStreamDuration</name>
<args> handle </args>
<desc>Use the alxGetStreamDuration function to determine the length of a previously set up sound in seconds.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@return Returns -1 for invalid handle, and 0.0 to N.M for valid handle indicating length of scheduled sound in seconds.
@sa alxGetStreamPosition</desc>
</function>
<function>
<name>alxGetStreamPosition</name>
<args> handle </args>
<desc>Use the alxGetStreamPosition function to get the current play position for a playing sound. Note, this value is a percentage equivalent to the percent of the sound that as already played.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@return Returns -1 for invalid handle, and 0.0 to 1.0 for valid handle indicating what percentage of the sound file has been played.
@sa alxGetStreamDuration</desc>
</function>
<function>
<name>alxGetWaveLen</name>
<args> fileName </args>
<desc>Use the alGetWaveLen function to get the play-length of a specified sound file in milliseconds.
@param fileName A full path to legally formatted sound file.
@return Returns play-length of the WAV file specified by filename in milliseconds.
@sa alxGetStreamDuration, alxGetStreamPosition</desc>
</function>
<function>
<name>alxIsPlaying</name>
<args> handle </args>
<desc>Use the alxIsPlaying function to determine if the sound associated with a previously set-up sound handle is playing or not.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@return Returns 1 if specified handle is being played, 0 otherwise.
@sa alxPlay, alxStop, alxStopAll</desc>
</function>
<function>
<name>alxListenerf</name>
<args> AlEnum , value </args>
<desc>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@param value An ALEnum type specific value corresponding to the new value for this enumerated parameters.
@return No return value.
@sa al*GetListener*, alxSource*</desc>
</function>
<function>
<name>alxPlay</name>
<args> profile [or handle] [x , y , z (with profile</args>
<desc>] ) Use the alxPlay function to start playing a sound specified by either a previously set up sound (handle), or a previously defined audio profile. For 3D sounds, you must specify a XYZ coordinate for the source to play at.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param profile The ID (a non-negative integer) corresponding to a previously set up audio profile.
@param x,y,z XYZ floating-point coordinates.
@return Returns handle to playing sound, or 0 on failure.
@sa alxIsPlaying, alxStop, alxStopAll</desc>
</function>
<function>
<name>alxSetChannelVolume</name>
<args> channelD , volume </args>
<desc>Use the alxSetChannelVolume function to set a volume [ 0.0, 1.0 ] for the channel specified by channelID.
@param channelID An integer value, equal to or greater than 0, corresponding to a valid audio channel.
@param volume A value between 0.0 and 1.0 specifying the new volume for the specified channel.
@return Returns true on success and false on failure.
@sa alxGetChannelVolume</desc>
</function>
<function>
<name>alxSource3f</name>
<args> handle , ALEnum , x , y , z </args>
<desc>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@param x,y,z XYZ floating-point coordinates.
@return No return value.
@sa alxGetSource*, al*Listener*</desc>
</function>
<function>
<name>alxSourcef</name>
<args> handle , ALEnum , value </args>
<desc>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@param value An ALEnum type specific value corresponding to the new value for this enumerated parameters.
@return No return value.
@sa alxGetSource*, al*Listener*</desc>
</function>
<function>
<name>alxSourcei</name>
<args> handle , ALEnum , value </args>
<desc>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@param ALEnum A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values.
@param value An ALEnum type specific value corresponding to the new value for this enumerated parameters.
@return No return value.
@sa alxGetSource*, al*Listener*</desc>
</function>
<function>
<name>alxStop</name>
<args> handle </args>
<desc>Use the alxStop function to stop a currently playing sound as specified by handle.
@param handle The ID (a non-negative integer) corresponding to a previously set up sound source.
@return No return value.
@sa alxIsPlaying, alxPlay, alxStopAll</desc>
</function>
<function>
<name>alxStopAll</name>
<desc>Use the alxStopAll function to stop all currently playing sounds associated with registered handles.
@return No return.
@sa alxIsPlaying, alxPlay, alxStop</desc>
</function>
<function>
<name>backtrace</name>
<desc>Use the backtrace function to print the current callstack to the console. This is used to trace functions called from withing functions and can help discover what functions were called (and not yet exited) before the current point in your scripts.
@return No return value</desc>
</function>
<function>
<name>bit</name>
<desc>Converts a bit-position into a value.</desc>
</function>
<function>
<name>bitInverse</name>
<desc>Returns the ones complement of a bit.</desc>
</function>
<function>
<name>bits</name>
<desc>Converts a list of bit-positions into a value.</desc>
</function>
<function>
<name>buildTaggedString</name>
<args> format , &lt;arg1, ...arg9&gt; </args>
<desc>Use the buildTaggedString function to build a tagged string using the specified format.
@param enable A boolean value. If set to true, network packet logging is enabled, otherwise it is disabled.
@return No return value</desc>
</function>
<function>
<name>call</name>
<args> funcName [ , args ... ] </args>
<desc>Use the call function to dynamically build and call a function.
@param funcName A string containing the unadorned name of a function to be executed.
@param args .. - Any arguments that should be passed to the function.
@return Returns a string containing the results from the function that is built and called.
@sa eval</desc>
</function>
<function>
<name>cancel</name>
<args> eventID </args>
<desc>Use the cancel function to cancel a previously scheduled event as specified by eventID.
@param eventID The numeric ID of a previously scheduled event.
@return No return value.
@sa getEventTimeLeft, getScheduleDuration, getTimeSinceStart, isEventPending, schedule, obj.schedule</desc>
</function>
<function>
<name>cancelServerQuery</name>
<desc>Use the cancelServerQuery function to cancel a previous query*() call.
@return No return value.
@sa queryLANServers, queryMasterServer, querySingleServer</desc>
</function>
<function>
<name>clearTextureHolds</name>
<desc>Use the clearTextureHolds function to free and release any held textures, returning the size of the held textures free.
As long as a texture is not currently in use, it will be released.
@return Returns the space freed.
@sa dumpTextureStats, flushTextureCache, purgeResources</desc>
</function>
<function>
<name>cls</name>
<desc>Use the cls function to clear the console output.
@return No return value</desc>
</function>
<function>
<name>collapseEscape</name>
<args> text </args>
<desc>Use the collapseEscape function to replace all escape sequences ('xx') with a collapsed version ('xx').
@param text A string, possibly containing escape sequences.
@return Returns a copy of text with all escape sequences converted to an encoding.
@sa expandEscape</desc>
</function>
<function>
<name>commandToClient</name>
<args> client, func [ , arg1, ... , argn ] </args>
<desc>Use the commandToClient function to issue a remote procedure call on a client.
All arguments (excluding client) may be in tagged or non-tagged format. See 'Remote Procedure Call Samples' below
@param client The numeric ID of a client gameConnection.
@param func The suffix of the remote procedure name to be executed on the client.
@param arg1 ... argn – Optional arguments to be passed to the remote procedure.
@return No return value.</desc>
</function>
<function>
<name>commandToServer</name>
<args> func [ , arg1, ... , argn ] </args>
<desc>Use the commandToServer function to issue a remote procedure call the server.
All arguments may be in tagged or non-tagged format. See 'Remote Procedure Call Samples' below
@param func The suffix of the remote procedure name to be executed on the client.
@param arg1 ... argn – Optional arguments to be passed to the remote procedure.
@return No return value.</desc>
</function>
<function>
<name>compile</name>
<args> fileName </args>
<desc>Use the compile function to pre-compile a script file without executing the contents.
@param fileName A path to the script to compile.
@return Returns 1 if the script compiled without errors and 0 if the file did not compile correctly or if the path is wrong. Also, ff the path is invalid, an error will print to the console.
@sa exec</desc>
</function>
<function>
<name>createCanvas</name>
<args> WindowTitle </args>
<desc>Use the createCanvas function to initialize the canvas.
@return Returns true on success, false on failure.
@sa createEffectCanvas</desc>
</function>
<function>
<name>createEffectCanvas</name>
<args> WindowTitle </args>
<desc>Use the createEffectCanvas function to initialize the effects canvas.
@return Returns true on success, false on failure.
@sa createCanvas</desc>
</function>
<function>
<name>dbgDisconnect</name>
<desc>Forcibly disconnects any attached script debugging client.
@return No Return Value</desc>
</function>
<function>
<name>dbgIsConnected</name>
<desc>@return Returns true if a script debugging client is connected else return false.</desc>
</function>
<function>
<name>dbgSetParameters</name>
<args>int port, string password, bool waitForClient</args>
<desc>Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect.@param port The IP port to set the password on.
@param password The password for this port. Set this to a NULL string to clear the password for the port.
@return No return value</desc>
</function>
<function>
<name>deactivateDirectInput</name>
<desc>Use the deactivateDirectInput function to de-activate polling of direct input devices (keyboard, mouse, joystick, et cetera).
@return No return value.
@sa activateDirectInput</desc>
</function>
<function>
<name>deactivateKeyboard</name>
<desc>Use the deactivateKeyboard function to disable directInput polling of the keyboard.
@return No return value.
@sa activateKeyboard</desc>
</function>
<function>
<name>deactivatePackage</name>
<args> packageName </args>
<desc>Use the deactivatePackage function to deactivate a package definition and to pop any definitions from this package off the package stack.
This also causes any subsequently stacked packages to be popped. i.e. If any packages were activated after the one specified in packageName, they too will be deactivated and popped.
@param packagename The name or ID of an existing package.
@return No return value.
@sa activatePackage, isPackage</desc>
</function>
<function>
<name>deleteDataBlocks</name>
<desc>Use the deleteDataBlocks function to cause a server to delete all datablocks that have thus far been loaded and defined.
This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup
@return No return value.</desc>
</function>
<function>
<name>deleteVariables</name>
<args> wildCard </args>
<desc>Use the deleteVariables function to delete any global variable matching the wildCard statement.
@param wildCard A string identifying what variable(s) to delete. All characters used to create a global are allowed and the special symbol "*", meaning 0 or more instances of any character.
@return No return value</desc>
</function>
<function>
<name>detag</name>
<args> tagID </args>
<desc>Use the detag function to convert a tag to a string. This can only be used in the proper context, i.e. to parse values passed to a client command or to a server command. See 'Remote Procedure Call Samples' below.
@param tagID A numeric tag ID corresponding to a previously tagged string.
@return Returns the string associated with the tag ID.
@sa commandToClient, commandToServer</desc>
</function>
<function>
<name>disableJoystick</name>
<desc>Use the disableJoystick function to disable joystick input.
@return No return value.
@sa enableJoystick, getJoystickAxes, isJoystickEnabled</desc>
</function>
<function>
<name>disableMouse</name>
<desc>Use the disableMouse function to disable mouse input.
@return No return value.
@sa enableMouse</desc>
</function>
<function>
<name>dispatchMessage</name>
<args>queueName, event, data</args>
<desc>Dispatches a message to given message queue
@param queueName The queue to dispatch to
@param event The message you are passing
@param data Data
@return Returns true on success and false otherwise</desc>
</function>
<function>
<name>dispatchMessageObject</name>
<args>queueName, message</args>
<desc>Dispatches a message object to the given queue
@param queueName The name of the queue to dispatch object to
@param message The message object</desc>
</function>
<function>
<name>DNetSetLogging</name>
<args>bool enabled</args>
</function>
<function>
<name>dumpConsoleClasses</name>
<args>bool dumpScript = true, bool dumpEngine = true</args>
<desc>dumps all declared console classes to the console.
This will dump all classes and methods that were registered from within the engine, AND from the console via scripts.
@param dumpScript Specifies whether or not classes defined in script should be dumped.
@param dumpEngine Specifies whether or not classes defined in the engine should be dumped.</desc>
</function>
<function>
<name>dumpConsoleFunctions</name>
<args>bool dumpScript = true, bool dumpEngine = true</args>
<desc>Dumps all declared console functions to the console.
This will dump all funtions that were registered from within the engine, AND from the console via scripts.
@param dumpScript Specifies whether or not functions defined in script should be dumped.
@param dumpEngine Specifies whether or not functions defined in the engine should be dumped.@sa dumpConsoleMethods</desc>
</function>
<function>
<name>dumpFontCacheStatus</name>
<desc>Dump a full description of all cached fonts, along with info on the codepoints each contains.
@return No return value</desc>
</function>
<function>
<name>duplicateCachedFont</name>
<args>oldFontName, oldFontSize, newFontName</args>
<desc>Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont.
@param oldFontName The original font.
@param oldFontSize The original font's size property.
@param newFontName The name to set the copy to.
@return No return value.</desc>
</function>
<function>
<name>echo</name>
<args> text [ , ... ] </args>
<desc>Use the echo function to print messages to the console.
@param text Any valid text string.
@param ... Any additional valid text string(s).
@return No return value.
@sa error, warn</desc>
</function>
<function>
<name>echoInputState</name>
<desc>Use the echoInputState function to dump the input state of the mouse, keyboard, and joystick to the console.
@return No return value.
@sa activateDirectInput, deactivateDirectInput, activateKeyboard, deactivateKeyboard, disableJoystick, enableJoystick, enableMouse, disableMouse</desc>
</function>
<function>
<name>enableJoystick</name>
<desc>Use the enableJoystick function to enable joystick input if it is present.
@return Will return true if the joystick is present and was successfully enabled, false otherwise.
@sa disableJoystick, getJoystickAxes, isJoystickDetected</desc>
</function>
<function>
<name>enableMouse</name>
<desc>Use the enableMouse function to enable mouse input.
@return Returns true if a mouse is present and it was enabled, false otherwise.
@sa disableMouse</desc>
</function>
<function>
<name>enableWinConsole</name>
<args> enable </args>
<desc>Use the enableWinConsole function to tell TGB to create an external console window, either as a separate DOS window or as a new window under OSX/Linux/*NIX.
Subsequent calls to this function do nothing. Only one external console is allowed
@param enable A boolean. If this value is set to true, a new console window will be created.
@return No return value.</desc>
</function>
<function>
<name>enumerateConsoleClasses</name>
<args>&lt;"base class"&gt;</args>
</function>
<function>
<name>error</name>
<args> text [ , ... ] </args>
<desc>Use the error function to print error messages to the console. These messages usually print in red.
@param text Any valid text string.
@param ... Any additional valid text string(s).
@return No return value.
@sa echo, warn</desc>
</function>
<function>
<name>eval</name>
<args> script </args>
<desc>Use the eval function to execute any valid script statement.
If you choose to eval a multi-line statement, be sure that there are no comments or comment blocks embedded in the script string.
@param script A string containing a valid script statement. This may be a single line statement or multiple lines concatenated together with new-line characters.
@return Returns the result of executing the script statement.
@sa call</desc>
</function>
<function>
<name>exec</name>
<args> fileName [ , nocalls [ , journalScript ] ] </args>
<desc>Use the exec function to compile and execute a normal script, or a special journal script.
If $Pref::ignoreDSOs is set to true, the system will use .cs before a .dso file if both are found.
@param fileName A string containing a path to the script to be compiled and executed.
@param nocalls A boolean value. If this value is set to true, then all function calls encountered while executing the script file will be skipped and not called. This allows us to re-define function definitions found in a script file, without re-executing other worker scripts in the same file.
@param journalScript A boolean value. If this value is set tot true, and if a journal is being played, the engine will attempt to read this script from the journal stream. If no journal is playing, this field is ignored.
@return Returns true if the file compiled and executed w/o errors, false otherwise.
@sa compile</desc>
</function>
<function>
<name>expandEscape</name>
<args> text </args>
<desc>Use the collapseEscape function to replace all escape sequences ('xx') with an expanded version ('xx').
@param text A string, possibly containing escape sequences.
@return Returns a copy of text with all escape sequences expanded.
@sa collapseEscape</desc>
</function>
<function>
<name>expandFilename</name>
<args>string filename</args>
</function>
<function>
<name>expandOldFilename</name>
<args>string filename</args>
</function>
<function>
<name>export</name>
<args> wildCard [ , fileName [ , append ] ] </args>
<desc>Use the export function to save all global variables matching the specified name pattern in wildCard to a file, either appending to that file or over-writing it.
@param wildCard A string identifying what variable(s) to export. All characters used to create a global are allowed and the special symbol "*", meaning 0 or more instances of any character.
@param fileName A string containing a path to a file in which to save the globals and their definitions.
@param append A boolean value. If this value is true, the file will be appended to if it exists, otherwise it will be created/over-written.
@return No return value</desc>
</function>
<function>
<name>exportCachedFont</name>
<args>fontName, size, fileName, padding, kerning</args>
<desc>- Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font areexported as one long strip.
@param fontName The name of the font to export.
@param size The size of the font
@param fileName The export file name.
@param padding Desired padding settings.
@param kerning Kerning settings (space between elements)
@return No return value.</desc>
</function>
<function>
<name>fileBase</name>
<args>fileName</args>
</function>
<function>
<name>fileDelete</name>
<args>fileName</args>
<desc>@param fileName Name of the file to remove@return Returns true on success and flase on failure</desc>
</function>
<function>
<name>fileExt</name>
<args>fileName</args>
<desc>@param Name of file from which to extract extension
@return A string containing the file's extension (assuming all data after first '.' is the extension) or returns empty string on failure</desc>
</function>
<function>
<name>fileName</name>
<args>filePathName</args>
<desc>Extract the filename from the full path description</desc>
</function>
<function>
<name>filePath</name>
<args>fileName</args>
<desc>Extract the file path from a file's full desciption</desc>
</function>
<function>
<name>fileSize</name>
<args>fileName</args>
<desc>@param fileName The name of the file to check.
@return Returns the size of the file as an integer or -1 if file not found</desc>
</function>
<function>
<name>findFirstFile</name>
<args> strPattern </args>
<desc>@param strPattern The string pattern to search for.
@return Returns a string representing the first file in the directory system matching the given pattern.</desc>
</function>
<function>
<name>findFirstFileMultiExpr</name>
<args>strPattern</args>
<desc>@param strPattern The string pattern to search for.
@return Returns the first file in the directory system matching the given pattern.</desc>
</function>
<function>
<name>findNextFile</name>
<args> strPattern </args>
<desc>@param strPattern The string pattern to search for.
@return Returns the next file matching a search begun in findFirstFile.</desc>
</function>
<function>
<name>findNextFileMultiExpr</name>
<args>string pattern</args>
<desc>Returns the next file matching a search begun in findFirstFile.</desc>
</function>
<function>
<name>firstWord</name>
<args> sourceString </args>
<desc>Use the firstWord function to retrieve the first word found in sourceString.
@param sourceString A string containing one or more words.
@return Returns the first word found in sourceString, or a NULL string, if no words are found.
@sa restWords</desc>
</function>
<function>
<name>flushTextureCache</name>
<desc>Use the flushTextureCache function to flush the texture cache.
@return No return value.
@sa clearTextureHolds, dumpTextureStats, purgeResources</desc>
</function>
<function>
<name>FreeMemoryDump</name>
<desc>Use the freeMemoryDump function to dump the current 'memory free' statistics to the console.
This does not print how much memory is free, but rather an analysis of 'free chunks' of memory
@return No return value.</desc>
</function>
<function>
<name>getBoxCenter</name>
<args> box </args>
<desc>Use the getBoxCenter function to find the centroid of a cube (box).
@param box A vector containing two three-element floating-point position vectors: "X1 Y1 Z1 X2 Y2 Z2".
@return Returns a vector containing a three-element floating-point position vector equal to the centroid of the area defined by box</desc>
</function>
<function>
<name>getBuildString</name>
<desc>Use the getBuildString function to determine if this build is a "Debug" release, or a "Release" build.
@return Returns a string, either "Debug" for a debug build, or "Release" for a release build.
@sa getCompileTimeString, getVersionNumber, getVersionString, isDebugBuild</desc>
</function>
<function>
<name>getClipboard</name>
<desc>Use the getClipboard function to get the contents of the GUI clipboard.
@return Returns a string equal to the current contents of the copy the clipboard, or a NULL strain if the copy clipboard is empty.
@sa setClipboard</desc>
</function>
<function>
<name>getCompileTimeString</name>
<desc>Use the getCompileTimeString function to determine when the currently running engine was built.
@return Returns a string containing "Month Day Year at Hour:Minute:Second" showing when this executable was built.
@sa getBuildString, getVersionNumber, getVersionString, isDebugBuild</desc>
</function>
<function>
<name>getCoreLangTable</name>
<desc>Get the ID of the core language table
@return The table's ID as an S32 value.</desc>
</function>
<function>
<name>getDesktopResolution</name>
<desc>Use the getDesktopResolution function to determine the current resolution of the desktop (not the application).
To get the current resolution of a windowed display of the torque game engine, simply examine the global variable '$pref::Video::resolution'.
@return Returns a string containing the current desktop resolution, including the width height and the current bits per pixel.
@sa getDisplayDeviceList, getResolutionList, nextResolution, prevResolution, setDisplayDevice, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>getDirectoryList</name>
<args>strPath, intDepth</args>
<desc>@param strPath The path in which to check
@param intDepth The depth in which to return (default 0 if not specified)
@return The directory contents</desc>
</function>
<function>
<name>getDisplayDeviceList</name>
<desc>Use the getDisplayDeviceList function to get a list of valid display devices.
@return Returns a tab separated list of valid display devices.
@sa getDesktopResolution, getResolutionList, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>getDSOPath</name>
<args>scriptFileName</args>
<desc>Returns the DSO path of the given filename
@param scriptFileName A string contains the file to search for
@return Returns either the requested pathname as a string, or an empty string if not found.</desc>
</function>
<function>
<name>getEventTimeLeft</name>
<args> eventID </args>
<desc>Use the getEventTimeLeft function to determine how much time remains until the event specified by eventID occurs.
@param eventID The numeric ID of a previously scheduled event.
@return Returns a non-zero integer value equal to the milliseconds until the event specified by eventID will occur. However, if eventID is invalid, or the event has passed, this function will return zero.
@sa cancel, getScheduleDuration, getTimeSinceStart, isEventPending, schedule, obj.schedule</desc>
</function>
<function>
<name>getField</name>
<args> sourceString , index </args>
<desc>Use the getField function to get the field at index in sourceString.
@param sourceString A string containing one or more fields.
@return Returns field at index in sourceString, or null string if no field exists at that index.
@sa getFields, setField</desc>
</function>
<function>
<name>getFieldCount</name>
<args> sourceString </args>
<desc>Use the getFieldCount function to get the number of fields in sourceString.
@param sourceString A string containing one or more fields.
@return Returns number of fields in sourceString or 0 if no fields are present</desc>
</function>
<function>
<name>getFields</name>
<args> sourceString , index [ , endindex ] </args>
<desc>Use the getFields function to retrieve a set of fields from a sourceString.
@param sourceString A string containing one or more fields.
@param index The index of the first field to retrieve.
@param endindex The index of the final field to retrieve.
@return Returns all fields (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining fields are returned.
@sa getField, setField</desc>
</function>
<function>
<name>getFileCount</name>
<args>strPattern</args>
<desc>@param strPattern The string pattern to search for.
@return Returns the number of files in the directory tree that match the given pattern</desc>
</function>
<function>
<name>getFileCountMultiExpr</name>
<args>strPattern</args>
<desc>@param strPattern The string pattern to search for.
@return Returns the number of files in the directory tree that match the given pattern</desc>
</function>
<function>
<name>getFileCRC</name>
<args>filename</args>
<desc>@param filename The string representing the file from which to get the CRC
@return An integer</desc>
</function>
<function>
<name>getJoystickAxes</name>
<args> instance </args>
<desc>Use the getJoystickAxes function to get the current axes position (x and y ) of any intance of a joystick.
@param instance A non-negative number value selecting a specific joystick instance attached to this computer.
@return Returns a string containing the "x y" position of the joystick.
@sa disableJoystick, enableJoystick, isJoystickDetected</desc>
</function>
<function>
<name>getModNameFromPath</name>
<args>string path</args>
<desc>Attempts to extract a mod directory from path. Returns empty string on failure.</desc>
</function>
<function>
<name>getModPaths</name>
<desc>Use the getModPaths function to get the current mod path information.
@return Returns a string equivalent to the complete current mod path, that is all pads that are visible to the file manager.
@sa setModPaths</desc>
</function>
<function>
<name>getRandom</name>
<args>[ min ],[ max ]</args>
<desc>Use the getRandom function to get a random floating-point or integer value. This function comes in three forms.
The first getRandom() takes no arguments and will return a random floating-point value in the range of 0.0 to 1.0. The second getRandom( max ) takes one argument representing the max integer value this will return. It will return an integer value between 0 and max. The third getRandom( min , max ) takes two arguments representing the min and max integer values this will return. It will return an integer value between min and max. Only the no-args version will return a floating point.
@param min Minimum inclusive integer value to return.
@param max Maximum inclusive integer value to return.
@return If no arguments are passed, will return a floating-point value between 0.0 and 1.0. If one argument is passed, will return an integer value between 0 and max inclusive. If two arguments are passed, will return an integer value between min and max inclusive.
@sa getRandomSeed</desc>
</function>
<function>
<name>getRandomSeed</name>
<desc>Use the getRandomSeed function to get the current seed for the random generator.
You can re-seed the generator with this value to allow you to recreate a random sequence. Merely save the seed and execute your random sequence. Later, to reproduce this sequence re-seed the generator with setRandomSeed and your saved value. Then, the generator will produce the same random sequence that followed the call to getRandomSeed.
@return Returns an integer value representing the current seed of the random generator.
@sa getRandom, setRandomSeed</desc>
</function>
<function>
<name>getRealTime</name>
<desc>Use the getRealTime function to the computer time in milliseconds.
@return Returns the current real time in milliseconds.
@sa getSimTime</desc>
</function>
<function>
<name>getRecord</name>
<args> sourceString , index </args>
<desc>Use the getRecord function to get the record at index in sourceString.
@param sourceString A string containing one or more records.
@return Returns record at index in sourceString, or NULL string if no record exists at that index.
@sa getRecords, setRecord</desc>
</function>
<function>
<name>getRecordCount</name>
<args> sourceString </args>
<desc>Use the getRecordCount function to get the number of records in sourceString.
@param sourceString A string containing one or more records.
@return Returns number of records in sourceString or 0 if no records are present</desc>
</function>
<function>
<name>getRecords</name>
<args> sourceString , index [ , endindex ] </args>
<desc>Use the getRecords function to retrieve a set of records from a sourceString.
@param sourceString A string containing one or more records.
@param index The index of the first record to retrieve.
@param endindex The index of the final record to retrieve.
@return Returns all records (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining records are returned.
@sa getRecord, setRecord</desc>
</function>
<function>
<name>getRes</name>
<desc>Get the width, height, and bitdepth of the screen.@return A string formatted as "&lt;width&gt; &lt;height&gt; &lt;bitdepth&gt;"</desc>
</function>
<function>
<name>getResolutionList</name>
<args> devicename </args>
<desc>Use the getResolutionList function to get a semicolon separated list of legal resolutions for a specified device.
Resolutions are always in the form: width height bpp, where width and height are in pixels and bpp is bits-per-pixel.
@param deviceName A string containing a supported display device.
@return Returns a tab separated list of valid display resolutions for devicename.
@sa getDesktopResolution, getDisplayDeviceList, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>getScheduleDuration</name>
<args> eventID </args>
<desc>Use the getScheduleDuration function to determine how long the event associated with eventID was scheduled for.
@param eventID The numeric ID of a previously scheduled event.
@return Returns a non-zero integer value equal to the milliseconds used in the schedule call that created this event. However, if eventID is invalid, this function will return zero.
@sa cancel, getEventTimeLeft, getTimeSinceStart, isEventPending, schedule, obj.schedule</desc>
</function>
<function>
<name>getServerCount</name>
<desc>Use the getServerCount function to determine the number of game servers found on the last queryLANServers() or queryMasterServer() call.
This value is important because it allows us to properly index when calling setServerInfo().
@return Returns a numeric value equal to the number of game servers found on the last queryLANServers() or queryMasterServer() call. Returns 0 if the function was not called, or none were found.
@sa queryLANServers, queryMasterServer, setServerInfo</desc>
</function>
<function>
<name>getSimTime</name>
<desc>Use the getSimTime function to get the time, in ticks, that has elapsed since the engine started executing.
@return Returns the time in ticks since the engine was started.
@sa getRealTime</desc>
</function>
<function>
<name>getSubStr</name>
<args> sourceString , start , count </args>
<desc>Use the getSubStr function to get a sub-string of sourceString, starting at character index start and ending at character index start + count, or the end-of-string, which ever comes first.
If start + count is greater than the length of sourceString, the extraction will return a string shorter than count.
@param sourceString The string from which to extract a sub-string.
@param start The character index at which the extraction starts.
@param count The length of the sub-string to extract.
@return Returns a string made up of the character at start in sourceString and ending at the end of the original sourceString, or start + count, whichever comes first.
@sa strchr</desc>
</function>
<function>
<name>getT2DDatablockSet</name>
<desc>Retrieves the datablock-set for T2D.@return Returns the datablockset ID as an integer</desc>
</function>
<function>
<name>getT2DMaxTextureSize</name>
<desc>Returns the maximum texture size supported by the current hardware.</desc>
</function>
<function>
<name>getT2DVersion</name>
<desc>Returns T2D Version</desc>
</function>
<function>
<name>getTag</name>
<args> taggedString </args>
<desc>Use the getTag function to retrieve the tag ID associated with a previously tagged string.
@param taggedString A previously tagged string.
@return Returns the tag ID of the string. If the string was not previously tagged, it gets tagged and the new tag ID is returned</desc>
</function>
<function>
<name>getTaggedString</name>
<args> tag </args>
<desc>Use the getTaggedString function to convert a tag to a string. This is not the same a detag() which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string.
@param tag A numeric tag ID.
@return Returns the string corresponding to the tag ID</desc>
</function>
<function>
<name>getTimeSinceStart</name>
<args> eventID </args>
<desc>Use the getTimeSinceStart function to determine how much time has passed since the event specified by eventID was scheduled.
@param eventID The numeric ID of a previously scheduled event.
@return Returns a non-zero integer value equal to the milliseconds that have passed since this event was scheduled. However, if eventID is invalid, or the event has passed, this function will return zero.
@sa cancel, getEventTimeLeft, getScheduleDuration, isEventPending, schedule, obj.schedule</desc>
</function>
<function>
<name>getVariable</name>
<args>string varName</args>
<desc>Grabs the relevant data for the variable represented by the given string
@param varName A String representing the variable to check
@return Returns a string containing component data for the requested variable or an empty string if not found.</desc>
</function>
<function>
<name>getVersionNumber</name>
<desc>Use the getVersionNumber function to get the version number of the currently executing engine.
@return Returns an integer representing the engine's version number.
@sa getBuildString, getCompileTimeString, getVersionString, isDebugBuild</desc>
</function>
<function>
<name>getVersionString</name>
<desc>Use the getVersionString function to get the version name and number for the currently executing engine.
@return Returns a string containing a name and an integer representing the engine's version type and version number.
@sa getBuildString, getCompileTimeString, getVersionNumber, isDebugBuild</desc>
</function>
<function>
<name>getVideoDriverInfo</name>
<desc>Use the getVideoDriverInfo function to dump information on the video driver to the console.
@return No return value</desc>
</function>
<function>
<name>getWord</name>
<args> sourceString ,index </args>
<desc>Use the getWord function to get the word at index in sourceString.
@param sourceString A string containing one or more words.
@return Returns word at index in sourceString, or null string if no word exists at that index.
@sa getWords, setWord</desc>
</function>
<function>
<name>getWordCount</name>
<args> sourceString </args>
<desc>Use the getWordCount function to get the number of words in sourceString.
@param sourceString A string containing one or more words.
@return Returns number of words in sourceString or 0 if no words are present</desc>
</function>
<function>
<name>getWords</name>
<args> sourceString ,index [,endindex]</args>
<desc>Use the getWords function to retrieve a set of words from a sourceString.
@param sourceString A string containing one or more words.
@param index The index of the first word to retrieve.
@param endindex The index of the final word to retrieve.
@return Returns all words (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining words are returned.
@sa getWord, setWord</desc>
</function>
<function>
<name>GLEnableMetrics</name>
<args> enable </args>
<desc>Use the GLEnableMetrics function to enable or disable logging of OpenGL texture and video metrics.
For this to work, the engine must have been compiled with either TORQUE_DEBUG or INTERNAL_RELEASE defined. Use the metrics function to get at this information. Also, once this feature is enabled, the following globals will be available for inspection/examination: &lt;OpenGL::triCount0 – Terrain triangles, OpenGL::triCount1– DIF triangles, OpenGL::triCount2 – DTS triangles, OpenGL::triCount3 – Uncategorized triangles, OpenGL::primCount0 - Terrain primitives, OpenGL::primCount1 – DIF primitives, OpenGL::primCount2 – DTS primitives, OpenGL::primCount3 – Uncategorized primitives&gt;
@param enable A boolean value. When this is set to true, texture and video (triangles and primitives) logging is enabled and dumped as part of calls to certain metrics.
@return No return value.
@sa GLEnableLogging, metrics</desc>
</function>
<function>
<name>GLEnableOutline</name>
<args>bool</args>
</function>
<function>
<name>gotoWebPage</name>
<args> address </args>
<desc>- Open a URL in the user's favorite web browser.</desc>
</function>
<function>
<name>importCachedFont</name>
<args>fontName, size, fileName, padding, kerning</args>
<desc>Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont.@param fontName The name of the font to import.
@param size The size of the font
@param fileName The imported file name.
@param padding Desired padding settings.
@param kerning Kerning settings (space between elements)
@return No return value.</desc>
</function>
<function>
<name>initDisplayDeviceInfo</name>
<desc>Prints display device info to console and sets them to console variables:
^Vendor-&gt;$PCI_VEN
^Device_ID-&gt;$PCI_DEV
@return No Return Value</desc>
</function>
<function>
<name>inputPopCursor</name>
<desc>Pops the current cursor shape from manager stack
@return No Return Value.</desc>
</function>
<function>
<name>inputPushCursor</name>
<args>cursorShapeName</args>
<desc>Set's the current cursor to one specified@param cursorShapeName Name corresponding to enumerated shape value: "Arrow", "Wait", "Plus", "ResizeVert", "ResizeHorz", "ResizeAll", "ibeam", "ResizeNESW", "ResizeNWSE"
@return No Return Value</desc>
</function>
<function>
<name>isCurrentScriptToolScript</name>
<desc>Returns true if the calling script is a tools script</desc>
</function>
<function>
<name>isDebugBuild</name>
<desc>Use the isDebugBuild function to determine if this is a debug build.
@return Returns true if this is a debug build, otherwise false.
@sa getBuildString, getCompileTimeString, getVersionNumber, getVersionString</desc>
</function>
<function>
<name>isDeviceFullScreenOnly</name>
<args> devicename </args>
<desc>Use the isDeviceFullScreenOnly function to determine if the device specified in devicename is for full screen display only, or whether it supports windowed mode too.
@param deviceName A string containing a supported display device.
@return Returns true if the device can only display full scree, false otherwise.
@sa getResolutionList</desc>
</function>
<function>
<name>isEventPending</name>
<args> eventID </args>
<desc>Use the isEventPending function to see if the event associated with eventID is still pending.
When an event passes, the eventID is removed from the event queue, becoming invalid, so there is no discnerable difference between a completed event and a bad event ID.
@param eventID The numeric ID of a previously scheduled event.
@return Returns true if this event is still outstanding and false if it has passed or eventID is invalid.
@sa cancel, getEventTimeLeft, getScheduleDuration, getTimeSinceStart, schedule, obj.schedule</desc>
</function>
<function>
<name>isFile</name>
<args>fileName</args>
<desc>@param fileName Filename to check.
@return Returns true if the given filename is an existing file or false otherwise</desc>
</function>
<function>
<name>isFullScreen</name>
<desc>Use the isFullScreen function to determine if the current application is displayed in full-screen mode.
@return Returns true if the engine is currently displaying full-screen, otherwise returns false</desc>
</function>
<function>
<name>isFunction</name>
<args>string funcName</args>
<desc>Checks whether given name represents a current valid function.
@param funcName The name of the function to check.
@return Returns either true if the string represents a valid function or false if not.</desc>
</function>
<function>
<name>isJoystickDetected</name>
<desc>Use the isJoystickDetected function to determine if one or more joysticks are connected to the system.
This doesn't tell us how many joysticks there are, just that there are joysticks. It is our job to find out how many and to attach them.
@return Returns true if one or more joysticks are attached and detected, false otherwise.
@sa disableJoystick, enableJoystick, getJoystickAxes</desc>
</function>
<function>
<name>isKoreanBuild</name>
<desc>Checks if current build is Korean@return Returns true if Korean build, false otherwise</desc>
</function>
<function>
<name>isMethod</name>
<args>string namespace, string method</args>
<desc>Checks whether the given method name represents a valid method within the given namespace.
@param namespace A string representing the namespace in which the method should reside.
@param method The name of the method in question.
@return Returns a boolean value which is true if the given mathod name represents a valid method in the namespace and false otherwise.</desc>
</function>
<function>
<name>isObject</name>
<args> handle </args>
<desc>Use the isObject function to check if the name or ID specified in handle is a valid object.
@param handle A name or ID of a possible object.
@return Returns true if handle refers to a valid object, false otherwise</desc>
</function>
<function>
<name>isPackage</name>
<args> packageName </args>
<desc>Use the isPackage function to check if the name or ID specified in packageName is a valid package.
@param packagename The name or ID of an existing package.
@return Returns true if packageName is a valid package, false otherwise.
@sa activatePackage, deactivatePackage</desc>
</function>
<function>
<name>isQueueRegistered</name>
<args>queueName</args>
<desc>Checks whether message queue is registered
@param queueName The name of the queue to check
@return Returns true if registered and false if not</desc>
</function>
<function>
<name>isToolBuild</name>
<desc>Returns true if running application is an editor/tools build or false if a game build</desc>
</function>
<function>
<name>isUsingVFS</name>
<desc>@return Returns true if using Virtual File System</desc>
</function>
<function>
<name>isWriteableFileName</name>
<args>fileName</args>
<desc>@param fileName Filename to check.
@return Returns true if the given filename is an existing file and is not Read-Only or false otherwise</desc>
</function>
<function>
<name>loadChunkFile</name>
<args>Filename file</args>
<desc>Read a chunk hierarchy from a file.</desc>
</function>
<function>
<name>loadObject</name>
<args>filename</args>
<desc>Loads an object from the specified filename
@param filename The name of the file to load the object from
@return Returns the ID of the object on success, or 0 on failure.</desc>
</function>
<function>
<name>lockMouse</name>
<args> isLocked </args>
<desc>Use the lockMouse function to un/lock the mouse.
@param isLocked A boolean value.
@return No return value</desc>
</function>
<function>
<name>ltrim</name>
<args> sourceString </args>
<desc>Use the ltrim function to strip the leading white space from sourceString.
White space is any character in this set: spaces, TABs, and NULL strings.
@param sourceString The string to be trimmed.
@return Returns sourceString with all the leading white spaces removed.
@sa stripChars, stripMLControlChars, stripTrailingSpaces, rtrim, trim</desc>
</function>
<function>
<name>mAbs</name>
<args> val </args>
<desc>Use the mAbs function to get the magnitude of val.
@param val An integer or a floating-point value.
@return Returns the magnitude of val</desc>
</function>
<function>
<name>mAcos</name>
<args> val </args>
<desc>Use the mAcos function to get the inverse cosine of val in radians.
@param val A value between -1.0 and 1.0 equal to the cosine of some angle theta.
@return Returns the inverse cosine of val in radians. This value will be in the range [ 0 , 3.14159 ].
@sa mCos</desc>
</function>
<function>
<name>mAsin</name>
<args> val </args>
<desc>Use the mAsin function to get the inverse sine of val in radians.
@param val A value between -1.0 and 1.0 equal to the sine of some angle theta.
@return Returns the inverse sine of val in radians. This value will be in the range [ - 3.14159/2 , 3.14159/2 ].
@sa mSin</desc>
</function>
<function>
<name>mAtan</name>
<args> val </args>
<desc>Use the mAtan function to get the inverse tangent of rise/run in radians.
@param rise Vertical component of a line.
@param run Horizontal component of a line.
@return Returns the slope in radians (the arc-tangent) of a line with the given rise and run.
@sa mTan</desc>
</function>
<function>
<name>mathInit</name>
<args> extension </args>
<desc>Use the MathInit function to install a specified math extensions, or to detect and enable all extensions.
Generally speaking, the best extension choice is to used detect. This will automatically detected and enable all extensions supported by the current processor. It will also print out a list of the extension that were enabled to the console
@param extension Can be any of these:
detect – Detect all supported extensions and enable.
C - Enable standard C extensions.
FPU - Enable floating-point-unit extensions.
MMX - Enable Intel MMX extensions.
3DNOW - Enable AMD 3DNOW extensions.
SSE - Enable Intel SSE extensions.
@return No return value.</desc>
</function>
<function>
<name>MatrixCreate</name>
<args> posVec , rotVec </args>
<desc>Use the matrixCreate function to create a transform matrix from a three-element floating-point translation vector and a four-element floating-point rotation vector.
@param posVec A three-element floating-point translation vector: "PosX PosY PosZ".
@param rotVec A four-element floating-point rotation vector: "RotX RotY RotZ".
@param These re rotations about the specified axes.
@return Returns a transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta".
@sa MatrixCreateFromEuler</desc>
</function>
<function>
<name>MatrixCreateFromEuler</name>
<args> rotVec </args>
<desc>Use the MatrixCreateFromEuler function to calculate a transform matrix from a three-element floating-point rotation vector.
@param rotVec A three-element floating-point rotation vector: "RotX RotY RotZ". These are rotations about the specified axes.
@return Returns a transform matrix of the form "0 0 0 X Y Z theta".
@sa MatrixCreate</desc>
</function>
<function>
<name>MatrixMulPoint</name>
<args> transform , point </args>
<desc>Use the MatrixMulPoint function to multiply a seven element transform matrix by a three element point vector, producing a three element position vector.
@param transform A seven-element transform matrix.
@param point A three-element point/position vector.
@return Returns a three-element position vector.
@sa MatrixMultiply, MatrixMulVector</desc>
</function>
<function>
<name>MatrixMultiply</name>
<args> transformA , transformB </args>
<desc>Use the MatrixMultiply function to multiply two seven-element transform matrices to produce a new seven element matrix.
@param transformA A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta".
@param transformB A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta".
@return Returns a seven-element matrix resulting from transiformA x transformB.
@sa MatrixMulPoint, MatrixMulVector</desc>
</function>
<function>
<name>MatrixMulVector</name>
<args> transform , vector </args>
<desc>Use the MatrixMulVector function to multiply a seven-element transform matrix with a three-element matrix.
@param transform A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta".
@param vector A three-element vector.
@return Returns three-element resulting from vector * transform.
@sa MatrixMulPoint, MatrixMultiply</desc>
</function>
<function>
<name>mCeil</name>
<args> val </args>
<desc>Use the mCeil function to calculate the next highest integer value from val.
@param val A floating-point value.
@return Returns an integer representing the next highest integer from val.
@sa mFloor</desc>
</function>
<function>
<name>mClamp</name>
<args>float number, float min, float max</args>
<desc>Clamp a value between two other values.
@param number A float value representing the number to clamp
@param min The lower bound
@param max The upper bound
@return A float value the is within the given range</desc>
</function>
<function>
<name>mCos</name>
<args> val </args>
<desc>Use the mCos function to get the cosine of the radian angle val.
@param val A value between -3.14159 and 3.14159.
@return Returns the cosine of val. This value will be in the range [ -1.0 , 1.0 ].
@sa mAcos</desc>
</function>
<function>
<name>mDegToRad</name>
<args> val </args>
<desc>Use the mDegToRad function to convert degrees to radians.
@param val A floating-point number representing some number of degrees.
@return Returns the equivalent of the degree value val in radians.
@sa mRadToDeg</desc>
</function>
<function>
<name>messageBox</name>
<args>title, message[, buttons[, icon]]</args>
<desc>Pops up a message box
@param title The message box's title to display
@param message The message to display in the box
@param buttons The buttons to include on box (default MBOkCancel)
@param icon The displayed icon (default MIInformation)
@return Returns the ID of the box</desc>
</function>
<function>
<name>mFloatLength</name>
<args> val , numDecimals </args>
<desc>Use the mFloatLength function to limit the number of decimal places in val to numDecimals.
@param val A floating-point value.
@param numDecimals An integer between 0 and inf representing the number of decimal places to allow val to have.
@return Returns a floating-point value equivalent to a truncated version of val, where the new version has numDecimals decimal places</desc>
</function>
<function>
<name>mFloor</name>
<args> val </args>
<desc>Use the mFloor function to calculate the next lowest integer value from val.
@param val A floating-point value.
@return Returns an integer representing the next lowest integer from val.
@sa mCeil</desc>
</function>
<function>
<name>minimizeWindow</name>
<desc>- Minimize the game window</desc>
</function>
<function>
<name>mLog</name>
<args> val </args>
<desc>Use the mLog function to calculate the natural logarithm of val.
@param val A numeric value.
@return Returns the natural logarithm of val</desc>
</function>
<function>
<name>mPow</name>
<args> val , power </args>
<desc>Use the mPow function to calculated val raised to the power of power.
@param val A numeric (integer or floating-point) value to be raised to a power.
@param power A numeric (integer or floating-point) power to raise val to.
@return Returns val^power</desc>
</function>
<function>
<name>mRadToDeg</name>
<args> val </args>
<desc>Use the mRadToDeg function to convert radians to degrees.
@param val A floating-point number representing some number of radians.
@return Returns the equivalent of the radian value val in degrees.
@sa mDegToRad</desc>
</function>
<function>
<name>mRound</name>
<args>float v</args>
<desc>Rounds a number. 0.5 is rounded up.
@param val A floating-point value
@return Returns the integer value closest to the given float</desc>
</function>
<function>
<name>msg</name>
<args>NetConnection id, string message</args>
<desc>Send a SimpleNetObject message to the specified connection.</desc>
</function>
<function>
<name>mSin</name>
<args> val </args>
<desc>Use the mSin function to get the sine of the radian angle val.
@param val A value between -3.14159 and 3.14159.
@return Returns the sine of val. This value will be in the range [ -1.0 , 1.0 ].
@sa mAsin</desc>
</function>
<function>
<name>mSolveCubic</name>
<args>float a, float b, float c, float d</args>
<desc>Solve a cubic equation of form a*x^3 + b*x^2 + c*x + d = 0.

@returns A 4-tuple, contanining: sol x0 x1 x2. sol is the number of solutions (being 0, 1, 2, or 3), and x0, x1, x2 are the solutions, if any. Unused x's are undefined.</desc>
</function>
<function>
<name>mSolveQuadratic</name>
<args>float a, float b, float c</args>
<desc>Solve a quadratic equation of form a*x^2 + b*x + c = 0.

@returns A triple, contanining: sol x0 x1. sol is the number of solutions (being 0, 1, or 2), and x0 and x1 are the solutions, if any. Unused x's are undefined.</desc>
</function>
<function>
<name>mSolveQuartic</name>
<args>float a, float b, float c, float d, float e</args>
<desc>Solve a quartic equation of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0.

@returns A 5-tuple, contanining: sol x0 x1 x2 x3. sol is the number of solutions (ranging from 0-4), and x0, x1, x2 and x3 are the solutions, if any. Unused x's are undefined.</desc>
</function>
<function>
<name>mSqrt</name>
<args> val </args>
<desc>Use the mSqrt function to calculated the square root of val.
@param val A numeric value.
@return Returns the the squareroot of val</desc>
</function>
<function>
<name>mTan</name>
<args> val </args>
<desc>Use the mTan function to get the tangent of the radian angle val.
@param val A value between -3.14159/2 and 3.14159/2.
@return Returns the tangent of val. This value will be in the range [ -inf.0 , inf.0 ].
@sa mAtan</desc>
</function>
<function>
<name>nameToID</name>
<args> objectName </args>
<desc>Use the nameToID function to convert an object name into an object ID.
This function is a helper for those odd cases where a string will not covert properly, but generally this can be replaced with a statement like: ("someName")
@param objectName A string containing the name of an object.
@return Returns a positive non-zero value if the name corresponds to an object, or a -1 if it does not.</desc>
</function>
<function>
<name>nextResolution</name>
<desc>Use the nextResolution function to switch to the next valid (higher) resolution for the current display device.
@return Returns true if switch was successful, false otherwise.
@sa getDesktopResolution, prevResolution, getResolutionList, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>NextToken</name>
<args> tokenList , tokenVar , delimeter </args>
<desc>Use the nextToken function to get the first token found in tokenList, where tokens are separated by the character(s) specified in delimeter. The token itself is stored in a variable whose name is specified in tokenVar. This function provides complex power in a simple package. Please read the notes below, they are very important.
This function is scope-smart. That is, when we specify the name of the variable to store a token in by passing a value in tokenVar, we do not include either a local symbol (%), or a global symbol ($). We just pass in an un-adorned name, let's say "George". Then, depending on where this function is called, "George" will become a local (%George), or a global ($George) variable. If this function is called within a function or method definition, "George" will be local (%George). If this function is called from the file-scope (executed as part of a file and not within the scope of a function or method), "George" will become a global ($George). There is one additional special case. If you attempt to use this from the console command line, the token will vaporize and no variable will be created
@param tokenList The string containing token(s).
@param tokenVar The 'name' of the variable to store the token in.
@param delimeter The character(s) to use as a delimeter. A delimeter may be a single character, or a sequence of characters.
@return Returns a copy of tokenList, less the first token and the first delimiter. If there are no more tokens, a NULL string is returned.</desc>
</function>
<function>
<name>OpenALInitDriver</name>
<desc>Use the OpenALInitDriver function to initialize the OpenAL driver.
This must be done before all other OpenAL operations.
@return Returns true on successful initialization, false otherwise.
@sa OpenALShutdownDriver</desc>
</function>
<function>
<name>OpenALRegisterExtensions</name>
<desc>@note Currently does nothing (possibly deprecated)</desc>
</function>
<function>
<name>OpenALShutdownDriver</name>
<desc>Use the OpenALShutdownDriver function to stop/shut down the OpenAL driver.
After this is called, you must restart the driver with OpenALInitDriver to execute any new sound operations.
@return No return value.
@sa OpenALInitDriver</desc>
</function>
<function>
<name>playJournal</name>
<args> namedFile , doBreak </args>
<desc>Use the playJournal function to play back a journal from namedFile and to optionally break (into an active debugger) after loading the Journal. This allow us to debug engine bugs by reproducing them consistently repeatedly.
The journaling system is a vital tool for debugging complex or hard to reproduce engine and script bugs.
@param namedFile A full path to a valid journal file. Usually, journal names end with the extension .jrn.
@param doBreak A boolean value. If true, the engine will load the journal and then assert a break (to break into an active debugger). If not true, the engine will play back the journal with no break.
@return No return value.
@sa saveJournal</desc>
</function>
<function>
<name>png2jpg</name>
<args> pngFilename [ , quality ] </args>
<desc>Use the png2jpg function to save a PNG file specified by pngFilename as a similarly named JPEG file with the optionally specified quality.
@param pngFilename The path and file name of the PNG file to convert.
@param quality An optional quality between 0 and 100. The default quality is 90.
@return Returns -1 if the file could not be opened, 0 on other failures, and 1 if the conversion worked</desc>
</function>
<function>
<name>populateAllFontCacheRange</name>
<args>rangeStart, rangeEnd</args>
<desc>Populate the font cache for all fonts with Unicode code points in the specified range. Note we only support BMP-0, so code points range from 0 to 65535.
@param rangeStart, rangeEnd The range of the unicode points to populate caches with
@return No return value</desc>
</function>
<function>
<name>populateAllFontCacheString</name>
<args>string inString</args>
<desc>Populate the font cache for all fonts with characters from the specified string.
@param inString The string to use to set the font caches
@return No return value.</desc>
</function>
<function>
<name>populateFontCacheRange</name>
<args>faceName, size, rangeStart, rangeEnd</args>
<desc>- Populate the font cache for the specified font with Unicode code points in the specified range. Note we only support BMP-0, so code points range from 0 to 65535.@param faceName The name of the font
@param size The size of the font.
@param rangeStart The initial Unicode point
@param rangeEnd The final Unicode point in range
@return No return value</desc>
</function>
<function>
<name>populateFontCacheString</name>
<args>faceName, size, string</args>
<desc>Populate the font cache for the specified font with characters from the specified string.@param faceName The font's name
@param size The size of the font.
@param string The string to use to fill font cache
@return No return value.</desc>
</function>
<function>
<name>prevResolution</name>
<desc>Use the prevResolution function to switch to the previous valid (lower) resolution for the current display device.
@return Returns true if switch was successful, false otherwise.
@sa getDesktopResolution, nextResolution, getResolutionList, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>profilerDump</name>
<desc>Use the profilerDump function to dump engine profile statistics to the console.
@return No return value</desc>
</function>
<function>
<name>profilerDumpToFile</name>
<args>string filename</args>
<desc>Dump profiling stats to a file.</desc>
</function>
<function>
<name>profilerEnable</name>
<args> enable </args>
<desc>Use the profileEnable function to enable (or disable) engine profiling.
@param enable A boolean value. If set to true and the engine was compiled with DEBUG specified, engine profiling is enabled, otherwise it is disabled.
@return No return value.</desc>
</function>
<function>
<name>profilerMarkerEnable</name>
<args>string markerName, bool enable</args>
<desc>Enables (or disables) a marker for the profiler
@param markerName The name of the marker to (un)set
@param enable Boolean value. Set if true, unset if false
@return No Return Value</desc>
</function>
<function>
<name>profilerReset</name>
<desc>Resets the profiler, clearing all of its data.</desc>
</function>
<function>
<name>purgeResources</name>
<desc>Use the purgeResources function to purge all game resources.
@return No return value.
@sa clearTextureHolds, dumpResourceStats, dumpTextureStats, flushTextureCache</desc>
</function>
<function>
<name>queryLanServers</name>
<args> port , flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags </args>
<desc>Use the queryLANServers function to establish whether any game servers of the required specification(s) are available on the local area network (LAN).
@param port Look for any game servers advertising at this port. Set to 0 if you don't care what port the game server is using.
@param flags Look for any game servers with these special flags set. Set to 0 for no flags.
@param gametype Look for any game servers playing a game type that matches this string. Set to the NULL string to look for any game type.
@param missiontype Look for any game servers playing a mission type that matches this string. Set to the NULL string to look for any mission type.
@param minplayers Look for any game servers with this number of players or more. Set to 0 for no lower limit.
@param maxplayers Look for any game servers with this number of players or fewer. Set to 0 for no upper limit.
@param maxbots Look for any game servers with this number of AI controlled players or fewer. Set to 0 for no limit.
@param regionmask Look for any master servers, on our master server list, in this region. Set to 0 to examine all regions.
@param maxping Look for any game servers with a PING rate equal to or lower than this. Set to 0 for no upper PING limit.
@param mincpu Look for any game servers with a CPU (clock speed) equal or greater than this. Set to 0 for no CPU (clock speed) limit.
@param filterflags Look for any game servers with this game version number or higher. Set to 0 to find all versions.
@return No return value.
@sa getServerCount, queryMasterServer, setServerInfo, stopServerQuery</desc>
</function>
<function>
<name>queryMasterServer</name>
<args> flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags </args>
<desc>Use the queryMasterServer function to query all master servers in the master server list and to establish if they are aware of any game servers that meet the specified requirements, as established by the arguments passed to this function.
In order for this function to do anything, a list of master servers must have been previously specified. This list may contain one or more server addresses. A call to this function will search all servers in the list. To specify a list, simply create a set of array entries like this:
$pref::Master[0] = "2:192.168.123.15:28002";
$pref::Master[1] = "2:192.168.123.2:28002";
The format of these values is ==&gt; Region Number : IP Address : Port Number
These values should be specified in either the client's or the server's preferences file (prefs.cs). You may specifiy it elsewhere, however be sure that it is specified prior to this function being called and before any other functions that rely on it.
@param flags Look for any game servers with these special flags set. Set to 0 for no flags.
@param gametype Look for any game servers playing a game type that matches this string. Set to the NULL string to look for any game type.
@param missiontype Look for any game servers playing a mission type that matches this string. Set to the NULL string to look for any mission type.
@param minplayers Look for any game servers with this number of players or more. Set to 0 for no lower limit.
@param maxplayers Look for any game servers with this number of players or fewer. Set to 0 for no upper limit.
@param maxbots Look for any game servers with this number of AI controlled players or fewer. Set to 0 for no limit.
@param regionmask Look for any master servers, on our master server list, in this region. Set to 0 to examine all regions.
@param maxping Look for any game servers with a PING rate equal to or lower than this. Set to 0 for no upper PING limit.
@param mincpu Look for any game servers with a CPU (clock speed) equal or greater than this. Set to 0 for no CPU (clock speed) limit.
@param filterflags Look for any game servers with this game version number or higher. Set to 0 to find all versions.
@return No return value.
@sa getServerCount, queryLANServers, setServerInfo, startHeartbeat, stopServerQuery</desc>
</function>
<function>
<name>querySingleServer</name>
<args> address [ , flags ] </args>
<desc>Use the querySingleServer function to re-query a previously queried lan server, OR a game server found with queryLANServers or with queryMasterServer and selected with setServerInfo. This will refresh the information stored by TGE about this server. It will not however modify the values of the $ServerInfo::* global variables.
@param address The IP address and Port to re-query, i.e. "192.168.123.2:28000".
@param flags No longer used.
@return No return value.
@sa getServerCount, queryLANServers, queryMasterServer, setServerInfo, stopServerQuery</desc>
</function>
<function>
<name>quit</name>
<desc>Use the quit function to stop the engine and quit to the command line.
@return No return value</desc>
</function>
<function>
<name>quitWithErrorMessage</name>
<args>msg string</args>
<desc>quitWithErrorMessage(msg) - Quit, showing the provided error message. This is equivalent to an AssertISV.
@param Error Message
@return No return value</desc>
</function>
<function>
<name>recompileAllImageMaps</name>
<desc>Recompiles all image map datablocks
@return No return value.</desc>
</function>
<function>
<name>redbookClose</name>
<desc>Close the current Redbook device.
@return Returns true on success, false otherwise.</desc>
</function>
<function>
<name>redbookGetDeviceCount</name>
<desc>Get the number of redbook devices.@return Returns the number of currently mounted redbook devices as an integer</desc>
</function>
<function>
<name>redbookGetDeviceName</name>
<args>int index</args>
<desc>Get name of specified Redbook device.
@param index The index of the desired device
@return Returns the device's name as a string</desc>
</function>
<function>
<name>redbookGetLastError</name>
<desc>Get a string explaining the last redbook error.
@return The error message as a string</desc>
</function>
<function>
<name>redbookGetTrackCount</name>
<desc>Return the number of tracks.@return Returns the number of tracks as a nonnegative integer</desc>
</function>
<function>
<name>redbookGetVolume</name>
<desc>Get the volume.
@return Returns the volume as a floatingpoint value</desc>
</function>
<function>
<name>redbookOpen</name>
<args>string device=NULL</args>
<desc>Opens a redbook device@param device The device name (defaults to device 0)
@return Returns true on success, false otherwise</desc>
</function>
<function>
<name>redbookPlay</name>
<args>int track</args>
<desc>Play the selected track.
@param track The track index
@return Returns true on success, false otherwise (probably track not found)</desc>
</function>
<function>
<name>redbookSetVolume</name>
<args>float volume</args>
<desc>Set playback volume.@param The desired volume
@return Returns true on success, false otherwise (invalid value or device failure)</desc>
</function>
<function>
<name>redbookStop</name>
<desc>Stop playing the current track.@return Returns true on success, false otherwise</desc>
</function>
<function>
<name>registerMessageListener</name>
<args>queueName, listener</args>
<desc>Registers a message listener on a message queue
@param queueName The name of the message queue
@param listener The name of the listener to register
@return Returns true on success, and false otherwise (probably not found)</desc>
</function>
<function>
<name>registerMessageQueue</name>
<args>queueName</args>
<desc>Registers given message queue
@param queueName The name of the message queue
@return No Return Value</desc>
</function>
<function>
<name>removeBitFromMask</name>
<args> mask, bit </args>
<desc>- Returns the mask with a bit removed from it</desc>
</function>
<function>
<name>removeField</name>
<args> sourceString , index </args>
<desc>Use the removeField function to remove a single indexed field from a sourceString.
@param sourceString A string containing one or more fields.
@param index The index of the field to remove.
@return Returns sourceString minus the removed field. If the index is greater than the number of fields in sourceString, the original string is returned.
@sa setField</desc>
</function>
<function>
<name>removeRecord</name>
<args> sourceString , index </args>
<desc>Use the removeRecord function to remove a single indexed record from a sourceString.
@param sourceString A string containing one or more records.
@param index The index of the record to remove.
@return Returns sourceString minus the removed record. If the index is greater than the number of records in sourceString, the original string is returned.
@sa setRecord</desc>
</function>
<function>
<name>removeResPath</name>
<args>pathExpression</args>
<desc>Remove a path from the resource manager. Path is an expression as in findFirstFile()</desc>
</function>
<function>
<name>removeTaggedString</name>
<args> tag </args>
<desc>Use the removeTaggedSTring function to remove a previously tagged string from the NetStringTable.
@param tag A number tag ID.
@return No return value</desc>
</function>
<function>
<name>removeWord</name>
<args> sourceString ,index</args>
<desc>Use the removeWord function to remove a single indexed word from a sourceString.
@param sourceString A string containing one or more words.
@param index The index of the word to remove.
@return Returns sourceString minus the removed word. If the index is greater than the number of words in sourceString, the original string is returned.
@sa setWord</desc>
</function>
<function>
<name>restoreWindow</name>
<desc>- Restore the game window</desc>
</function>
<function>
<name>restWords</name>
<args> sourceString </args>
<desc>Use the restWords function to retrieve all words after the first word in sourceString.
@param sourceString A string containing one or more words.
@return Returns a string containing all the words after the first word found in sourceString, or a NULL string if no words remain after the first word (or if no words at all remain).
@sa firstWord</desc>
</function>
<function>
<name>rtrim</name>
<args> sourceString </args>
<desc>Use the rtrim function to strip the trailing white space from sourceString.
White space is any character in this set: spaces, TABs, and NULL strings.
@param sourceString The string to be trimmed.
@return Returns sourceString with all the trailing white spaces removed.
@sa stripChars, stripMLControlChars, stripTrailingSpaces, ltrim, trim</desc>
</function>
<function>
<name>saveChunkFile</name>
<args>SimChunk chunk, Filename file</args>
<desc>Write a chunk hierarchy to a file.</desc>
</function>
<function>
<name>saveJournal</name>
<args> namedFile </args>
<desc>Use the saveJournal function to save a new journal of the current game.
@param namedFile A full path specifying the file to save this journal to. Usually, journal names end with the extension .jrn.
@return No return value.
@sa playJournal</desc>
</function>
<function>
<name>saveObject</name>
<args>object, filename</args>
<desc>Saves the given object to the given filename
@param object The SimObject to save
@param filename The name of the file in which to save the object
@return Returns true on success and flase on failure</desc>
</function>
<function>
<name>schedule</name>
<args> t , objID || 0 , functionName, arg0, ... , argN </args>
<desc>Use the schedule function to schedule functionName to be executed with optional arguments at time t (specified in milliseconds) in the future. This function may be associated with an object ID or not. If it is associated with an object ID and the object is deleted prior to this event occurring, the event is automatically canceled.
@param t The time to wait (in milliseconds) before executing functionName.
@param objID An optional ID to associate this event with.
@param functionName An unadorned (flat) function name.
@param arg0, .. , argN – Any number of optional arguments to be passed to functionName.
@return Returns a non-zero integer representing the event ID for the scheduled event.
@sa cancel, getEventTimeLeft, getScheduleDuration, getTimeSinceStart, isEventPending, obj.schedule</desc>
</function>
<function>
<name>screenShot</name>
<args>string file, string format</args>
<desc>Take a screenshot.

@param format One of JPEG or PNG.</desc>
</function>
<function>
<name>setCanvasTitle</name>
<args>string windowTitle</args>
<desc>Sets the title to the provided string
@param windowTitle The desired title
@return No Return Value</desc>
</function>
<function>
<name>setClipboard</name>
<args> string </args>
<desc>Use the setClipboard function to Set value on clipboard to string.
@param string The new value to place in the GUI clipboard.
@return Returns true if successful, false otherwise.
@sa getClipoard</desc>
</function>
<function>
<name>setCompanyAndProduct</name>
<args>company, product</args>
<desc>Sets the company and product information.</desc>
</function>
<function>
<name>setCoreLangTable</name>
<args>LangTable</args>
<desc>Sets the core language table to the one specified
@param LangTable The desired language table object to set.
@return No return value.</desc>
</function>
<function>
<name>setDefaultSceneObjectDatablock</name>
<args>obj</args>
<desc>Set the default configuration@return No return value.</desc>
</function>
<function>
<name>setDisplayDevice</name>
<args> deviceName [, width [ , height [, bpp [, fullScreen ]]]] </args>
<desc>Use the setDisplayDevice function to select a display device and to set the initial width, height and bits-per-pixel (bpp) setting, as well as whether the application is windowed or in fullScreen.
If no resolution information is specified, the first legal resolution on this device's resolution list will be used. Furthermore, for each optional argument if the subsequent arguments are not specified, the first matching case will be used. Lastly, if the application is not told to display in full screen, but the device only supports windowed, the application will be forced into windowed mode.
@param deviceName A supported display device name.
@param width Resolution width in pixels.
@param height Resolution height in pixels.
@param bpp Pixel resolution in bits-per-pixel (16 or 32).
@param fullScreen A boolean value. If set to true, the application displays in full- screen mode, otherwise it will attempt to display in windowed mode.
@return Returns true on success, false otherwise.
@sa getDesktopResolution, getDisplayDeviceList, getResolutionList, nextResolution, prevResolution, setRes, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>setEchoFileLoads</name>
<args> enable </args>
<desc>Use the setEchoFileLoads function to enable/disable echoing of file loads (to console).
This does not completely disable message, but rather adds additional methods when echoing is set to true. File loads will always echo a compile statement if compiling is required, and an exec statement at all times
@param enable A boolean value. If this value is true, extra information will be dumped to the console when files are loaded.
@return No return value.</desc>
</function>
<function>
<name>setField</name>
<args> sourceString , index , replace </args>
<desc>Use the setField function to replace an existing field with a new field(s), or to add field(s) to a string..
@param sourceString A string containing one or more fields.
@param index The index of the field to remove.
@param replace The new field(s) to replace the field at index with.
@return There are multiple return cases:
- In the first case, a simple one-to-one replacement, the field at index in sourceString will be replaced with the value in replace, and the new string will be returned.
- In the first case, a multi-to-one replacement, the field at index in sourceString will be replaced with the value in replace, which can be two or more fields, and the new string will be returned.
- In the thrid and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of fields in sourceString, the requisite number of empty (null-string) fields will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned.
@sa getField, getFields, removeField</desc>
</function>
<function>
<name>setLogMode</name>
<args> mode </args>
<desc>Use the setLogMode function to set the logging level based on bits that are set in the mode argument.
This is a general debug method and should be used in all but release cases and perhaps even then.
@param mode A bitmask enabling various types of logging. See 'Logging Modes' table below.
@return No return value.
@sa intputLog</desc>
</function>
<function>
<name>setModPaths</name>
<args> path </args>
<desc>Use the setModPaths function to set the current mod path to the value specified in path.
@param path A string containing a semi-colon (;) separated list of game and mod paths.
@return No return value.
@sa getModPaths</desc>
</function>
<function>
<name>setNetPort</name>
<args>int port</args>
<desc>Set the network port for the game to use.
@param The requested port as an integer
@return Returns true on success, flase on fail</desc>
</function>
<function>
<name>setOpenGLAnisotropy</name>
<args> 0.0 .. max.f </args>
<desc>Use the setOpenGLAnisotropy function to enable or disable anisotropic filtering.
Anisotropic filtering is somewhat 'expensive' filtering technique that uses more texels than your average filtering technique (bilinear or trilinear) for determining the color of a pixel for cases where more than one texel may be responsible for that pixels color
@param 0.0 . max.f - A value between 0.0 and the maximum anisotropic level supported by the current machine. Selecting a value higher than max.f results in max.f.
@return No return value.</desc>
</function>
<function>
<name>setOpenGLInteriorMipReduction</name>
<args> reductionVal </args>
<desc>Use the setOpenGLInteriorMipReduction function to set the texture quality for interiors.
@param reductionVal An integer value between 0 and 5, with 0 being the lowest quality and 5 being the highest quality.
@return No return value.
@sa setOpenGLMipReduction ,setOpenGLSkyMipReduction</desc>
</function>
<function>
<name>setOpenGLMipReduction</name>
<args> reductionVal </args>
<desc>Use the setOpenGLMipReduction function to control shape texture detail
@param reductionVal An integer value between 0 and 5, with 0 being the lowest quality and 5 being the highest quality.
@return No return value.
@sa setOpenGLInteriorMipReduction, setOpenGLSkyMipReduction</desc>
</function>
<function>
<name>setOpenGLSkyMipReduction</name>
<args> reductionVal </args>
<desc>Use the setOpenGLSkyMipReduction function to control texture detail for the skybox and clouds.
@param reductionVal An integer value between 0 and 5, with 0 being the lowest quality and 5 being the highest quality.
@return No return value.
@sa setOpenGLInteriorMipReduction, setOpenGLMipReduction</desc>
</function>
<function>
<name>setOpenGLTextureCompressionHint</name>
<args> hint </args>
<desc>Use the setOpenGLTextureCompressionHint function to select the OpenGL texture compression method.
@param hint "GL_DONT_CARE", "GL_FASTEST", or "GL_NICEST". (Please refer to an OpenGL text for information on what these mean).
@return No return value</desc>
</function>
<function>
<name>setRandomSeed</name>
<args> startSeed </args>
<desc>Use the setRandomSeed function to initialize the random number generator with the initial seed of startSeed.
@param startSeed The new starting seed value for the random generator.
@return No return value.
@sa getRandom, getRandomSeed</desc>
</function>
<function>
<name>setRecord</name>
<args> sourceString , index , replace </args>
<desc>Use the setRecord function to replace an existing record with a new record(s), or to add record(s) to a string..
@param sourceString A string containing one or more records.
@param index The index of the record to remove.
@param replace The new record(s) to replace the record at index with.
@return There are multiple return cases:
- In the first case, a simple one-to-one replacement, the record at index in sourceString will be replaced with the value in replace, and the new string will be returned.
- In the first case, a multi-to-one replacement, the record at index in sourceString will be replaced with the value in replace, which can be two or more records, and the new string will be returned.
- In the thrid and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of records in sourceString, the requisite number of empty (null-string) records will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned.
@sa getRecord, getRecords, removeRecord</desc>
</function>
<function>
<name>setRes</name>
<args> width , height , bpp </args>
<desc>Use the setRes function to set the screen to the specified width, height, and bits-per-pixel (bpp).
@param width Resolution width in pixels.
@param height Resolution height in pixels.
@param bpp Pixel resolution in bits-per-pixel (16 or 32).
@return Returns true if successful, otherwise false.
@sa getDesktopResolution, getDisplayDeviceList, getResolutionList, nextResolution, prevResolution, setDisplayDevice, setScreenMode, switchBitDepth</desc>
</function>
<function>
<name>setScreenMode</name>
<args> width , height , bpp , fullScreen </args>
<desc>Use the setScreenMode function to set the screen to the specified width, height, and bits-per-pixel (bpp). Additionally, if fullScreen is set to true the engine will attempt to display the application in full-screen mode, otherwise it will attempt to used windowed mode.
@param width Resolution width in pixels.
@param height Resolution height in pixels.
@param bpp Pixel resolution in bits-per-pixel (16 or 32).
@param fullScreen A boolean value. If set to true, the application displays in full- screen mode, otherwise it will attempt to display in windowed mode.
@return Returns true if successful, otherwise false.
@sa getDesktopResolution, getDisplayDeviceList, getResolutionList, nextResolution, prevResolution, setDisplayDevice, setRes, switchBitDepth</desc>
</function>
<function>
<name>setServerInfo</name>
<args> index </args>
<desc>Use the setServerInfo function to set the values of the $ServerInfo::* global variables with information for a server found with queryLANServers or with queryMasterServer.
@param index The index of the server to get information about.
@return Will return true if the information was successfully set, false otherwise.
@sa getServerCount, queryLANServers, queryMasterServer, querySingleServer</desc>
</function>
<function>
<name>setVerticalSync</name>
<args> enable </args>
<desc>Use the setVerticalSync function to force the framerate to sync up with the vertical refresh rate.
This is used to reduce excessive swapping/rendering. There is generally no purpose in rendering any faster than the monitor will support. Those extra 'ergs' can be used for something else
@param enable A boolean value. If set to true, the engine will only swap front and back buffers on or before a vertical refresh pass.
@return Returns true on success, false otherwise.</desc>
</function>
<function>
<name>setWord</name>
<args> sourceString ,index,replace</args>
<desc>Use the setWord function to replace an existing word with a new word(s), or to add word(s) to a string..
@param sourceString A string containing one or more words.
@param index The index of the word to remove.
@param replace The new word(s) to replace the word at index with.
@return There are multiple return cases:
- In the first case, a simple one-to-one replacement, the word at index in sourceString will be replaced with the value in replace, and the new string will be returned.
- In the first case, a multi-to-one replacement, the word at index in sourceString will be replaced with the value in replace, which can be two or more words, and the new string will be returned.
- In the third and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of words in sourceString, the requisite number of empty (null-string) words will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned.
@sa getWord, getWords, removeWord</desc>
</function>
<function>
<name>shellExecute</name>
<args>executable, [args], [directory]</args>
<desc>Executes a process@param executable The program to execute
@param args Arguments to pass to the executable
@param directory The directory in which the program is located
@return Returns true on success, false otherwise</desc>
</function>
<function>
<name>startHeartbeat</name>
<desc>Use the startHeartbeat function to start advertising this game serer to any master servers on the master server list.
In order for this function to do anything, a list of master servers must have been previously specified. This list may contain one or more server addresses. Once this function is called, the game server will re-advertise itself to all the master servers on its master server lits every two minutes. To specify a list, simply create a set of array entries like this:
$pref::Master[0] = "2:192.168.123.15:28002";
$pref::Master[1] = "2:192.168.123.2:28002";
The format of these values is ==&gt; Region Number : IP Address : Port Number
These values should be specified in either the client's or the server's preferences file (prefs.cs). You may specifiy it elsewhere, however be sure that it is specified prior to this function being called and before any other functions that rely on it.
@return No return value.
@sa queryMasterServer, stopHeartbeat</desc>
</function>
<function>
<name>stopHeartbeat</name>
<desc>Use the startHeartbeat function to stop advertising this game serer to any master servers on the master server list.
@return No return value.
@sa queryMasterServer, startHeartbeat</desc>
</function>
<function>
<name>stopServerQuery</name>
<desc>Use the stopServerQuery function to cancel any outstanding server queries.
@return No return value.
@sa queryLANServers, queryMasterServer, querySingleServer</desc>
</function>
<function>
<name>strchr</name>
<args> sourceString , char </args>
<desc>Use the strchr function to extract a sub-string of sourceString, where the sub-string is equal to the first occurence of char in sourceString followed by the remainder of sourceString.
@param sourceString The string from which to extract a sub-string.
@param char The character to search for in sourceString.
@return Returns a string composed of first instance of char in sourceString, and all of the characters after it. If char is not found, a NULL string is returned.
@sa getSubStr</desc>
</function>
<function>
<name>strcmp</name>
<args> string1 , string2 </args>
<desc>Use the strcmp function to do a lexicographic case sensitive string comparison between string1 and string2.
@param string1 String to be compared to string2.
@param string2 String to be compared to string1.
@return Returns a numeric value: &lt;-1 (string1 is less than string2, including case), 0 (string1 is equal to string2, including case), 1 (string1 is greater than string2, including case)&gt;.
@sa see stricmp, strstr</desc>
</function>
<function>
<name>stricmp</name>
<args> string1 , string2 </args>
<desc>Use the stricmp function to do a lexicographic case in-sensitive string comparison between string1 and string2.
@param string1 String to be compared to string2.
@param string2 String to be compared to string1.
@return Returns a numeric value: &lt;-1 (string1 is less than string2, ignoring case), 0 (string1 is equal to string2, ignoring case), 1 (string1 is greater than string2, ignoring case)&gt;.
@sa see strcmp, strstr</desc>
</function>
<function>
<name>stripChars</name>
<args> sourceString , chars </args>
<desc>Use the stripChars function to remove chars from sourceString.
@param sourceString The string to be modified.
@param chars The character or characters to search for and remove.
@return Returns a copy of sourceString, from which all instances of chars have been removed. This may be the original sourceString, if chars was not found.
@sa stripMLControlChars, stripTrailingSpaces</desc>
</function>
<function>
<name>stripColorCodes</name>
<args>stringtoStrip</args>
<desc>- remove TorqueML color codes from the string.
@param stringtoString The string from which to remove TorqueML color codes
@return A string consisting of the original string minus color codes</desc>
</function>
<function>
<name>StripMLControlChars</name>
<args> sourceString </args>
<desc>Use the stripMLControlChars function to remove all Torque Markup-Language (ML) symbols from sourceString.
This may not remove &lt;br&gt; correctly, so check before you trust this function.
@param sourceString The string to be modified.
@return Returns a copy of sourceString with all the ML symbols removed, or the original string if no ML symbols were present.
@sa stripChars</desc>
</function>
<function>
<name>stripTrailingSpaces</name>
<args> string </args>
<desc>Removes all spaces after the final
@param string from which to remove trailing spaces
@return the source string minus trailing spaces</desc>
</function>
<function>
<name>strlen</name>
<args> string </args>
<desc>Use the strlen function to determine how many characters there are in string.
@param string The string to count characters for.
@return Returns the number of characters in string, or 0 if string is invalid or a NULL string</desc>
</function>
<function>
<name>strlwr</name>
<args> sourceString </args>
<desc>Use the strlwr function to convert all alpha characters in sourceString to lower-case equivalents.
@param sourceString The string to be modified.
@return Returns a copy of sourceString in which all upper-case characters have been converted to lower-case letters.
@sa strupr</desc>
</function>
<function>
<name>strpos</name>
<args> sourceString , searchString [ , offset ] </args>
<desc>Use the strPos function to locate the first instance of searchString in sourceString, starting at character 0, or at an optional offset.
@param sourceString The string in which to search for searchString.
@param searchString The string for which to search for in sourceString.
@param offset An optional non-negative integer value representing the character offset within sourceString at which to begin the search.
@return Returns a numeric character index representing the postion in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found.
@sa strstr</desc>
</function>
<function>
<name>strrchr</name>
<args> sourceString , char </args>
<desc>strrchr searches the sourceString for the last occurance of the giuven char
@param sourceString The string to search
@return Either a string consisting of the given string from the last occurance of the given char on or an empty string if not found</desc>
</function>
<function>
<name>strreplace</name>
<args> sourceString , from , to </args>
<desc>Use the strreplace function to replace every instance of from in sourceString with to.
This function is case-sensitive and only does exact matching
@param sourceString The string to do replacement operations on.
@param from The old value to be replaced.
@param to The new value to replace old values with.
@return Returns a new version of sourceString in which every instance of the value in from was replaced with the value in to.</desc>
</function>
<function>
<name>strstr</name>
<args> sourceString , searchString </args>
<desc>Use the strstr function to locate the first instance of searchString in sourceString.
@param sourceString The string in which to search for searchString.
@param searchString The string for which to search for in sourceString.
@return Returns a numeric character index representing the position in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found.
@sa strpos</desc>
</function>
<function>
<name>strupr</name>
<args> sourceString </args>
<desc>Use the strupr function to convert all alpha characters in sourceString to upper-case equivalents.
@param sourceString The string to be modified.
@return Returns a copy of sourceString in which all lower-case characters have been converted to upper-case letters.
@sa strlwr</desc>
</function>
<function>
<name>switchBitDepth</name>
<desc>Use the switchBitDepth function to toggle the bits-per-pixel (bpp) pixel resolution between 16 and 32.
@return Returns true on success, false otherwise.
@sa getDesktopResolution, getDisplayDeviceList, getResolutionList, nextResolution, prevResolution, setDisplayDevice, setRes</desc>
</function>
<function>
<name>t2dAngleBetween</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns the angle between v1 and v2.</desc>
</function>
<function>
<name>t2dAngleToPoint</name>
<args>t2dVector p1, t2dVector p1</args>
<desc>- Returns the angle from p1 to p2.</desc>
</function>
<function>
<name>t2dAssert</name>
<args>condition, message</args>
<desc>- Fatal Script Assertion</desc>
</function>
<function>
<name>t2dAssertISV</name>
<args>condition, message</args>
<desc>- Fatal ISV Script Assertion</desc>
</function>
<function>
<name>t2dBeginScene</name>
<desc>Sets the default Scene Graph.</desc>
</function>
<function>
<name>t2dEndScene</name>
<desc>Resets the default Scene Graph.</desc>
</function>
<function>
<name>t2dGetMax</name>
<args>a, b</args>
<desc>- Returns the Maximum of two values.</desc>
</function>
<function>
<name>t2dGetMin</name>
<args>a, b</args>
<desc>- Returns the Minimum of two values.</desc>
</function>
<function>
<name>t2dRectNormalise</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns normalise rectangle of v1 and v2.</desc>
</function>
<function>
<name>t2dVectorAdd</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns v1+v2.</desc>
</function>
<function>
<name>t2dVectorCompare</name>
<args>t2dVector p1$, t2dVector p2$, [epsilon]</args>
<desc>- Compares points p1 and p2 with optional difference (epsilon).</desc>
</function>
<function>
<name>t2dVectorDistance</name>
<args>t2dVector p1$, t2dVector p2$</args>
<desc>- Returns the distance between points p1 and p2.</desc>
</function>
<function>
<name>t2dVectorDot</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns dot-product of v1 and v2.</desc>
</function>
<function>
<name>t2dVectorLength</name>
<args>t2dVector v1$</args>
<desc>- Returns the length of v1.</desc>
</function>
<function>
<name>t2dVectorMult</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns v1 mult v2.</desc>
</function>
<function>
<name>t2dVectorNormalise</name>
<args>t2dVector v1$</args>
<desc>- Returns normalised v1.</desc>
</function>
<function>
<name>t2dVectorScale</name>
<args>t2dVector v1$, scale</args>
<desc>- Returns v1 scaled by scale.</desc>
</function>
<function>
<name>t2dVectorSub</name>
<args>t2dVector v1$, t2dVector v2$</args>
<desc>- Returns v1-v2.</desc>
</function>
<function>
<name>telnetSetParameters</name>
<args>int port, string consolePass, string listenPass</args>
<desc>Initialize and open the telnet console.

@param port        Port to listen on for console connections (0 will shut down listening).
@param consolePass Password for read/write access to console.
@param listenPass  Password for read access to console.
@param remoteEcho  [optional] Enable echoing back to the client, off by default.
@return No return value</desc>
</function>
<function>
<name>toggleFullScreen</name>
<desc>Use the toggleFullScreen function to switch from full-screen mode to windowed, or vice versa.
@return Returns true on success, false otherwise</desc>
</function>
<function>
<name>trace</name>
<args> enable </args>
<desc>Use the trace function to enable (or disable) function call tracing. If enabled, tracing will print a message every time a function is entered, showing what arguments it received, and it will print a message every time a function is exited, showing the return value (or last value of last statement) for that function.
@param enable A boolean value. If set to true, tracing is enabled, otherwise it is disabled.
@return No return value</desc>
</function>
<function>
<name>trim</name>
<args> sourceString </args>
<desc>Use the trim function to strip the leading and trailing white space from sourceString.
White space is any character in this set: spaces, TABs, and NULL strings.
@param sourceString The string to be trimmed.
@return Returns sourceString with all the leading and trailing white spaces removed.
@sa stripChars, stripMLControlChars, stripTrailingSpaces, ltrim, rtrim</desc>
</function>
<function>
<name>unitTest_runTests</name>
<args>[searchString]</args>
<desc>- run unit tests, or just the tests that prefix match against the searchString.
@param searchString Optional specific search string for tests to execute
@return No Return Value.</desc>
</function>
<function>
<name>unregisterMessageListener</name>
<args>queueName, listener</args>
<desc>Unregisters the message listener on given message queue@param queueName The name of the message queue
@param listener The name of the listener to unregister
@return No Return Value</desc>
</function>
<function>
<name>unregisterMessageQueue</name>
<args>queueName</args>
<desc>Unregisters given message queue
@param The name of the message queue
@return No Return Value</desc>
</function>
<function>
<name>VectorAdd</name>
<args> vecA , vecB </args>
<desc>Use the VectorAdd function to add two vectors of up to three elements each to each other
@param vecA A vector of up to three elements.
@param vecB A vector of up to three elements.
@return Returns the result of vecA + vecB.
@sa vectorSub</desc>
</function>
<function>
<name>VectorCross</name>
<args> vecA , vecB </args>
<desc>Use the VectorCross function to calculate the cross product of two vectors of up to three elements each.
Remember, the resultant vector will always be an right angles (orthogonal) to both input vectors.
@param vecA A vector of up to three elements.
@param vecB A vector of up to three elements.
@return Returns the result of vecA x vecB.
@sa VectorDot</desc>
</function>
<function>
<name>VectorDist</name>
<args> vecA , vecB </args>
<desc>Use the VectorDist function to calculate distance between two vectors of up to three elements each.
@param vecA A vector of up to three elements.
@param vecB A vector of up to three elements.
@return Returns the result of " |Xa – Xb| |Ya – Yb| |Za – Zb| ".
@sa VectorLen</desc>
</function>
<function>
<name>VectorDot</name>
<args> vecA , vecB </args>
<desc>Use the VectorCross function to calculate the dot product of two unit vectors of up to three elements each. Warning! Be sure to always normalize both vecA and vecB before attempting to find the dot product. Calculating a dot product using un-normalized vectors (non- unit vectors) will result in meaningless results.
If the return value is &lt; 0, the inner-angle between the vectors is &gt; 90 degrees. If the return value is == 0, the inner-angle between the vectors is == 90 degrees. If the return value is &gt; 0, the inner-angle between the vectors is &lt; 90 degrees.
@param vecA A unit-vector of up to three elements.
@param vecB A unit-vector of up to three elements.
@return Returns a scalar value equal to the result of vecA . vecB. This value which will always be a single floating-point value in the range [ -1 , +1 ].
@sa VectorCross</desc>
</function>
<function>
<name>VectorLen</name>
<args> vec </args>
<desc>Use the VectorLen function to calculate the length of vector vec.
@param vec A vector of up to three elements.
@return Returns a scalar representing the length of the vector vec.
@sa VectorDist</desc>
</function>
<function>
<name>VectorNormalize</name>
<args> vec </args>
<desc>Use the VectorNormalize function to calculated the unit vector equivalent of the vector vec.
@param vec A vector of up to three elements.
@return Returns the unit vector equivalent of the vector vec.
@sa VectorScale</desc>
</function>
<function>
<name>VectorOrthoBasis</name>
<args> vec </args>
<desc>Use the VectorOrthoBasis function to calculate a 3x3 Row-Major formated matrix representing the orthogonal basis for the vector vec.
@param vec A four element vector of the form "AxisX AxisY AxisZ theta", where theta is the angle of rotation about the vector formed by the prior three values.
@return Returns a 3x3 Row-Major formated matrix</desc>
</function>
<function>
<name>VectorScale</name>
<args> vec , scale </args>
<desc>Use the VectorScale function to scale the vector vec by the scalar scale.
@param vec A vector of up to three elements.
@param scale A numeric value (integer or floating-point) representing the scaling factor.
@return Returns a scaled version of the vector vec, equivalent to: ( scale * X ) ( scale * Y ) ( scale * Z )".
@sa VectorNormalize</desc>
</function>
<function>
<name>VectorSub</name>
<args> vecA , vecB </args>
<desc>Use the VectorSub function to subtract vecB from vecA.
@param vecA Left side vector in subtraction equation.
@param vecB Right side vector in subtraction equation.
@return Returns a new vector equivalent to: "vecA - vecB".
@sa vectorAdd</desc>
</function>
<function>
<name>videoSetGammaCorrection</name>
<args> gamma </args>
<desc>Use the videoSetGammaCorrection function to adjust the gamma for the video card.
The card will revert to it's default gamma setting as long as the application closes normally
@param gamma A floating-point value between 0.0 and 1.0.
@return No return value.</desc>
</function>
<function>
<name>warn</name>
<args> text [ , ... ] </args>
<desc>Use the warn function to print warning messages to the console. These messages usually yellow or orange.
@param text Any valid text string.
@param ... Any additional valid text string(s).
@return No return value.
@sa warn, error</desc>
</function>
<function>
<name>writeFontCache</name>
<desc>force all cached fonts toserialize themselves to the cache.@return No return value</desc>
</function>
</exports>
