Classes
Name Base
ActionMap SimObject
Methods
Name Arguments
bind device, action, [modifier spec, mod...], command
bindCmd device, action, makeCmd, breakCmd
getBinding command
getCommand device, action
getDeadZone device, action
getScale device, action
isInverted device, action
pop
push
save [fileName], [append]
unbind device, action
AudioDescription SimDataBlock
Fields
Name Desc
coneInsideAngle int coneInsideAngle
coneOutsideAngle int coneOutsideAngle
coneOutsideVolume float coneOutsideVolume
coneVector Point3F coneVector
environmentLevel float environmentLevel
is3D bool is3D
isLooping bool isLooping
isStreaming bool isStreaming
loopCount int loopCount
maxDistance float maxDistance
maxLoopGap int maxLoopGap
minLoopGap int minLoopGap
referenceDistance float referenceDistance
type int type
volume float volume
AudioEnvironment SimDataBlock
Fields
Name Desc
airAbsorption float airAbsorption
damping float damping
decayHFRatio float decayHFRatio
decayTime float decayTime
effectVolume float effectVolume
environmentDiffusion float environmentDiffusion
environmentSize float environmentSize
flags int flags
reflections int reflections
reflectionsDelay float reflectionsDelay
reverb int reverb
reverbDelay float reverbDelay
room enumval room
roomHF int roomHF
roomRolloffFactor float roomRolloffFactor
roomVolume int roomVolume
useRoom bool useRoom
AudioProfile SimDataBlock
Fields
Name Desc
description AudioDescription description
environment AudioSampleEnvironment environment
fileName filename fileName
preload bool preload
AudioSampleEnvironment SimDataBlock
Fields
Name Desc
airAbsorption float airAbsorption
direct int direct
directHF int directHF
flags int flags
obstruction float obstruction
obstructionLFRatio float obstructionLFRatio
occlusion float occlusion
occlusionLFRatio float occlusionLFRatio
occlusionRoomRatio float occlusionRoomRatio
outsideVolumeHF int outsideVolumeHF
room int room
roomRolloff float roomRolloff
BanList SimObject
Methods
Name Arguments Description
add int ID, TransportAddress TA, int banLength 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.
addAbsolute int ID, TransportAddress TA, int banTime 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.
export string filename Dump the banlist to a file.
isBanned int ID, TransportAddress TA Is someone banned? @param ID Unique ID of the player. @param TA Address from which the player connected.
removeBan int ID, TransportAddress TA Unban someone. @param ID Unique ID of the player. @param TA Address from which the player connected.
ConnectionMessageEvent
ConsoleLogger SimObject
Methods
Name Arguments Description
attach Attaches this object to the console and begins logging
detach Detaches this object from the console and stops logging
Fields
Name Desc
level enumval level
DbgFileView GuiArrayCtrl
Methods
Name Arguments Description
clearBreakPositions Clear all break points in the current file.
findString string findThis Find the specified string in the currently viewed file and scroll it into view.
getCurrentLine 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.
open string filename Open a file for viewing. @note This loads the file from the local system.
removeBreak int line Remove a breakpoint from the specified line.
setBreak int line Set a breakpoint at the specified line.
setBreakPosition int line Set a breakpoint at the specified line.
setCurrentLine int line, bool selected Set the current highlighted line.
FileChunkEvent
FileDownloadRequestEvent
FileObject SimObject
Methods
Name Arguments Description
close Close the file.
isEOF Are we at the end of the file?
openForAppend string filename
openForRead string filename
openForWrite string filename
readLine Read a line from the file.
writeLine string text Write a line to the file, if it was opened for writing.
writeObject SimObject
GameConnection NetConnection
Methods
Name Arguments Description
activateGhosting
delete string reason=NULL Disconnect a client; reason is sent as part of the disconnect packet.
getServerConnection Get the server connection if any.
resetGhosting
setConnectArgs
setJoinPassword
GhostAlwaysObjectEvent
GuiArrayCtrl GuiControl
GuiAviBitmapCtrl GuiControl
Fields
Name Desc
done bool done
GuiBackgroundCtrl GuiControl
GuiBitmapBorderCtrl GuiControl
GuiBitmapButtonCtrl GuiButtonCtrl
Methods
Name Arguments
setBitmap filepath name
Fields
Name Desc
bitmap filename bitmap
GuiBitmapButtonTextCtrl GuiBitmapButtonCtrl
GuiBitmapCtrl GuiControl
Methods
Name Arguments Description
setBitmap string filename Set the bitmap displayed in the control. Note that it is limited in size, to 256x256.
setValue int xAxis, int yAxis Set the offset of the bitmap.
Fields
Name Desc
bitmap filename bitmap
wrap bool wrap
GuiBorderButtonCtrl GuiButtonBaseCtrl
GuiBubbleTextCtrl GuiTextCtrl
GuiButtonBaseCtrl GuiControl
Methods
Name Arguments Description
getText - returns the text of the button.
performClick - simulates a button click from script.
setStateOn bool isStateOn - sets the state on member and updates siblings of the same group.
setText string text - sets the text of the button to the string.
setTextID string id - sets the text of the button to the localized string.
Fields
Name Desc
buttonType enumval buttonType
groupNum int groupNum
text caseString text
textID string textID
GuiButtonCtrl GuiButtonBaseCtrl
GuiCanvas GuiControl
Methods
Name Arguments Description
cursorOff
cursorOn
getContent Get the GuiControl which is being used as the content.
getCursorPos Get the current position of the cursor.
hideCursor
isCursorOn
popDialog GuiControl ctrl=NULL
popLayer int layer
pushDialog GuiControl ctrl, int layer
renderFront bool enable
repaint Force canvas to redraw.
reset Reset the update regions for the canvas.
setContent GuiControl ctrl Set the content of the canvas.
setCursor bool visible
setCursorPos Point2I pos
showCursor
GuiCheckBoxCtrl GuiButtonBaseCtrl
GuiChunkedBitmapCtrl GuiControl
Methods
Name Arguments Description
setBitmap string filename Set the bitmap contained in this control.
Fields
Name Desc
bitmap filename bitmap
tile bool tile
useVariable bool useVariable
GuiColorPickerCtrl GuiControl
Methods
Name Arguments Description
getSelectorPos Gets the current position of the selector
setSelectorPos Sets the current position of the selector
updateColor Forces update of pick color
Fields
Name Desc
ActionOnMove bool ActionOnMove
BaseColor ColorF BaseColor
DisplayMode enumval DisplayMode
PickColor ColorF PickColor
SelectorGap int SelectorGap
GuiConsole GuiArrayCtrl
GuiConsoleEditCtrl GuiTextEditCtrl
Fields
Name Desc
useSiblingScroller bool useSiblingScroller
GuiConsoleTextCtrl GuiControl
Fields
Name Desc
expression caseString expression
GuiControl SimGroup
Methods
Name Arguments Description
addGuiControl S32 controlId
getCenter returns center of control, as space seperated ints
getChildByInternalName string InternalName
getExtent Get the width and height of the control.
getGlobalCenter returns center of control, as space seperated ints
getGlobalPosition
getInternalName getInternalName returns the controls internal name
getMinExtent Get the minimum allowed size of the control.
getParent returns the Id of the parent control
getPosition
getValue
isActive
isAwake
isVisible
makeFirstResponder bool isFirst
pointInControl returns true if the point is in the control, point is in parent coords
reorderChild (child1, child2) uses simset reorder to push child 1 after child 2 - both must already be child controls of this control
resize int x, int y, int w, int h
setActive bool active
setCenter sets control position, by center - coords are local not global
setExtent sets the width & height of the control.
setInternalName string InternalName
setPosition int x,y in local space
setPositionGlobal int x,y in global screen space
setProfile GuiControlProfile p
setValue string value
setVisible bool visible
Fields
Name Desc
Accelerator string Accelerator
AltCommand string AltCommand
canSave bool canSave
class Script Class of object.
Command string Command
Extent Point2I Extent
HorizSizing enumval HorizSizing
hovertime int hovertime
internalName string internalName
langTableMod string langTableMod
MinExtent Point2I MinExtent
Modal @deprecated This member is deprecated, which means that its value is always undefined.
Position Point2I Position
Profile GuiProfile Profile
SetFirstResponder @deprecated This member is deprecated, which means that its value is always undefined.
superclass Script SuperClass of object.
ToolTip string ToolTip
tooltipprofile GuiProfile tooltipprofile
Variable string Variable
VertSizing enumval VertSizing
Visible bool Visible
GuiControlArrayControl GuiControl
Fields
Name Desc
colCount int colCount
colSizes intList colSizes
colSpacing int colSpacing
rowSize int rowSize
rowSpacing int rowSpacing
GuiControlListPopUp GuiPopUpMenuCtrl
GuiControlProfile SimObject
Fields
Name Desc
autoSizeHeight bool autoSizeHeight
autoSizeWidth bool autoSizeWidth
bevelColorHL ColorI bevelColorHL
bevelColorLL ColorI bevelColorLL
bitmap filename bitmap
border int border
borderColor ColorI borderColor
borderColorHL ColorI borderColorHL
borderColorNA ColorI borderColorNA
borderThickness int borderThickness
canKeyFocus bool canKeyFocus
cursorColor ColorI cursorColor
fillColor ColorI fillColor
fillColorHL ColorI fillColorHL
fillColorNA ColorI fillColorNA
fontCharset enumval fontCharset
fontColor ColorI fontColor
fontColorHL ColorI fontColorHL
fontColorLink ColorI fontColorLink
fontColorLinkHL ColorI fontColorLinkHL
fontColorNA ColorI fontColorNA
fontColors ColorI fontColors
fontColorSEL ColorI fontColorSEL
fontSize int fontSize
fontType string fontType
justify enumval justify
Modal bool Modal
mouseOverSelected bool mouseOverSelected
numbersOnly bool numbersOnly
opaque bool opaque
returnTab bool returnTab
soundButtonDown AudioProfile soundButtonDown
soundButtonOver AudioProfile soundButtonOver
tab bool tab
textOffset Point2I textOffset
GuiCursor SimObject
Fields
Name Desc
bitmapName filename bitmapName
hotSpot Point2I hotSpot
renderOffset Point2F renderOffset
GuiDirectoryFileListCtrl GuiTextListCtrl
Methods
Name Arguments Description
getSelectedFile - returns the currently selected file name
setPath path,filter - directory to enumerate files from (without trailing slash)
GuiDirectoryTreeCtrl GuiTreeViewCtrl
Methods
Name Arguments Description
getSelectedPath - returns the currently selected path in the tree
setSelectedPath path - expands the tree to the specified path
GuiEditCtrl GuiControl
Methods
Name Arguments Description
addNewCtrl GuiControl ctrl
addSelection selects a control.
bringToFront
clearSelection Clear selected controls list.
deleteSelection Delete the selected text.
getSelected - Gets the GUI control(s) the editor is currently selecting
justify int mode
loadSelection string fileName
moveSelection int deltax, int deltay
pushToBack
removeSelection deselects a control.
saveSelection string fileName
select GuiControl ctrl
selectAll
setCurrentAddSet GuiControl ctrl
setRoot GuiControl root
toggle Toggle activation.
GuiEditorRuler GuiControl
Fields
Name Desc
refCtrl string refCtrl
GuiEffectCanvas GuiCanvas
GuiFadeinBitmapCtrl GuiBitmapCtrl
Fields
Name Desc
done bool done
fadeinTime int fadeinTime
fadeoutTime int fadeoutTime
waitTime int waitTime
GuiFilterCtrl GuiControl
Methods
Name Arguments Description
getValue Return a tuple containing all the values in the filter.
identity Reset the filtering.
setValue f1, f2, ... Reset the filter to use the specified points, spread equidistantly across the domain.
Fields
Name Desc
controlPoints int controlPoints
filter floatList filter
GuiFrameSetCtrl GuiControl
Methods
Name Arguments
addColumn
addRow
frameBorder int index, bool enable=true
frameMinExtent int index, int w, int h
frameMovable int index, bool enable=true
getColumnCount
getColumnOffset int index
getRowCount
getRowOffset int index
removeColumn
removeRow
setColumnOffset int index, int offset
setRowOffset int index, int offset
Fields
Name Desc
autoBalance bool autoBalance
borderColor ColorI borderColor
borderEnable enumval borderEnable
borderMovable enumval borderMovable
borderWidth int borderWidth
columns intList columns
fudgeFactor int fudgeFactor
rows intList rows
GuiGraphCtrl GuiControl
Methods
Name Arguments Description
addAutoPlot int plotID, string variable, int update Adds a data point with value variable, every update ms.
addDatum int plotID, float v Add a data point to the given plot.
getDatum int plotID, int samples Get a data point from the plot specified, samples from the start of the graph.
matchScale int plotID, int plotID, ... Sets the scale of all specified plots to the maximum scale among them.
removeAutoPlot int plotID Stops automatic pointing over set interval.
setGraphType int plotID, string graphType Change GraphType of plot plotID.
GuiInputCtrl GuiControl
GuiInspector GuiStackControl
Methods
Name Arguments Description
getInspectObject - Returns currently inspected object
inspect Inspect(Object)
setName NewObjectName
GuiInspectorDatablockField GuiInspectorField
GuiInspectorDynamicField GuiInspectorField
Methods
Name Arguments
renameField newDynamicFieldName
GuiInspectorDynamicGroup
Methods
Name Arguments
addDynamicField
GuiInspectorField GuiControl
Methods
Name Arguments
apply newValue
GuiInspectorGroup GuiControl
Fields
Name Desc
Caption string Caption
GuiInspectorTypeCheckBox GuiInspectorField
GuiInspectorTypeColor GuiInspectorField
GuiInspectorTypeColorF GuiInspectorTypeColor
GuiInspectorTypeColorI GuiInspectorTypeColor
GuiInspectorTypeEnum GuiInspectorField
GuiInspectorTypeFileName GuiInspectorField
GuiInspectorTypeGuiProfile GuiInspectorTypeEnum
GuiListBoxCtrl GuiControl
Methods
Name Arguments Description
addItem text - adds an item to the end of the list
clearItems - Clears all the items in the listbox
clearSelection - sets all currently selected items to unselected
deleteItem itemIndex
findItemText myItemText, [?caseSensitive - false] - Returns index of item with matching text
getItemCount - returns the number of items in the list
getItemText index - returns the text of the item at the specified index
getSelCount - returns the number of items currently selected
getSelectedItem - returns the selected items index. If multiple selections exist it returns the first selected item
getSelectedItems - returns a space delimited list of the selected items indexes in the list
insertItem text, index - inserts an item into the list at the specified index
setCurSel index - sets the currently selected item at the specified index
setCurSelRange start,[stop] - sets the current selection range from index start to stop. if no stop is specified it sets from start index to the end of the list
setItemText index, newtext - sets the items text at the specified index
setSelected index, [true]/false - sets the item at the index specified to selected or not
Fields
Name Desc
AllowMultipleSelections bool AllowMultipleSelections
fitParentWidth bool fitParentWidth
GuiMenuBar GuiControl
Methods
Name Arguments Description
addMenu string menuText, int menuId - adds a new menu to the menu bar.
addMenuItem string menu, string menuItemText, int menuItemId, string accelerator = NULL, int checkGroup = -1 - adds a menu item to the specified menu. The menu argument can be either the text of a menu or its id.
clearMenuItems string menu - removes all the menu items from the specified menu.
clearMenus - clears all the menus from the menu bar.
removeMenu string menu - removes the specified menu from the menu bar.
removeMenuItem string menu, string menuItem - removes the specified menu item from the menu.
setMenuItemBitmap string menu, string menuItem, int bitmapIndex - sets the specified menu item bitmap index in the bitmap array. Setting the item's index to -1 will remove any bitmap.
setMenuItemChecked string menu, string menuItem, bool checked - 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.
setMenuItemEnable string menu, string menuItem, bool enabled - sets the menu item to enabled or disabled based on the enable parameter. The specified menu and menu item can either be text or ids.
setMenuItemText string menu, string menuItem, string newMenuItemText - sets the text of the specified menu item to the new string.
setMenuItemVisible string menu, string menuItem, bool isVisible - sets the specified menu item to be either visible or not.
setMenuText string menu, string newMenuText - sets the text of the specified menu to the new string.
setMenuVisible string menu, bool visible - sets the whether or not to display the specified menu.
GuiMessageVectorCtrl GuiControl
Methods
Name Arguments Description
attach MessageVector item Make this gui control display messages from the specified MessageVector
detach Stop listing messages from the MessageVector previously attached to, if any.
Fields
Name Desc
allowedMatches string allowedMatches
lineContinuedIndex int lineContinuedIndex
lineSpacing int lineSpacing
matchColor ColorI matchColor
maxColorIndex int maxColorIndex
GuiMLTextCtrl GuiControl
Methods
Name Arguments Description
addText string text, bool reformat
forceReflow forces the text control to reflow the text after new text is added, possibly resizing the control.
getText Returns the text from the control, including ML.
scrollToBottom Scroll to the top of the text.
scrollToTag int tagID Scroll down to a specified tag.
scrollToTop Scroll to the top of the text.
setAlpha
setCursorPosition int newPos Offset in characters to set cursor's position to.
setText string text Set the text contained in the control.
Fields
Name Desc
allowColorChars bool allowColorChars
deniedSound AudioProfile deniedSound
lineSpacing int lineSpacing
maxChars int maxChars
text caseString text
GuiMLTextEditCtrl GuiMLTextCtrl
Fields
Name Desc
escapeCommand string escapeCommand
GuiMouseEventCtrl GuiControl
Fields
Name Desc
lockMouse bool lockMouse
GuiPaneControl GuiControl
Methods
Name Arguments
setCollapsed bool
Fields
Name Desc
barBehindText bool barBehindText
Caption string Caption
captionID string captionID
collapsable bool collapsable
GuiPopUpMenuCtrl GuiTextCtrl
Methods
Name Arguments Description
add string name, int idNum, int scheme=0
addScheme int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL
clear Clear the popup list.
findText string text Returns the position of the first entry containing the specified text.
forceClose
forceOnAction
getSelected
getText
getTextById int id
replaceText bool doReplaceText
setEnumContent string class, string enum 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..
setSelected int id
setText string text
size Get the size of the menu - the number of entries in it.
sort Sort the list alphabetically.
Fields
Name Desc
maxPopupHeight int maxPopupHeight
GuiProgressCtrl GuiTextCtrl
GuiRadioCtrl GuiCheckBoxCtrl
GuiSceneGraphEditCtrl t2dSceneWindow
Methods
Name Arguments Description
acquireObject releases current object, if any, and aquires the new one specified
addTool ToolObject
alterSelectionLayer layerDelta
breakApartAcquiredObjects Removes all acquired objects from there group.
clearAcquisition Clears the active object
getActiveTool Returns the active tool
getFillColor returns current fill color
getFullContainSelect Gets the full contain selection status.
getGridColor returns current grid color
getGridSnapX returns current X snap grid. 0 = off
getGridSnapY returns current Y snap grid. 0 = off
getGridVisibility turns grid drawing on/off
getSnapThreshold Gets the snap threshold for snap to grid.
getSnapToGridX returns current X snap
getSnapToGridY returns current Y snap
groupAcquiredObjects Puts all acquired objects in a t2dSceneObjectGroup.
isGridSnapX gets is snap for x
isGridSnapY gets is snap for y
isSnapToGrid returns whether we are snapping to the grid
removeTool ToolObject
selectTool ToolObject
setDebugInfo toggles the debug info in level editor
setFillColor sets the fill color for the control
setFullContainSelect Sets whether or not objects should be fully contained to be selected.
setGridColor sets the grid color for the control
setGridSizeX sets the X snap unit for our tool, in world units, set to 0 to turn of snapping
setGridSizeY sets the Y snap unit for our tool, in world units, set to 0 to turn of snapping
setGridVisibility turns grid drawing on/off
setSnapThreshold Sets the snap threshold for snap to grid.
setSnapToGridX sets whether we'll snap to X axis
setSnapToGridY sets whether we'll snap to Y axis
updateAcquiredObjectSet Updates the t2dSceneObjectSet of acquired objects.
GuiSceneToolBase SimObject
GuiSceneToolCamera GuiSceneToolBase
GuiSceneToolCreate GuiSceneToolBase
Methods
Name Arguments
getCreateType
getDatablock
setCreateType "type"
setDatablock "datablock"
GuiSceneToolMount GuiSceneToolBase
GuiSceneToolPoly GuiSceneToolBase
Methods
Name Arguments
getScript
getVertexCount
setPolyPrimitive %numEdges
GuiSceneToolSelection GuiSceneToolBase
GuiSceneToolVector GuiSceneToolBase
Methods
Name Arguments
getScript
getVertexCount
setPolyPrimitive %numEdges
GuiSceneToolWorldLimit GuiSceneToolBase
GuiScrollCtrl GuiControl
Methods
Name Arguments Description
scrollToBottom - scrolls the scroll control to the bottom of the child content area.
scrollToTop - scrolls the scroll control to the top of the child content area.
Fields
Name Desc
childMargin Point2I childMargin
constantThumbHeight bool constantThumbHeight
hScrollBar enumval hScrollBar
vScrollBar enumval vScrollBar
willFirstRespond bool willFirstRespond
GuiSliderCtrl GuiControl
Methods
Name Arguments Description
getValue Get the position of the slider.
Fields
Name Desc
range Point2F range
ticks int ticks
value float value
GuiStackControl GuiControl
Fields
Name Desc
HorizStacking enumval HorizStacking
Padding int Padding
StackingType enumval StackingType
VertStacking enumval VertStacking
GuiTabBookCtrl GuiControl
Methods
Name Arguments
addPage no arguments expected
Fields
Name Desc
TabHeight int TabHeight
TabPosition enumval TabPosition
TabWidth int TabWidth
GuiTabPageCtrl GuiTextCtrl
GuiTextCtrl GuiControl
Methods
Name Arguments
setText newText
setTextID newText
Fields
Name Desc
maxLength int maxLength
text caseString text
textID string textID
GuiTextEditCtrl GuiTextCtrl
Methods
Name Arguments
getCursorPos
getText
setCursorPos newPos
Fields
Name Desc
deniedSound AudioProfile deniedSound
escapeCommand string escapeCommand
historySize int historySize
password bool password
passwordMask string passwordMask
sinkAllKeyEvents bool sinkAllKeyEvents
tabComplete bool tabComplete
validate string validate
GuiTextEditSliderCtrl GuiTextEditCtrl
Fields
Name Desc
format string format
increment float increment
range Point2F range
GuiTextListCtrl GuiArrayCtrl
Methods
Name Arguments Description
addRow int id, string text, int index=0 Returns row number of the new item.
clear Clear the list.
clearSelection Set the selection to nothing.
findTextIndex string needle Find needle in the list, and return the row number it was found in.
getRowId int index Get the row ID for an index.
getRowNumById int id Get the row number for a specified id.
getRowText int index Get the text of the row with the specified index.
getRowTextById int id Get the text of a row with the specified id.
getSelectedId Get the ID of the currently selected item.
getSelectedRow not ID
isRowActive int rowNum Is the specified row currently active?
removeRow int index Remove a row from the table, based on its index.
removeRowById int id Remove row with the specified id.
rowCount Get the number of rows.
scrollVisible int rowNum Scroll so the specified row is visible.
setRowActive int rowNum, bool active Mark a specified row as active/not.
setRowById int id, string text
setSelectedById int id Finds the specified entry by id, then marks its row as selected.
setSelectedRow int rowNum Selects the specified row.
sort int columnID, bool increasing=false Performs a standard (alphabetical) sort on the values in the specified column.
sortNumerical int columnID, bool increasing=false Perform a numerical sort on the values in the specified column.
Fields
Name Desc
clipColumnText bool clipColumnText
columns intList columns
enumerate bool enumerate
fitParentWidth bool fitParentWidth
resizeCell bool resizeCell
GuiTheoraCtrl GuiControl
Methods
Name Arguments Description
getCurrentTime Return the time elapsed in playback, in seconds.
setFile string filename Set an Ogg Theora file to play.
stop Stop playback.
Fields
Name Desc
backgroundColor ColorI backgroundColor
done bool done
stopOnSleep bool stopOnSleep
theoraFile filename theoraFile
GuiTickCtrl GuiControl
Methods
Name Arguments Description
setProcessTicks [tick = true] - This will set this object to either be processing ticks or not
GuiToolboxButtonCtrl GuiButtonCtrl
Methods
Name Arguments Description
setHoverBitmap filepath name sets the bitmap that shows when the button is disabled
setLoweredBitmap filepath name sets the bitmap that shows when the button is disabled
setNormalBitmap filepath name sets the bitmap that shows when the button is active
Fields
Name Desc
hoverBitmap filename hoverBitmap
loweredBitmap filename loweredBitmap
normalBitmap filename normalBitmap
GuiTreeViewCtrl GuiArrayCtrl
Methods
Name Arguments Description
addSelection selects an item
buildIconTable builds an icon table
buildVisibleTree Build the visible tree
clear - empty tree
clearSelection clears selection
deleteSelection deletes the selected items
editItem TreeItemId item, string newText, string newValue
expandItem TreeItemId item, bool expand=true
findItemByName find item by name and returns the mId
findItemByObjectId find item by object id and returns the mId
getChild TreeItemId item
getFirstRootItem Get id for root item.
getItemCount
getItemText TreeItemId item
getItemValue TreeItemId item
getNextSibling TreeItemId item
getParent TreeItemId item
getPrevSibling TreeItemId item
getSelectedItem
getSelectedItemList returns a space seperated list of mulitple item ids
getSelectedObject
getTextToRoot TreeItemId item,Delimiter=none gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally
insertItem TreeItemId parent, name, value, icon, normalImage=0, expandedImage=0
lockSelection locks selections
moveItemDown TreeItemId item
moveItemUp TreeItemId item
open SimSet obj, bool okToEdit=true Set the root of the tree view to the specified object, or to the root set.
removeItem TreeItemId item
removeSelection deselects an item
selectItem TreeItemId item, bool select=true
Fields
Name Desc
destroyTreeOnSleep bool destroyTreeOnSleep
fullRowSelect bool fullRowSelect
itemHeight int itemHeight
MouseDragging bool MouseDragging
MultipleSelections bool MultipleSelections
tabSize int tabSize
textOffset int textOffset
GuiVectorFieldCtrl GuiTickCtrl
GuiWindowCtrl GuiTextCtrl
Fields
Name Desc
canClose bool canClose
canMaximize bool canMaximize
canMinimize bool canMinimize
canMove bool canMove
closeCommand string closeCommand
minSize Point2I minSize
resizeHeight bool resizeHeight
resizeWidth bool resizeWidth
HTTPObject TCPObject
Methods
Name Arguments
get TransportAddress addr, string requirstURI, string query=NULL
post TransportAddress addr, string requestURI, string query, string post
LangTable SimObject
Methods
Name Arguments
addLanguage string filename, [string languageName]
getCurrentLanguage
getLangName int language
getNumLang
getString string filename
setCurrentLanguage int language
setDefaultLanguage int language
MaterialPropertyMap SimObject
MessageVector SimObject
Methods
Name Arguments Description
clear Clear the message vector.
deleteLine int deletePos Delete the line at the specified position.
dump string filename, string header=NULL Dump the message vector to a file, optionally prefixing a header.
getLineIndexByTag int tag 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.
getLineTag int line Get the tag of a specified line.
getLineText int line Get the text at a specified line.
getLineTextByTag int tag Scan through the lines in the vector, returning the first line that has a matching tag.
getNumLines Get the number of lines in the vector.
insertLine int insertPos, string msg, int tag=0 Insert a new line into the vector at the specified position.
popBackLine Pop a line from the back of the list; destroys the line.
popFrontLine Pop a line from the front of the vector, destroying the line.
pushBackLine string msg, int tag=0 Push a line onto the back of the list.
pushFrontLine string msg, int tag=0 Push a line onto the front of the vector.
NetConnection SimGroup
Methods
Name Arguments Description
checkMaxRate
connect string remoteAddress Connects this NC object to the remote address.
connectLocal Connects a connection to the server running in the same process.
getAddress Returns the address we're connected to.
getGhostID S32 realID Convert a real id to the ghost id for this connection.
getGhostsActive Returns number of ghosts active.
getPacketLoss
getPing
resolveGhostID S32 ghostID Convert a ghost id from this connection to a real id.
resolveObjectFromGhostIndex S32 ghostIdx Convert a ghost index from this connection to a real id.
setSimulatedNetParams float packetLoss, int delay
NetObject SimObject
Methods
Name Arguments Description
clearScopeToClient %client Undo the effects of a scopeToClient() call.
getGhostID
scopeToClient NetConnection %client Cause the NetObject to be forced as scoped on the specified NetConnection.
setScopeAlways Always scope this object on all connections.
NetStringEvent
pathAStar2d t2dSceneObject
Methods
Name Arguments Description
calculate find(startX / startY, destX / destY) - creates a path
clear - Clear Path
getDistance - Distance of Path
getLinearAngle step - Angle at Path Step
getLinearWorld distance - coord at path step + subStep
getSplineAngle step - Angle at Path Step
getSplineWorld distance - coord at path step + subStep
getSteps - Steps in Path
pathGrid2d t2dSceneObject
Methods
Name Arguments Description
createPath startX / startY, destX / destY, [cut corners?], [optimise?] - creates a path
deleteAllPaths Deletes all Path(s).
deletePath pathIndex - Deletes a Path.
deletePathId pathID - deletes a Path by Id.
getPath pathIndex - Returns Path by Index.
getPathCount Returns the number of paths
setDebugDraw bool - Sets debug draw flag
setTileLayer layer Name - Sets the layer
RemoteCommandEvent
ScriptGroup SimGroup
Fields
Name Desc
class string class
superclass string superclass
ScriptObject SimObject
Fields
Name Desc
class Class of object.
superclass Superclass of object.
SimChunk SimGroup
SimDataBlock SimObject
SimGroup SimSet
SimObject
Methods
Name Arguments Description
delete
dump
dumpClassHierarchy
getClassName
getGroup
getId
getName
getType
isChildOfGroup returns true, if we are in the specified simgroup - or a subgroup thereof
isMemberOfClass string classname -- returns true if this object is a member of the specified class
save fileName, <selectedOnly>
schedule time, command, <arg1...argN>
setName newName
Fields
Name Desc
canSaveDynamicFields bool canSaveDynamicFields
SimpleMessageEvent
SimpleNetObject NetObject
Methods
Name Arguments
setMessage string msg
SimSet SimObject
Methods
Name Arguments
add obj1,...
bringToFront object
clear
getCount
getObject objIndex
isMember object
listObjects
pushToBack object
remove obj1,...
t2dActiveTile SimObject
t2dActiveTileDatablock t2dBaseDatablock
t2dAnimatedSprite t2dSceneObject
Methods
Name Arguments Description
getAnimationFrame Gets current animation frame.
getAnimationName Gets current animation name.
getAnimationTime Gets current animation time.
getIsAnimationFinished Checks animation status.
playAnimation animationName$, [autoRestore?], [frameIndex], [mergeTime?] - Plays an animation.
setAnimationFrame frame - Sets the current animation frame.
setFrameChangeCallback status? - Sets the frame-change callback status.
Fields
Name Desc
startAnimation string startAnimation
t2dAnimatedSpriteDatablock t2dSceneObjectDatablock
Fields
Name Desc
startAnimation string startAnimation
t2dAnimationDatablock t2dBaseDatablock
Fields
Name Desc
animationCycle bool animationCycle
animationFrames string animationFrames
animationTime float animationTime
imageMap string imageMap
randomStart bool randomStart
startFrame int startFrame
t2dBaseDatablock SimDataBlock
Methods
Name Arguments Description
getDatablockClassName Gets datablocks unique classname.
t2dChunkedImageDatablock t2dBaseDatablock
Fields
Name Desc
imageName filename imageName
t2dChunkedSprite t2dSceneObject
Methods
Name Arguments Description
setChunkedImage chunkedImageName$ - Sets Chunked-Image.
setRepeat repeatX / repeatY - Sets the Repeat X/Y repetition.
Fields
Name Desc
chunkedImage string chunkedImage
repeatX int repeatX
repeatY int repeatY
t2dChunkedSpriteDatablock t2dSceneObjectDatablock
Fields
Name Desc
chunkedImage string chunkedImage
repeatX int repeatX
repeatY int repeatY
t2dCollisionMaterialDatablock t2dBaseDatablock
Fields
Name Desc
autoMassInertia bool autoMassInertia
damping float damping
density float density
forceScale float forceScale
friction float friction
immovable bool immovable
inertialMoment float inertialMoment
mass float mass
restitution float restitution
T2DDatablockDropDownCtrl GuiPopUpMenuCtrl
Methods
Name Arguments Description
setFilter datablock classname - no parameters for all t2d datablocks
Fields
Name Desc
DatablockFilter string DatablockFilter
t2dGunTurret t2dActiveTile
Methods
Name Arguments Description
setFrame frame - Sets imageMap frame.
setImageMap imageMapName$, [int frame] - Sets imageMap/Frame.
setTrackObject t2dSceneObject - Sets Object to Track.
t2dImageMapDatablock t2dBaseDatablock
Methods
Name Arguments Description
compile Compile Image-Map.
getFilterMode Get Filter Mode.
getFrameCount Get ImageMap Frame Count.
getFrameSize int frame - Get ImageMap Frame Size.
getFrameTexturePage int frame - Get ImageMap Frame Texture Page.
getImageMapMode Get ImageMap Mode.
getSrcBitmapName Get Source Bitmap Name.
getSrcBitmapSize Get Source Bitmap Size.
getTexturePageCount Get ImageMap Texture-Page Count.
getTexturePageFrameCount int texturePage - Get ImageMap Texture-Page Frame Count.
getTexturePageSize int texturePage - Get ImageMap Texture-Page Size.
setFilterMode Set Filter Mode.
Fields
Name Desc
allowUnload bool allowUnload
cellCountX int cellCountX
cellCountY int cellCountY
cellHeight int cellHeight
cellOffsetX int cellOffsetX
cellOffsetY int cellOffsetY
cellRowOrder bool cellRowOrder
cellStrideX int cellStrideX
cellStrideY int cellStrideY
cellWidth int cellWidth
filterMode enumval filterMode
filterPad bool filterPad
frameCount int frameCount
imageMode enumval imageMode
imageName filename imageName
linkImageMaps string linkImageMaps
preferPerf bool preferPerf
preload bool preload
t2dParticleEffect t2dSceneObject
Methods
Name Arguments Description
addDataKey time, value - Add Data-Key to Graph.
addEmitter Adds an Emitter to the Effect.
clearDataKeys Clear Data-Key(s) from Graph.
clearEmitters Clear all Emitters from the Effect.
findEmitterObject emitterName$ - Finds Emitter Object by name from Effect.
getDataKey keyIndex - Get Data-Key Time/Value from Graph.
getDataKeyCount Get Data-Key Count from Graph.
getEffectCollisionStatus Get the effect collision status.
getEffectLifeMode Gets the Effect Life Mode.
getEmitterCount Gets Emitter Count for Effect.
getEmitterObject emitterIndex - Gets Emitter Object from Effect.
getGraphValue time - Get Time-Value from Graph.
getMaxTime Get Max-Value from Graph.
getMaxValue Get Max-Value from Graph.
getMinTime Get Min-Time from Graph.
getMinValue Get Min-Value from Graph.
getTimeRepeat Get Time-Repeat for Graph.
loadEffect effectFile$ - Loads a Particle Effect.
moveEmitter fromEmitterIndex, toEmitterIndex - Moves the Emitter Object.
playEffect resetParticles? - Plays the Particle Effect.
removeDataKey keyIndex - Remove Data-Key from Graph.
removeEmitter emitterObject - Removes an Emitter from the Effect.
saveEffect effectFile$ - Saves a Particle Effect.
selectGraph graphName - Select Graph Name.
setDataKeyValue keyIndex, value - Set Data-Key Value in Graph.
setEffectCollisionStatus Set the effect collision status.
setEffectLifeMode lifeMode, [time] - Sets the Effect Life Mode/Time.
setTimeRepeat timeRepeat - Set Time-Repeat For Graph.
stopEffect [waitForParticles?, killEffect?] - Stops the Particle Effect.
Fields
Name Desc
collisionStatus bool collisionStatus
effectFile filename effectFile
t2dParticleEmitter SimObject
Methods
Name Arguments Description
addDataKey time, value - Add Data-Key to Graph.
clearDataKeys Clear Data-Key(s) from Graph.
getAlignAngleOffset Get Align-Orientation Angle-Offset.
getAlignKeepAligned Get Align-Orientation Keep-Aligned Flag.
getAnimationName Get Animation Name.
getAttachPositionToEmitter Get Attach-Position-To-Emitter Flag.
getAttachRotationToEmitter Get Attach-Rotation-To-Emitter Flag.
getBlending Gets the Rendering Blend Options.
getDataKey keyIndex - Get Data-Key Time/Value from Graph.
getDataKeyCount Get Data-Key Count from Graph.
getEffectCollisionStatus Get the emitter collision status.
getEmitterName Get the Emitters Name.
getEmitterType Get Emitter Type.
getFirstInFrontOrder Get First-In-Front-Order Flag.
getFixedAngleOffset Get Fixed-Orientation Angle-Offset.
getFixedAspect Get Fixed-Aspect.
getFixedForceAngle Get Fixed-Force-Direction.
getGraphValue time - Get Value from Graph.
getImageMapNameFrame Get ImageMap Name and Frame.
getIntenseParticles Get Intense-Particles Flag.
getLinkEmissionRotation Get Link-Emission-Rotation Flag.
getMaxTime Get Max-Value from Graph.
getMaxValue Get Max-Value from Graph.
getMinTime Get Min-Time from Graph.
getMinValue Get Min-Value from Graph.
getParticleOrientation Get Particle Orientation.
getPivotPoint Get Pivot-Point.
getRandomAngleOffset Get Random-Orientation Angle-Offset.
getRandomArc Get Random-Orientation Arc.
getSingleParticle Get Single-Particle Flag.
getTimeRepeat Get Time-Repeat for Graph.
getUseEffectEmission Get Use-Effect-Emission Flag.
getUsingAnimation Get Using Animation Flag.
getVisible Get the Emitters Visibility.
loadEmitter emitterFile$ - Loads a Particle Emitter.
removeDataKey keyIndex - Remove Data-Key from Graph.
saveEmitter emitterFile$ - Save a Particle Emitter.
selectGraph graphName - Select Graph Name.
setAlignAngleOffset alignAngleOffset - Set Align-Orientation Angle Offset.
setAlignKeepAligned keepAligned - Set Align-Orientation Keep-Aligned Flag.
setAnimationName animationName$ - Set the Animation.
setAttachPositionToEmitter attachPositionToEmitter - Set Attach-Position-To-Emitter Flag.
setAttachRotationToEmitter attachRotationToEmitter - Set Attach-Rotation-To-Emitter Flag.
setBlending blendStatus?, [srcBlendFactor], [dstBlendFactor] - Sets the Rendering Blend Options.
setDataKeyValue keyIndex, value - Set Data-Key Value in Graph.
setEmitterCollisionStatus Set the emitter collision status.
setEmitterName emitterName$ - Set the Emitters Name.
setEmitterType emitterType$ - Set Emitter Type.
setFirstInFrontOrder firstInFrontOrder - Set First-InFront-Order Flag.
setFixedAngleOffset randomAngle - Set Fixed-Orientation Angle-Offset.
setFixedAspect fixedAspect - Set Fixed-Aspect.
setFixedForceAngle fixedForceAngle - Set Fixed-Force Angle.
setImageMap imageMapName$, [int frame] - Set the ImageMap/Frame.
setIntenseParticles intenseParticles - Set Intense-Particles Flag.
setLinkEmissionRotation linkEmissionRotation - Set Link-Emission-Rotation Flag.
setParticleOrientationMode particleOrientationMode$ - Set Particle Orientation.
setPivotPoint pivotX / pivotY - Set the Pivot-Point.
setRandomAngleOffset randomAngle - Set Random-Orientation Angle-Offset.
setRandomArc randomArc - Set Random-Orientation Arc.
setSingleParticle singleParticle - Set Single-Particle Flag.
setTimeRepeat timeRepeat - Set Time-Repeat for Graph.
setUseEffectEmission useEffectEmission - Set Use-Effect-Emission Flag.
setVisible status? - Set the Emitters Visibility.
t2dSceneGraph SimSet
Methods
Name Arguments Description
addToScene t2dSceneObject - Add t2dSceneObject to Scene.
clearScene [deleteObjects?] - Clear Scene of all t2dSceneObject objects.
getConstantForce Gets the scene constant-force.
getSceneObject Gets the selected Scene Object.
getSceneObjectCount Gets the Scene Object-Count.
getSceneObjectList Gets the Scene Object-List.
getScenePause Gets scene pause status.
getScenePhysicsFPSActive Gets physics FPS Active status.
getScenePhysicsLimitFPS Gets physics limit FPS.
getScenePhysicsMaxIterations Gets physics maximum iterations.
getScenePhysicsTargetFPS Gets physics target FPS.
getSceneTime Gets the Scene Graph Time.
initialise containerBinSize, containerBinCount, useLayerSorting?, lastInFrontSorting? - Initialise Scene Graph.
loadScene file$ - Loads a Scene from a Disk File.
pickLine start x / y, end x / y, [groupMask], [layerMask], [showInvisible?], [excludeObject] - Picks objects intersecting line with optional group/layer masks.
pickPoint x / y, [groupMask], [layerMask], [showInvisible?], [excludeObject] - Picks objects intersecting point with optional group/layer masks.
pickRadius x / y, radius, [groupMask], [layerMask], [showInvisible?], [excludeObject] - Picks objects intersecting circle with optional group/layer masks.
pickRect start x / y, end x / y, [groupMask], [layerMask], [showInvisible?], [excludeObject] - Picks objects intersecting rectangle with optional group/layer masks.
removeFromScene t2dSceneObject - Remove t2dSceneObject from Scene.
saveScene file$ - Saves a Scene to a Disk File.
setConstantForce forceX / forceY, [gravitic?] - Apply a continuous force.
setConstantForcePolar angle, force, [gravitic?] - Apply a continuous polar force.
setDebugOff debugMask - Sets Debug Off Mode(s).
setDebugOn debugMask - Sets Debug On Mode(s).
setLayerDrawOrder t2dSceneObject, orderCommand$ - Sets the Layer Draw Order for Specified Object.
setSceneDrawOrder t2dSceneObject, orderCommand$ - Sets the Scene Draw Order for Specified Object.
setScenePause status - Sets scene pause status.
setScenePhysicsFPSActive status? - Sets physics FPS Active status.
setScenePhysicsLimitFPS fps - Sets physics limit FPS.
setScenePhysicsMaxIterations maxIterations - Sets physics maximum iterations.
setScenePhysicsTargetFPS fps - Sets physics target FPS.
stopConstantForce Stops any continuous force.
Fields
Name Desc
class string class
Config t2dBaseDatablock Config
superclass string superclass
t2dSceneGraphDatablock t2dBaseDatablock
Fields
Name Desc
containerBinCount int containerBinCount
containerBinSize float containerBinSize
lastInFrontSorting bool lastInFrontSorting
scenePhysicsFPSActive bool scenePhysicsFPSActive
scenePhysicsLimitFPS float scenePhysicsLimitFPS
scenePhysicsMaxIterations int scenePhysicsMaxIterations
scenePhysicsTargetFPS float scenePhysicsTargetFPS
useLayerSorting bool useLayerSorting
t2dSceneObject SimObject
Methods
Name Arguments Description
addLinkPoint [offsetX / offsetY] - Adds a Link-Point.
addToScene t2dSceneGraph - Add to SceneGraph.
applyFieldSelectedValues Update the object's properties to match the persistent fields.
attachGui guiObject, t2dSceneWindow, [sizeControl?] - Attach a GUI Control.
castCollision elapsedTime - Returns collision details for object over elapsed-time.
castCollisionList elapsedTime] - Returns list of objects collided with over elapsed-time.
clone copyFields? - Clone Object.
copy t2dSceneObject, [copyFields?] - Copies one object from another.
detachGui Detach any GUI Control.
dismount Dismounts object.
getAngularVelocity Gets Object Angular Velocity.
getArea Gets the current area.
getAreaMax Gets the current area maximum.
getAreaMin Gets the current area minimum.
getAtRest Gets whether the Object is at Rest.
getAutoMassInertia Gets Object Auto Mass/Inertia Mode.
getAutoMountRotation Gets the objects Auto Mount-Rotation.
getAutoRotation Gets the objects Auto-Rotation.
getBlendAlpha Gets the Rendering Alpha (transparency).
getBlendColor Gets the Rendering Blend Colour.
getBlendColour Gets the Rendering Blend Colour.
getBlending Gets the Rendering Blend Options.
getCollisionActive Gets the collision active directions.
getCollisionCallback Gets the collision callback status.
getCollisionCircleScale Gets the collision-circle Scale.
getCollisionDetection Get the Collision-Detection mode.
getCollisionMasks Gets the collision group/layer masks.
getCollisionMaxIterations Gets the Objects Maximum Collision Iterations
getCollisionPhysics Gets the collision physics directions.
getCollisionPoly Gets Collision Poly.
getCollisionPolyCount Gets Collision Poly Edge Count.
getCollisionPolyScale Gets the collision-polygon Scale.
getCollisionResponse Get the Collision-Response mode.
getCollisionSuppress Gets the collision suppress status.
getConstantForce Gets the objects constant-force.
getDamping Gets Object Damping.
getDensity Gets Object Density.
getEnabled Gets the objects enabled status.
getFlip Gets the Flip for each axis.
getForceScale Gets the objects force-scale.
getForwardMovementOnly Gets the object 'forward' movement only status.
getFriction Gets Object Friction.
getGraphGroup Gets the Objects Group.
getHeight Gets Objects Height.
getInertialMoment Gets Object Inertial Moment.
getIsChild Gets the objects Child status.
getIsMounted Get 'Is Mounted' Status.
getIsPointInObject X / Y - Returns whether point intersects with object.
getLayer Gets the Objects Layer.
getLifetime Gets the Objects Lifetime.
getLinearVelocity Gets Object Linear Velocity.
getLinearVelocityPolar Gets Objects Linear Velocity using Polar angle/speed.
getLinearVelocityX Gets Object Linear Velocity X.
getLinearVelocityY Gets Object Linear Velocity Y.
getLinkCount Gets the Link-Point Count.
getLinkPoint mountID - Gets a Link-Point.
getLocalPoint X / Y - Returns local-point for object.
getMass Gets Object Mass.
getMaxAngularVelocity Gets the Objects Max Angular Velocity.
getMaxLinearVelocity Gets the Objects Max Linear Velocity.
getMinAngularVelocity Gets the Objects Min Angular Velocity.
getMinLinearVelocity Gets the Objects Min Linear Velocity.
getMountedParent Get Parent we're mounted-to.
getMountRotation Gets the Mount Rotation.
getPhysicsSuppress Gets the Objects Physics Suppress Status.
getPosition Gets the current position.
getPositionX Gets Objects Position X-Component.
getPositionY Gets Objects Position Y-Component.
getRestitution Gets Object Restitution.
getRotation Gets the current rotation.
getSize Gets the objects size.
getSizeX Gets Objects Size X-Component.
getSizeY Gets Objects Size Y-Component.
getUseMouseEvents Gets whether mouses-events are monitored by this object.
getVisible Gets the objects visible status.
getWidth Gets Objects Width.
getWorldLimit Get the World Limit.
getWorldPoint X / Y - Returns world-point from object.
loadCopy objectFile$ - Loads a copy of the object from disk.
mount t2dSceneObject, [offsetX / offsetY], [mountForce], [trackRotation?], [sendToMount?], [ownedByMount?], [inheritAttributes?] - Mounts onto a specified object.
moveTo positionTarget, linearSpeed, [autoStop?], [callback?], [snap?], [targetMargin] - Moves-To/Sets the objects position-target.
removeAllLinkPoints Removes all Link-Points.
removeFromScene Remove from SceneGraph.
removeLinkPoint mountID - Removes a Link-Point.
rotateTo rotationTarget, angularSpeed, [autoStop?], [callback?], [snap?], [targetMargin] - Rotates-To/Sets the objects rotation-target.
safeDelete Safely deletes object.
saveCopy objectFile$ - Saves a copy of the object to disk.
setAngularVelocity Sets Objects Angular Velocity.
setArea x1 / y1 / x2 / y2 - Sets the objects area.
setAtRest Set Object at Rest.
setAutoMassInertia status? - Sets Auto Mass/Inertia Calculations.
setAutoMountRotation autoMountRotationSpeed - Sets the objects auto mount-rotation speed.
setAutoRotation autoRotationSpeed - Sets the objects auto-rotation speed.
setBlendAlpha alpha - Sets the Rendering Alpha (transparency).
setBlendColor blend R / G / B / [A] - Sets the Rendering Blend Color.
setBlendColour blend R / G / B / [A] - Sets the Rendering Blend Colour.
setBlending blendStatus?, [srcBlendFactor], [dstBlendFactor] - Sets the Rendering Blend Options.
setCollisionActive send, receive - Sets the collision check directions.
setCollisionAgainst t2dSceneObject, [clearMasks?] - Sets the collision masks against a specific object.
setCollisionCallback status? - Sets the collision callback status.
setCollisionCircleScale scale - Sets the collision-circle scale.
setCollisionCircleSuperscribed superscribeMode? - Sets the Collision-Circle superscribed mode.
setCollisionDetection detectionMode - Sets the Collision-Detection mode.
setCollisionGroups groups$ - Sets the collision group(s).
setCollisionLayers layers$ - Sets the collision layers(s).
setCollisionMasks groupMask, [layerMask] - Sets the collision masks.
setCollisionMaterial collisionMaterial - Sets Collision Material.
setCollisionMaxIterations iterations? - Sets the Objects Maximum Collision Iterations.
setCollisionPhysics send, receive - Sets the collision physics directions.
setCollisionPolyCustom poly-count, poly-Definition$ - Sets Custom Collision Polygon.
setCollisionPolyPrimitive poly-count - Sets Primitive Collision Polygon.
setCollisionPolyScale widthScale / [heightScale] - Sets the collision-polygon scale.
setCollisionResponse responseMode - Sets the Collision-Response mode.
setCollisionSuppress status? - Sets the collision suppress status.
setConstantForce forceX / forceY, [gravitic?] - Apply a continuous force.
setConstantForcePolar angle, force, [gravitic?] - Apply a continuous polar force.
setDamping damping - Set Objects Damping.
setDebugOff debugMask - Sets Debug Off Mask.
setDebugOn debugMode - Sets Debug On Mode(s).
setDensity density - Set Object Density.
setEnabled status? - Sets the objects enabled status.
setFlip flipX?, flipY? - Sets Flipping for each axis.
setForceScale Sets the objects force-scale.
setForwardMovementOnly forwardMovementOnly? - Sets the object to have 'forward' movement only.
setForwardSpeed forwardSpeed - Sets the object 'forward' speed.
setFriction friction - Set Object Friction.
setGraphGroup group - Sets the objects group (0-31).
setHeight Sets Objects Height.
setImmovable Set the Object Immovable.
setImpulseForce impulseForceX / impulseForceY, [gravitic?] - Apply an instantaneous force.
setImpulseForcePolar angle, force, [gravitic?] - Apply an instantaneous polar force.
setInertialMoment inertial Moment - Set Object Inertial Moment.
setLayer layer - Sets the objects layer (0-31).
setLifetime lifetime - Set Objects' Lifetime.
setLinearVelocity Sets Objects Linear Velocity.
setLinearVelocityPolar angle, speed - Sets Objects Linear Velocity using Polar-speed.
setLinearVelocityX Sets Objects Linear Velocity X-Component.
setLinearVelocityY Sets Objects Linear Velocity Y-Component.
setLinkPoint mountID, offsetX / offsetY - Sets a Link-Point Position.
setMass mass - Set Object Mass.
setMaxAngularVelocity maxAngularVelocity - Set Object Max Angular Velocity.
setMaxLinearVelocity maxLinearVelocity - Set Object Max Linear Velocity.
setMinAngularVelocity minAngularVelocity - Set Object Min Angular Velocity.
setMinLinearVelocity minLinearVelocity - Set Object Min Linear Velocity.
setMountRotation mountRotation - Sets the objects Mount rotation.
setPhysicsSuppress status? - Sets the Objects Physics Suppress Status.
setPosition x / y - Sets the objects position.
setPositionTarget positionTarget, [autoStop?], [callback?], [snap?], [targetMargin] - Sets the objects position-target.
setPositionTargetOff Removes the objects position-target.
setPositionX Sets Objects Position X-Component.
setPositionY Sets Objects Position Y-Component.
setRestitution restitution - Set Object Restitution.
setRotation rotation - Sets the objects rotation.
setRotationTarget rotationTarget, [autoStop?], [callback?], [snap?], [targetMargin] - Sets the objects rotation-target.
setRotationTargetOff Removes the objects rotation-target.
setSize width [/ height] - Sets the objects size.
setSizeX Sets Objects Size X-Component.
setSizeY Sets Objects Size Y-Component.
setTimerOff Stops the periodic timer for this object.
setTimerOn timePeriod - Starts a periodic timer for this object.
setUseMouseEvents mouseStatus - Sets whether mouses-events are monitored by this object.
setVisible status? - Sets the objects visible status.
setWidth Sets Objects Width.
setWorldLimit limitMode, [minX / minY / maxX / maxY], [callback?] - Set World Limit.
stopConstantForce Stops any continuous force.
updateFieldSelectedValues Update the persistent fields to match the object's properties.
Fields
Name Desc
angularVelocity float angularVelocity
autoMassInertia bool autoMassInertia
autoMountRotation float autoMountRotation
autoRotation float autoRotation
blendColor ColorF blendColor
blendingOn bool blendingOn
collisionActiveReceive bool collisionActiveReceive
collisionActiveSend bool collisionActiveSend
collisionCallback bool collisionCallback
collisionCircleScale float collisionCircleScale
collisionCircleSuperscribed bool collisionCircleSuperscribed
collisionDetectionMode enumval collisionDetectionMode
collisionGroups intList collisionGroups
collisionLayers intList collisionLayers
collisionPhysicsReceive bool collisionPhysicsReceive
collisionPhysicsSend bool collisionPhysicsSend
collisionPolyList point2FList collisionPolyList
collisionPolyScale Point2F collisionPolyScale
collisionResponseMode enumval collisionResponseMode
Config t2dBaseDatablock Config
constantForce Point2F constantForce
damping float damping
density float density
dstBlendFactor enumval dstBlendFactor
enabled bool enabled
flipX bool flipX
flipY bool flipY
forceScale float forceScale
forwardOnly bool forwardOnly
friction float friction
graviticConstantForce bool graviticConstantForce
group int group
immovable bool immovable
inertialMoment float inertialMoment
inheritAttributes bool inheritAttributes
layer int layer
lifetime float lifetime
linearVelocity Point2F linearVelocity
linkPointIDs intList linkPointIDs
linkPoints point2FList linkPoints
mass float mass
maxAngularVelocity float maxAngularVelocity
maxLinearVelocity float maxLinearVelocity
minAngularVelocity float minAngularVelocity
minlinearVelocity float minlinearVelocity
mountForce float mountForce
mountID int mountID
mountOffset Point2F mountOffset
mountRotation float mountRotation
mountToID int mountToID
mountToNode int mountToNode
ownedByMount bool ownedByMount
Position Point2F Position
restitution float restitution
rotation float rotation
scenegraph SimObjectPtr scenegraph
size Point2F size
srcBlendFactor enumval srcBlendFactor
trackRotation bool trackRotation
Visible bool Visible
worldLimitCallback bool worldLimitCallback
worldLimitMax Point2F worldLimitMax
worldLimitMin Point2F worldLimitMin
worldLimitMode enumval worldLimitMode
t2dSceneObjectDatablock t2dBaseDatablock
Fields
Name Desc
autoMountRotation float autoMountRotation
autoRotation float autoRotation
blendColor ColorF blendColor
Blending bool Blending
collisionActiveReceive bool collisionActiveReceive
collisionActiveSend bool collisionActiveSend
collisionCallback bool collisionCallback
collisionCircleScale float collisionCircleScale
collisionCircleSuperscribed bool collisionCircleSuperscribed
collisionDetectionMode enumval collisionDetectionMode
collisionGroupMask int collisionGroupMask
collisionLayerMask int collisionLayerMask
collisionPhysicsReceive bool collisionPhysicsReceive
collisionPhysicsSend bool collisionPhysicsSend
collisionPolyList point2FList collisionPolyList
collisionPolyScale Point2F collisionPolyScale
collisionResponseMode enumval collisionResponseMode
collisionSuppress bool collisionSuppress
constantForce Point2F constantForce
defaultClass caseString defaultClass
defaultNamespace caseString defaultNamespace
defaultScriptClass caseString defaultScriptClass
defaultScriptSuperclass caseString defaultScriptSuperclass
dstBlendFactor enumval dstBlendFactor
enabled bool enabled
flipX bool flipX
flipY bool flipY
graviticConstantForce bool graviticConstantForce
group int group
immovable bool immovable
layer int layer
lifetime float lifetime
maxAngularVelocity float maxAngularVelocity
maxLinearVelocity float maxLinearVelocity
minAngularVelocity float minAngularVelocity
minlinearVelocity float minlinearVelocity
mountRotation float mountRotation
Position Point2F Position
rotation float rotation
size Point2F size
srcBlendFactor enumval srcBlendFactor
useMouseEvents bool useMouseEvents
Visible bool Visible
worldLimitCallback bool worldLimitCallback
worldLimitMax Point2F worldLimitMax
worldLimitMin Point2F worldLimitMin
worldLimitMode enumval worldLimitMode
t2dSceneObjectGroup SimGroup
Methods
Name Arguments Description
updateFieldSelectedValues Updates the Group with object changes.
Fields
Name Desc
flipX bool flipX
flipY bool flipY
group int group
layer int layer
Position Point2F Position
rotation float rotation
size Point2F size
t2dSceneObjectSet SimSet
Methods
Name Arguments Description
updateFieldSelectedValues Updates the Set with object changes.
Fields
Name Desc
group int group
layer int layer
Position Point2F Position
rotation float rotation
size Point2F size
t2dSceneWindow GuiControl
Methods
Name Arguments Description
completeCameraMove Complete Camera Move.
dismount Dismounts Camera from object.
getCanvasPoint X / Y - Returns Canvas coordinate of Window coordinate.
getCurrentCameraArea Get current camera Area.
getCurrentCameraPosition Get current camera Position.
getCurrentCameraZoom Get current camera Zoom.
getIsCameraMounted Is Camera Mounted Status.
getIsCameraMoving Is Camera Moving Status.
getIsWindowPoint X / Y - Checks if World coordinate is inside Window.
getLockMouse Gets the window mouse-lock status.
getMousePosition Gets Current Mouse Position.
getUseObjectMouseEvents Gets whether mouses-events are monitored by the scene-objects.
getUseWindowMouseEvents Gets whether mouses-events are monitored by the window.
getWindowExtents Fetch Window Extents (Pos/Size).
getWindowPoint X / Y - Returns Window coordinate of World coordinate.
getWorldPoint X / Y - Returns World coordinate of Window coordinate.
mount t2dSceneObject, [offsetX / offsetY], [mountForce], [sendToMount?] - Mounts Camera onto a specified object.
resetSceneGraph Detaches the window from any t2dSceneGraph Object.
setCameraInterpolationMode interpolationMode - Set camera interpolation mode.
setCameraInterpolationTime interpolationTime - Set camera interpolation time.
setCurrentCameraArea x1 / y1 / x2 / y2 - Set current camera area.
setCurrentCameraPosition x / y / [width / height] - Set current camera position.
setCurrentCameraZoom zoomFactor - Set current camera Zoom Factor.
setDebugBanner fontName, fontSize, textR/G/B/[A]$, backgroundR/G/B/[A]$ - Set Debug Font/Size/textColour/backgroundColour
setLockMouse Sets the window mouse-lock status.
setMousePosition Sets Current Mouse Position.
setObjectMouseEventFilter groupMask, layerMask, [useInvisible?] - Sets Filter for Object Mouse-Events.
setObjectMouseEventGroupFilter groups$ - Sets the group filter.
setObjectMouseEventInvisibleFilter useInvisible - Sets the use invisible flag
setObjectMouseEventLayerFilter layers$ - Sets the layer filter.
setRenderGroups groups$ - Sets the render group(s).
setRenderLayers layers$ - Sets the render layers(s).
setRenderMasks layerMask, groupMask - Sets the layer/group mask which control what is rendered.
setSceneGraph t2dSceneGraph - Associates t2dSceneGraph Object.
setTargetCameraArea x / y / width / height - Set target camera area.
setTargetCameraPosition x / y / [width / height] - Set target camera position.
setTargetCameraZoom zoomFactor - Set target camera Zoom Factor.
setUseObjectMouseEvents mouseStatus - Sets whether mouses-events are monitored by the scene-Objects.
setUseWindowMouseEvents mouseStatus - Sets whether mouses-events are monitored by the window.
setViewLimitOff Set View Limit Off.
setViewLimitOn [minX / minY / maxX / maxY] - Set View Limit On.
startCameraMove [interpolationTime] - Start Camera Move.
startCameraShake shakeMagnitude, time - Starts the camera shaking.
stopCameraMove Stop Camera Move.
stopCameraShake Stops the camera shaking.
undoCameraMove [interpolationTime] - Undo Camera Move.
Fields
Name Desc
lockMouse bool lockMouse
useObjectMouseEvents bool useObjectMouseEvents
useWindowMouseEvents bool useWindowMouseEvents
t2dScroller t2dSceneObject
Methods
Name Arguments Description
setImageMap imageMapName$ - Sets the imageMap Name.
setRepeat repeatX / repeatY - Sets the Repeat X/Y repetition.
setScroll offsetX / offsetY - Sets the Scroll speed.
setScrollPolar angle, scrollSpeed - Sets Auto-Pan Polarwise.
setScrollPosition positionX / positionY - Sets the Scroll position X/Y.
Fields
Name Desc
imageMap string imageMap
panPositionX float panPositionX
panPositionY float panPositionY
repeatX float repeatX
repeatY float repeatY
scrollX float scrollX
scrollY float scrollY
t2dScrollerDatablock t2dSceneObjectDatablock
Fields
Name Desc
imageMap t2dImageMapDatablock imageMap
repeatX float repeatX
repeatY float repeatY
scrollX float scrollX
scrollY float scrollY
t2dShape3D t2dSceneObject
Methods
Name Arguments Description
getCurrentDetailLevel Get Detail Level.
getCurrentIntraDetailLevel Get Intra-Detail-Level.
getDetailLevelCount Get Detail Level Count.
playAnimation animationName, [startTime], [transitionTime] - Plays an Animation by Sequence Name.
playAnimationSequence sequence, [startTime], [transitionTime] - Plays an Animation by Sequence Index.
setDetailLevel detailLevel, [intraDetail] - Sets Current Detail Level.
setShape shapeFile$ - Loads a shape into the object.
setShapeAngularVelocity x / y / z - Sets Shape Angular Velocity.
setShapeOffset x / y / z - Sets Shape Offset.
setShapeRotation x / y / z - Sets Shape Rotation
setShapeScale x [/ y / z] - Sets Shape Offset.
setSkin skinSet$, skinName$ - Changes the skin to the specified texture
setTimeScale timeScale - Set the animation time-scale.
setTriggerActive status - Sets Trigger Status.
Fields
Name Desc
shapeAngularVelocity Point3F shapeAngularVelocity
shapeFile string shapeFile
shapeOffset Point3F shapeOffset
shapeRotation Point3F shapeRotation
shapeScale Point3F shapeScale
t2dShapeVector t2dSceneObject
Methods
Name Arguments Description
setFillAlpha alpha - Sets the Rendering Fill Alpha (transparency).
setFillColor R / G / B / [A] - Sets the Rendering Fill Color.
setFillColour R / G / B / [A] - Sets the Rendering Fill Colour.
setFillMode fillMode? - Sets the Rendering Fill Mode.
setLineAlpha alpha - Sets the Rendering Line Alpha (transparency).
setLineColor R / G / B / [A] - Sets the Rendering Line Color.
setLineColour R / G / B / [A] - Sets the Rendering Line Colour.
setPolyCustom poly-count, poly-Definition$ - Sets Custom Polygon.
setPolyPrimitive vertexCount - Sets a regular polygon primitive.
setPolyScale widthScale / [heightScale] - Sets the polygon scale.
Fields
Name Desc
fillColor ColorF fillColor
fillMode bool fillMode
lineColor ColorF lineColor
vertexList point2FList vertexList
t2dStaticSprite t2dSceneObject
Methods
Name Arguments Description
getFrame Gets current imageMap Frame.
getImageMap Gets current imageMap name.
setFrame frame - Sets imageMap frame.
setImageMap imageMapName$, [int frame] - Sets imageMap/Frame.
Fields
Name Desc
frame int frame
imageMap string imageMap
t2dStaticSpriteDatablock t2dSceneObjectDatablock
Fields
Name Desc
frame int frame
imageMap t2dImageMapDatablock imageMap
t2dTestTile t2dActiveTile
t2dTestTileDatablock t2dActiveTileDatablock
t2dTextObject t2dSceneObject
Methods
Name Arguments Description
setBannerColor R/G/B/A - Sets the banner color (set alpha to 0 to disable).
setBorderColor R/G/B/A - Sets the border color (set alpha to 0 to disable).
setFont name - Sets the font.
setFontColor R/G/B/A - Sets the font color.
setSize name - Sets the font size.
setText text - Sets the string to display.
t2dTileLayer t2dSceneObject
Methods
Name Arguments Description
clearLayer - Deletes All Layer Tiles.
clearTile tileX / tileY - Clears a Tile.
getTileCollision x / y - Gets a tile collision options.
getTileCount Gets Tile Count.
getTileCustomData x / y - Gets a tile custom-data.
getTileFlip x / y - Gets a tile flip options.
getTileScript x / y - Gets a tile script.
getTileScriptActioned x / y - Gets a tile script actioned-flag.
getTileSize Gets Tile Size.
getTileType x / y - Gets a tile type.
loadTileLayer tileLayerFile$ - Loads a Tile-Layer File.
pickTile x / y - Picks Tile from world position.
resetLayer Resets dynamic properties of the Tile-Layer.
resizeLayer newTileCountX / newTileCountY - Resize Tile Layer.
saveTileLayer tileLayerFile$ - Saves a Tile-Layer File.
setActiveTile tileX / tileY, activeTileClass, [activeTileDatablockName] - Sets an Active Tile.
setAnimatedTile tileX / tileY, animationName, [forceUnique] - Sets an Animated Tile.
setAutoPan autoPanX / autoPanY - Sets Auto-Pan.
setAutoPanPolar angle, panSpeed - Sets Auto-Pan Polarwise.
setCursorIconActive status, blinkTime - Set cursor-icon status.
setCursorPosition x / y - Set cursor positiom.
setCustomIconActive status - Set custom-data-icon status.
setGridActive status - Set grid-lines status.
setPanPosition panX / panY - Sets Pan Position.
setScriptIconActive status - Set script-icon status.
setStaticTile tileX / tileY, imageMapName, [frame] - Sets a Static Tile.
setTileCollisionActive tileX / tileY, receiveCollision - Sets Tile Receive Collisions.
setTileCollisionPolyCustom tileX / tileY, poly-count, poly-Definition$ - Sets Tile Custom Collision Polygon.
setTileCollisionPolyPrimitive tileX / tileY, poly-count - Sets Tile Primitive Collision Polygon.
setTileCollisionScale tileX / tileY, widthScale / [heightScale] - Sets Tile collision scale.
setTileCustomData tileX / tileY, data - Sets custom data on a Tile.
setTileFlip tileX / tileY, flipHorz, flipVert - Sets Tile Flipping.
setTileIcons tileIconImageMap - Set tile-icons imagemap.
setTileScript tileX / tileY, script - Sets a Script on a Tile.
setTileSize tileSizeX / [tileSizeY] - Sets Tile Size.
setWrap wrapX, wrapY - Sets Wrap Options.
Fields
Name Desc
autoPanX float autoPanX
autoPanY float autoPanY
panPositionX float panPositionX
panPositionY float panPositionY
wrapX bool wrapX
wrapY bool wrapY
t2dTileMap t2dSceneObject
Methods
Name Arguments Description
createTileLayer tileCountX / tileCountY / tileSizeX / tileSizeY - Creates a Tile Layer.
deleteAllLayers Deletes all Tile Layer(s).
deleteTileLayer layerIndex - Deletes a Tile Layer.
deleteTileLayerId tileLayerID - Deletes a Tile Layer (by Id).
getTileLayer layerIndex - Returns Tile Layer by Index.
getTileLayerCount Returns Tile Layer Count.
loadTileMap tileMapFile$ - Loads a Tilemap File.
loadTileMapDataBlock tileMapDatablock$ - Loads a Tilemap from a Datablock.
saveTileMap tileMapFile$ - Saves a Tilemap File.
setAllLayersToParent Synchronizes all tile-layers to parents position/size/rotation.
Fields
Name Desc
tilemapFile filename tilemapFile
t2dTileMapDatablock t2dSceneObjectDatablock
Fields
Name Desc
tilemapFile filename tilemapFile
t2dTrigger t2dSceneObject
Methods
Name Arguments
setEnterCallback true
setLeaveCallback true
setStayCallback true
Fields
Name Desc
enterCallback bool enterCallback
leaveCallback bool leaveCallback
stayCallback bool stayCallback
t2dTriggerDatablock t2dSceneObjectDatablock
Fields
Name Desc
enterCallback bool enterCallback
leaveCallback bool leaveCallback
stayCallback bool stayCallback
TCPObject SimObject
Methods
Name Arguments Description
connect string addr Connect to the given address.
disconnect Disconnect from whatever we're connected to, if anything.
listen int port Start listening on the specified ports for connections.
send ... Parameters are transmitted as strings, one at a time.
TextChunk SimChunk
Fields
Name Desc
textData string textData
TSShapeConstructor SimDataBlock
Fields
Name Desc
baseShape filename baseShape
sequence0 filename sequence0
sequence1 filename sequence1
sequence10 filename sequence10
sequence100 filename sequence100
sequence101 filename sequence101
sequence102 filename sequence102
sequence103 filename sequence103
sequence104 filename sequence104
sequence105 filename sequence105
sequence106 filename sequence106
sequence107 filename sequence107
sequence108 filename sequence108
sequence109 filename sequence109
sequence11 filename sequence11
sequence110 filename sequence110
sequence111 filename sequence111
sequence112 filename sequence112
sequence113 filename sequence113
sequence114 filename sequence114
sequence115 filename sequence115
sequence116 filename sequence116
sequence117 filename sequence117
sequence118 filename sequence118
sequence119 filename sequence119
sequence12 filename sequence12
sequence120 filename sequence120
sequence121 filename sequence121
sequence122 filename sequence122
sequence123 filename sequence123
sequence124 filename sequence124
sequence125 filename sequence125
sequence126 filename sequence126
sequence13 filename sequence13
sequence14 filename sequence14
sequence15 filename sequence15
sequence16 filename sequence16
sequence17 filename sequence17
sequence18 filename sequence18
sequence19 filename sequence19
sequence2 filename sequence2
sequence20 filename sequence20
sequence21 filename sequence21
sequence22 filename sequence22
sequence23 filename sequence23
sequence24 filename sequence24
sequence25 filename sequence25
sequence26 filename sequence26
sequence27 filename sequence27
sequence28 filename sequence28
sequence29 filename sequence29
sequence3 filename sequence3
sequence30 filename sequence30
sequence31 filename sequence31
sequence32 filename sequence32
sequence33 filename sequence33
sequence34 filename sequence34
sequence35 filename sequence35
sequence36 filename sequence36
sequence37 filename sequence37
sequence38 filename sequence38
sequence39 filename sequence39
sequence4 filename sequence4
sequence40 filename sequence40
sequence41 filename sequence41
sequence42 filename sequence42
sequence43 filename sequence43
sequence44 filename sequence44
sequence45 filename sequence45
sequence46 filename sequence46
sequence47 filename sequence47
sequence48 filename sequence48
sequence49 filename sequence49
sequence5 filename sequence5
sequence50 filename sequence50
sequence51 filename sequence51
sequence52 filename sequence52
sequence53 filename sequence53
sequence54 filename sequence54
sequence55 filename sequence55
sequence56 filename sequence56
sequence57 filename sequence57
sequence58 filename sequence58
sequence59 filename sequence59
sequence6 filename sequence6
sequence60 filename sequence60
sequence61 filename sequence61
sequence62 filename sequence62
sequence63 filename sequence63
sequence64 filename sequence64
sequence65 filename sequence65
sequence66 filename sequence66
sequence67 filename sequence67
sequence68 filename sequence68
sequence69 filename sequence69
sequence7 filename sequence7
sequence70 filename sequence70
sequence71 filename sequence71
sequence72 filename sequence72
sequence73 filename sequence73
sequence74 filename sequence74
sequence75 filename sequence75
sequence76 filename sequence76
sequence77 filename sequence77
sequence78 filename sequence78
sequence79 filename sequence79
sequence8 filename sequence8
sequence80 filename sequence80
sequence81 filename sequence81
sequence82 filename sequence82
sequence83 filename sequence83
sequence84 filename sequence84
sequence85 filename sequence85
sequence86 filename sequence86
sequence87 filename sequence87
sequence88 filename sequence88
sequence89 filename sequence89
sequence9 filename sequence9
sequence90 filename sequence90
sequence91 filename sequence91
sequence92 filename sequence92
sequence93 filename sequence93
sequence94 filename sequence94
sequence95 filename sequence95
sequence96 filename sequence96
sequence97 filename sequence97
sequence98 filename sequence98
sequence99 filename sequence99
UnknownChunk SimChunk
Functions
Name Arguments Description
activateDirectInput Activate input. (ie, grab the mouse again so the user can play our game.
activateKeyboard
activatePackage packageName
addCardProfile 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 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.
addMaterialMapping string matName, ... Set up a material mapping. See MaterialPropertyMap for details.
addOSCardProfile string vendor, string renderer, bool allowOpenGL, bool allowD3D, bool preferOpenGL Register with the profile manager what rendering mode is preferred with the specified card.
addTaggedString string str
alGetListener3f Alenum
alGetListeneri Alenum
alGetString string item This wraps alGetString().
alListener3f ALenum, "x y z" or alListener3f(ALenum, x, y, z)
allowConnections bool
alxCreateSource profile or (profile, x,y,z) or (description, filename) or (description, filename, x,y,z)
alxGetChannelVolume int channel_id @param channel_id ID of channel to fetch volume from. @return Volume of channel.
alxGetListenerf Alenum
alxGetSource3f handle, ALenum
alxGetSourcef handle, ALenum
alxGetSourcei handle, ALenum
alxGetStreamDuration handle
alxGetStreamPosition handle
alxGetWaveLen string filename @param filename File to determine length of. @returns Length in milliseconds.
alxIsPlaying handle
alxListenerf alxListener(ALenum, value)
alxPause handle
alxPauseAll
alxPlay handle or alxPlay(profile) or alxPlay(profile, x,y,z)
alxSetChannelVolume int channel_id, float volume @param channel_id ID of channel to set volume on. @param volume New volume of channel, from 0.0f-1.0f
alxSource3f handle, ALenum, x, y, z @note You can replace the last three parameters with a string, "x y z"
alxSourcef handle, ALenum, value
alxSourcei handle, ALenum, value
alxStop int handle
alxStopAll
alxUnpause handle
alxUnpauseAll
backtrace Print the call stack.
bit Converts a bit-position into a value.
bits Converts a list of bit-positions into a value.
buildTaggedString string format, ...
call funcName [,args ...]
cancel eventId
cancelAllEvents
cancelServerQuery
clearTextureHolds
cls Clear the screen.
collapseEscape text
commandToClient NetConnection client, string func, ...
commandToServer string func, ... Send a command to the server.
compile fileName
createCanvas string windowTitle Create the game window/canvas, with the specified window title.
createEffectCanvas string windowTitle Create the game window/canvas, with the specified window title.
createPath "file name or path name"
dbgSetParameters int port, string password, bool waitForClient Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect.
deactivateDirectInput Deactivate input. (ie, ungrab the mouse so the user can do other things.
deactivateKeyboard
deactivatePackage packageName
deleteDataBlocks Delete all the datablocks we've downloaded. 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.
deleteVariables wildCard
detag textTagString
disableJoystick
disableMouse
DNetSetLogging bool enabled
dumpConsoleClasses dumps all declared console classes to the console.
dumpConsoleFunctions dumps all declared console functions to the console.
dumpFontCacheStatus - Return a full description of all cached fonts, along with info on the codepoints each contains.
duplicateCachedFont oldFontName, oldFontSize, newFontName -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.
echo text [, ... ]
echoInputState
enableJoystick
enableMouse
enableWinConsole bool
error text [, ... ]
eval consoleString
exec fileName [, nocalls [,journalScript]]
expandEscape text
expandFilename string filename
export searchString [, fileName [,append]]
exportCachedFont fontName, size, fileName, padding, kerning - 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.
fileBase fileName
fileDelete 'path'
fileExt fileName
fileName filePathName
filePath fileName
fileSize fileName returns filesize or -1 if no file
findFirstFile string pattern Returns the first file in the directory system matching the given pattern.
findNextFile string pattern Returns the next file matching a search begun in findFirstFile.
firstWord text
flushTextureCache Flush the texture cache.
FreeMemoryDump
getBoxCenter Box b Get the center point of a box.
getBuildString Get the type of build, "Debug" or "Release".
getClipboard Get text from the clipboard.
getCompileTimeString Get the time of compilation.
getCoreLangTable
getDesktopResolution Get the width, height, and bitdepth of the screen.
getDisplayDeviceList
getEventTimeLeft scheduleId Get the time left in ms until this event will trigger.
getExecutableName
getField text, index
getFieldCount text
getFields text, index [,endIndex]
getFileCount string pattern returns the number of files in the directory tree that match the given pattern
getFileCRC filename
getJoystickAxes instance
getModPaths Return the mod paths the resource manager is using.
getRandom int a=1, int b=0 Get a random number between a and b.
getRandomSeed Return the current random seed.
getRealTime Return the current real time in milliseconds. Real time is platform defined; typically time since the computer booted.
getRecord text, index
getRecordCount text
getRecords text, index [,endIndex]
getRes Get the width, height, and bitdepth of the screen.
getResolutionList
getScheduleDuration %scheduleId
getServerCount
getSimTime Return the current sim time in milliseconds. Sim time is time since the game started.
getSubStr string str, int start, int numChars Returns the substring of str, starting at start, and continuing to either the end of the string, or numChars characters, whichever comes first.
getT2DDatablockSet Retrieves the datablock-set for T2D.
getT2DMaxTextureSize Returns the maximum texture size supported by the current hardware.
getT2DVersion Returns T2D Version
getTag textTagString
getTaggedString int tag
getTimeSinceStart %scheduleId
getVersionNumber Get the version of the build, as a string.
getVersionString Get the version of the build, as a string.
getVideoDriverInfo
getWord string text, int index
getWordCount text
getWords string text, int index, int endIndex=INF
getWorkingDirectory
GLEnableMetrics bool
GLEnableOutline bool
gotoWebPage address - Open a web page in the user's favorite web browser.
importCachedFont fontName, size, fileName, padding, kerning - Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont.
isDebugBuild - Returns true if the script is running in a debug Torque executable
isDeviceFullScreenOnly string deviceName
isEventPending %scheduleId
isFile fileName
isFullScreen Is the game running full-screen?
isJoystickDetected
isKoreanBuild
isObject object
isPackage packageName
isWriteableFileName fileName
loadChunkFile Filename file Read a chunk hierarchy from a file.
lockMouse bool isLocked Lock the mouse (or not, depending on the argument's value) to the window.
ltrim string value
mAbs float v Returns the absolute value of the argument.
mAcos float th Returns the arc-cosine of th, which is in radians.
mAsin float th Returns the arc-sine of th, which is in radians.
mAtan float rise, float run Returns the slope in radians (the arc-tangent) of a line with the given rise and run.
mathInit ... Install the math library with specified extensions. Possible parameters are: - 'DETECT' Autodetect math lib settings. - 'C' Enable the C math routines. C routines are always enabled. - 'FPU' Enable floating point unit routines. - 'MMX' Enable MMX math routines. - '3DNOW' Enable 3dNow! math routines. - 'SSE' Enable SSE math routines.
MatrixCreate Vector3F pos, Vector3F rot Create a matrix representing the given translation and rotation.
MatrixCreateFromEuler Vector3F e Create a matrix from the given rotations.
MatrixMulPoint MatrixF xfrm, Point3F pnt Multiply pnt by xfrm.
MatrixMultiply Matrix4F left, Matrix4F right Multiply the two matrices.
MatrixMulVector MatrixF xfrm, Point3F vector Multiply the vector by the transform.
mCeil float v Round v up to the nearest whole number.
mCos float th Returns the cosine of th, which is in radians.
mDegToRad float degrees Convert a measure in degrees to radians.
mFloatLength float v, int numDecimals Return a string containing v formatted with the specified number of decimal places.
mFloor float v Round v down to the nearest whole number.
minimizeWindow - Minimize the game window
mLog float v Returns the natural logarithm of the argument.
mPow float b, float p Returns the b raised to the pth power.
mRadToDeg float radians Converts a measure in radians to degrees.
msg NetConnection id, string message Send a SimpleNetObject message to the specified connection.
mSin float th Returns the sine of th, which is in radians.
mSolveCubic float a, float b, float c, float d 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.
mSolveQuadratic float a, float b, float c 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.
mSolveQuartic float a, float b, float c, float d, float e 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.
mSqrt float v Returns the square root of the argument.
mTan float th Returns the tangent of th, which is in radians.
nameToID object
nextResolution Switch to next resolution.
NextToken nextToken(str,token,delim)
OpenALInitDriver Initializes the OpenAL driver. @note You must call this before any sounds will work!
OpenALRegisterExtensions
OpenALShutdownDriver
ord chartoconvert
pathCopy fromFile, toFile [, nooverwrite = true]
playJournal string filename, bool break=false Begin playback of a journal from a specified field, optionally breaking at the start.
png2jpg pngName,[quality=0-100]
populateAllFontCacheRange rangeStart, rangeEnd - 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.
populateAllFontCacheString string - Populate the font cache for all fonts with characters from the specified string.
populateFontCacheRange faceName, size, rangeStart, rangeEnd - 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.
populateFontCacheString faceName, size, string - Populate the font cache for the specified font with characters from the specified string.
prevResolution Switch to previous resolution.
profilerDump Dump the current state of the profiler.
profilerDumpToFile string filename Dump profiling stats to a file.
profilerEnable bool enable
profilerMarkerEnable string markerName, bool enable
profilerReset Resets the profiler, clearing all of its data.
purgeResources Purge resources from the resource manager.
queryLanServers ...
queryMasterServer ...
querySingleServer address, flags
quit End execution of Torque.
quitWithErrorMessage msg - Quit, showing the provided error message. This is equivalent to an AssertISV.
redbookClose Close the current Redbook device.
redbookGetDeviceCount get the number of redbook devices.
redbookGetDeviceName int index Get name of specified Redbook device.
redbookGetLastError Get a string explaining the last redbook error.
redbookGetTrackCount Return the number of tracks.
redbookGetVolume Get the volume.
redbookOpen string device=NULL
redbookPlay int track Play the selected track.
redbookSetVolume float volume Set playback volume.
redbookStop Stop playing.
removeField text, index
removeRecord text, index
removeTaggedString int tag
removeWord text, index
restWords text
rtrim string value
saveChunkFile SimChunk chunk, Filename file Write a chunk hierarchy to a file.
saveJournal string filename Save the journal to the specified file.
schedule time, refobject|0, command, <arg1...argN>
screenShot string file, string format Take a screenshot. @param format One of JPEG or PNG.
setCanvasTitle string windowTitle
setClipboard string text Set the system clipboard.
setCoreLangTable LangTable
setDisplayDevice string deviceName, int width, int height=NULL, int bpp=NULL, bool fullScreen=NULL Attempt to set the screen mode using as much information as is provided.
setEchoFileLoads bool
setField text, index, replace
setLogMode mode
setModPaths string paths Set the mod paths the resource manager is using. These are semicolon delimited.
setNetPort int port Set the network port for the game to use.
setOpenGLAnisotropy 0-1
setOpenGLInteriorMipReduction 0-5
setOpenGLMipReduction n Sets mipmap reduction level, n ranges from 0-5.
setOpenGLSkyMipReduction 0-5
setOpenGLTextureCompressionHint setTextureCompressionHint(GL_DONT_CARE|GL_FASTEST|GL_NICEST);
setRandomSeed int seed=-1 Set the current random seed. If no seed is provided, then the current time in ms is used.
setRecord text, index, replace
setRes int width, int height, int bpp=NULL
setScreenMode int width, int height, int bpp, bool fullScreen
setServerInfo index
setVerticalSync bool f
setWord text, index, replace
startHeartbeat
stopHeartbeat
stopServerQuery
strchr string,char
strcmp string one, string two Case sensitive string compare.
stricmp string one, string two Case insensitive string compare.
stripChars string value, string chars Remove all the characters in chars from value.
stripColorCodes stringtoStrip - remove TorqueML color codes from the string.
StripMLControlChars string val Strip TorqueML control characters from the specified string, returning a 'clean' version.
stripTrailingSpaces string
strlen string str Calculate the length of a string in characters.
strlwr string Convert string to lower case.
strpos string hay, string needle, int offset=0 Find needle in hay, starting offset bytes in.
strreplace string source, string from, string to
strstr string one, string two Returns the start of the sub string two in one or -1 if not found.
strupr string Convert string to upper case.
switchBitDepth Switch between 16 or 32 bits. Only works in full screen.
t2dAngleBetween t2dVector v1$, t2dVector v2$ - Returns the angle between v1 and v2.
t2dAssert condition, message - Fatal Script Assertion
t2dAssertISV condition, message - Fatal ISV Script Assertion
t2dBeginScene Sets the default Scene Graph.
t2dEndScene Resets the default Scene Graph.
t2dGetMax a, b - Returns the Maximum of two values.
t2dGetMin a, b - Returns the Minimum of two values.
t2dRectNormalise t2dVector v1$, t2dVector v2$ - Returns normalise rectangle of v1 and v2.
t2dVectorAdd t2dVector v1$, t2dVector v2$ - Returns v1+v2.
t2dVectorCompare t2dVector p1$, t2dVector p2$, [epsilon] - Compares points p1 and p2 with optional difference (epsilon).
t2dVectorDistance t2dVector p1$, t2dVector p2$ - Returns the distance between points p1 and p2.
t2dVectorDot t2dVector v1$, t2dVector v2$ - Returns dot-product of v1 and v2.
t2dVectorLength t2dVector v1$ - Returns the length of v1.
t2dVectorMult t2dVector v1$, t2dVector v2$ - Returns v1 mult v2.
t2dVectorNormalise t2dVector v1$ - Returns normalised v1.
t2dVectorScale t2dVector v1$, scale - Returns v1 scaled by scale.
t2dVectorSub t2dVector v1$, t2dVector v2$ - Returns v1-v2.
telnetSetParameters int port, string consolePass, string listenPass 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.
toggleFullScreen
trace bool
trim string
VectorAdd Vector3F a, Vector3F b Returns a+b.
VectorCross Vector3F a, Vector3F b Calculate the cross product of a and b.
VectorDist Vector3F a, Vector3F b Calculate the distance between a and b.
VectorDot Vector3F a, Vector3F b Calculate the dot product of a and b.
VectorLen Vector3F v Calculate the length of a vector.
VectorNormalize Vector3F a Returns a scaled such that length(a) = 1.
VectorOrthoBasis AngAxisF aaf Create an orthogonal basis from the given vector. Return a matrix.
VectorScale Vector3F a, float scalar Returns a scaled by scalar (ie, a*scalar).
VectorSub Vector3F a, Vector3F b Returns a-b.
videoSetGammaCorrection setGammaCorrection(gamma);
warn text [, ... ]
writeFontCache - force all cached fonts toserialize themselves to the cache.