Hierarchy:
-
Classes
- ActionMap
SimObject
-
Methods
- 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
- coneInsideAngle
- coneOutsideAngle
- coneOutsideVolume
- coneVector
- environmentLevel
- is3D
- isLooping
- isStreaming
- loopCount
- maxDistance
- maxLoopGap
- minLoopGap
- referenceDistance
- type
- volume
- AudioEnvironment
SimDataBlock
Fields
- airAbsorption
- Damping
- decayHFRatio
- decayTime
- effectVolume
- environmentDiffusion
- float environmentDiffusion
- environmentSize
- flags
- reflections
- reflectionsDelay
- reverb
- reverbDelay
- room
- roomHF
- roomRolloffFactor
- roomVolume
- useRoom
- AudioProfile
SimDataBlock
Fields
- description
- AudioDescription description
- environment
- AudioSampleEnvironment environment
- fileName
- preload
- AudioSampleEnvironment
SimDataBlock
Fields
- airAbsorption
- direct
- directHF
- flags
- obstruction
- obstructionLFRatio
- occlusion
- occlusionLFRatio
- occlusionRoomRatio
- outsideVolumeHF
- room
- roomRolloff
- BanList
SimObject
-
Methods
- 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
- attach()
- Attaches this object to the console and begins logging
- detach()
- Detaches this object from the console and stops logging
Fields
- DbgFileView
GuiArrayCtrl
-
Methods
- 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
- close()
- 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, object prepend)
- GameConnection
NetConnection
-
Methods
- 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
- GuiAutoScrollCtrl
GuiTickCtrl
Fields
- childBorder
- resetDelay
- scrollSpeed
- startDelay
- tickCallback
- GuiAviBitmapCtrl
GuiControl
- GuiBackgroundCtrl
GuiControl
- GuiBitmapBorderCtrl
GuiControl
- GuiBitmapButtonCtrl
GuiButtonCtrl
- GuiBitmapButtonTextCtrl
GuiBitmapButtonCtrl
- GuiBitmapCtrl
GuiControl
-
Methods
- 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
- GuiBorderButtonCtrl
GuiButtonBaseCtrl
- GuiBubbleTextCtrl
GuiTextCtrl
- GuiButtonBaseCtrl
GuiControl
-
Methods
- 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
- buttonType
- groupNum
- text
- textID
- GuiButtonCtrl
GuiButtonBaseCtrl
- GuiCanvas
GuiControl
-
Methods
- cursorOff()
- cursorOn()
- getContent()
- Get the GuiControl which is being used as the content.
- getCursorPos()
- Get the current position of the cursor.
- getMouseControl()
- Gets the gui control under the mouse.
- hideCursor()
- isCursorOn()
- popDialog(GuiControl ctrl=NULL)
- popLayer(int layer)
- pushDialog(GuiControl ctrl, int layer)
- renderFront(bool enable)
- repaint()
- 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
- setBitmap(string filename)
- Set the bitmap contained in this control.
Fields
- GuiColorPickerCtrl
GuiControl
-
Methods
- getSelectorPos()
- Gets the current position of the selector
- setSelectorPos()
- Sets the current position of the selector
- updateColor()
- Forces update of pick color
Fields
- ActionOnMove
- BaseColor
- DisplayMode
- PickColor
- SelectorGap
- GuiConsole
GuiArrayCtrl
- GuiConsoleEditCtrl
GuiTextEditCtrl
- GuiConsoleTextCtrl
GuiControl
- GuiControl
SimGroup
-
Methods
- addGuiControl()
- getCenter()
- returns center of control, as space seperated ints
- getExtent()
- Get the width and height of the control.
- getGlobalCenter()
- returns center of control, as space seperated ints
- getGlobalPosition()
- 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)
- setCanSave()
- Sets whether this control can serialize itself to the hard disk
- setCenter()
- sets control position, by center - coords are local not global
- setExtent()
- sets the width & height of the control.
- setFirstResponder()
- Sets this control as the first responder
- setPosition()
- setPositionGlobal()
- int x,y in global screen space
- setProfile(GuiControlProfile p)
- setValue(string value)
- setVisible(bool visible)
Fields
- Accelerator
- AltCommand
- canSave
- class
- Command
- Extent
- HorizSizing
- hovertime
- langTableMod
- MinExtent
- Modal
- @deprecated This member is deprecated, which means that its value is always undefined.
- position
- Profile
- setFirstResponder
- @deprecated This member is deprecated, which means that its value is always undefined.
- superclass
- Script SuperClass of object.
- tooltip
- tooltipprofile
- GuiProfile tooltipprofile
- Variable
- VertSizing
- Visible
- GuiControlArrayControl
GuiControl
Fields
- colCount
- colSizes
- colSpacing
- rowSize
- rowSpacing
- GuiControlProfile
SimObject
Fields
- autoSizeHeight
- autoSizeWidth
- bevelColorHL
- bevelColorLL
- bitmap
- border
- borderColor
- borderColorHL
- borderColorNA
- borderThickness
- canKeyFocus
- cursorColor
- fillColor
- fillColorHL
- fillColorNA
- fontCharset
- fontColor
- fontColorHL
- fontColorLink
- fontColorLinkHL
- fontColorNA
- fontColors
- fontColorSEL
- fontSize
- fontType
- justify
- Modal
- mouseOverSelected
- numbersOnly
- opaque
- profileForChildren
- SimObjectPtr profileForChildren
- returnTab
- soundButtonDown
- AudioProfile soundButtonDown
- soundButtonOver
- AudioProfile soundButtonOver
- tab
- textOffset
- GuiCursor
SimObject
Fields
- bitmapName
- hotSpot
- renderOffset
- GuiDirectoryFileListCtrl
GuiListBoxCtrl
-
Methods
- getSelectedFile()
- - returns the currently selected file name
- getSelectedFiles()
- - returns a word separated list of selected file(s)
- setFilter([mask space delimited])
- setPath(path,filter)
- - directory to enumerate files from (without trailing slash)
- GuiDirectoryTreeCtrl
GuiTreeViewCtrl
-
Methods
- getSelectedPath()
- - returns the currently selected path in the tree
- setSelectedPath(path)
- - expands the tree to the specified path
- GuiDragAndDropControl
GuiControl
- GuiDynamicCtrlArrayControl
GuiControl
-
Methods
- refresh()
- Forces the child controls to recalculate
Fields
- colCount
- colSize
- colSpacing
- rowSize
- rowSpacing
- GuiEditCtrl
GuiControl
-
Methods
- addNewCtrl(GuiControl ctrl)
- addSelection()
- 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()
- saveSelection(string fileName)
- select(GuiControl ctrl)
- selectAll()
- setCurrentAddSet(GuiControl ctrl)
- setRoot(GuiControl root)
- toggle()
- GuiEditorRuler
GuiControl
- GuiEffectCanvas
GuiCanvas
- GuiFadeinBitmapCtrl
GuiBitmapCtrl
Fields
- done
- fadeinTime
- fadeoutTime
- waitTime
- GuiFilterCtrl
GuiControl
-
Methods
- getValue()
- Return a tuple containing all the values in the filter.
- identity()
- setValue(f1, f2, ...)
- Reset the filter to use the specified points, spread equidistantly across the domain.
Fields
- GuiFormCtrl
GuiControl
-
Methods
- getMenuID()
- Returns the ID of the Form Menu
- setCaption(caption)
- - Sets the title of the Form Menu
Fields
- Caption
- Content
- ContentLibrary
- HasMenu
- Movable
- GuiFrameSetCtrl
GuiControl
-
Methods
- 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
- autoBalance
- borderColor
- borderEnable
- borderMovable
- borderWidth
- columns
- fudgeFactor
- rows
- GuiGraphCtrl
GuiControl
-
Methods
- 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.
- GuiIconButtonCtrl
GuiButtonCtrl
-
Methods
Fields
- buttonMargin
- iconBitmap
- iconLocation
- sizeIconToButton
- textLocation
- textMargin
- GuiImageList
SimObject
-
Methods
- clear()
- count()
- gets the number of images in the list
- getImage(int index)
- Get a path to the texture at the specified index
- getIndex(image path)
- retrieves the imageindex of a specified texture in the list
- insert(image path)
- insert an image into imagelist- returns the image index or -1 for failure
- remove(image index)
- removes an image from the list by index
- GuiInputCtrl
GuiControl
- GuiInspector
GuiStackControl
-
Methods
- getInspectObject()
- - Returns currently inspected object
- inspect()
- setName(NewObjectName)
- GuiInspectorDatablockField
GuiInspectorField
- GuiInspectorDynamicField
GuiInspectorField
-
Methods
- renameField(newDynamicFieldName)
- GuiInspectorDynamicGroup
- GuiInspectorField
GuiControl
- GuiInspectorGroup
GuiControl
- GuiInspectorTypeCheckBox
GuiInspectorField
- GuiInspectorTypeColor
GuiInspectorField
- GuiInspectorTypeColorF
GuiInspectorTypeColor
- GuiInspectorTypeColorI
GuiInspectorTypeColor
- GuiInspectorTypeEnum
GuiInspectorField
- GuiInspectorTypeFileName
GuiInspectorField
- GuiInspectorTypeGuiProfile
GuiInspectorTypeEnum
- GuiListBoxCtrl
GuiControl
-
Methods
- addItem(text, color)
- - adds an item to the end of the list with an optional color
- clearItemColor(index)
- 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
- setItemColor(index, color)
- setItemText(index, newtext)
- - sets the items text at the specified index
- setMultipleSelection([true/false])
- setSelected(index, [true]/false)
- - sets the item at the index specified to selected or not
Fields
- AllowMultipleSelections
- bool AllowMultipleSelections
- fitParentWidth
- GuiMessageVectorCtrl
GuiControl
-
Methods
- 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
- allowedMatches
- lineContinuedIndex
- lineSpacing
- matchColor
- maxColorIndex
- GuiMLTextCtrl
GuiControl
-
Methods
- 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
- allowColorChars
- deniedSound
- lineSpacing
- maxChars
- text
- GuiMLTextEditCtrl
GuiMLTextCtrl
- GuiMouseEventCtrl
GuiControl
- GuiPaneControl
GuiControl
-
Methods
Fields
- barBehindText
- Caption
- captionID
- collapsable
- GuiParticleGraphCtrl
GuiControl
-
Methods
- addPlotPoint(int plotID, float x, float y, bool setAdded = true;)
- Add a data point to the given plot.
- changePlotPoint(int plotID, int i, float x, float y)
- Change a data point to the given plot and plot position.
- clearAllGraphs()
- clearGraph(int plotID)
- Clear the graph of the given plot.
- getGraphColor(int plotID)
- Get the color of the graph passed.
- getGraphMax(int plotID)
- Get the color of the graph passed.
- getGraphMin(int plotID)
- Get the color of the graph passed.
- getGraphName(int plotID)
- Get the name of the graph passed.
- getPlotIndex(int plotID, float x, float y)
- Gets the index of the point passed on the plotID passed (graph ID).
- getPlotPoint(int plotID, int samples)
- Get a data point from the plot specified, samples from the start of the graph.
- getSelectedPlot()
- Gets the selected Plot (a.k.a. graph).
- getSelectedPoint()
- Gets the selected Point on the Plot (a.k.a. graph).
- insertPlotPoint(int plotID, int i, float x, float y)
- Change a data point to the given plot and plot position.
- isExistingPoint(int plotID, int samples)
- Returns true or false whether or not the point in the plot passed is an existing point.
- resetSelectedPoint()
- This will reset the selected point to nothing.
- setAutoGraphMax(bool autoMax)
- Set whether the max will automatically be set when adding points.
- setAutoRemove(bool autoRemove)
- Set whether or not a point should be deleted when you drag another one over it.
- setGraphHidden(int plotID, bool isHidden)
- Set whether the graph number passed is hidden or not.
- setGraphMax(int plotID, float maxX, float maxY)
- Set the max values of the graph of plotID.
- setGraphMaxX(int plotID, float maxX)
- Set the max X value of the graph of plotID.
- setGraphMaxY(int plotID, float maxY)
- Set the max Y value of the graph of plotID.
- setGraphMin(int plotID, float minX, float minY)
- Set the min values of the graph of plotID.
- setGraphMinX(int plotID, float minX)
- Set the min X value of the graph of plotID.
- setGraphMinY(int plotID, float minY)
- Set the min Y value of the graph of plotID.
- setGraphName(int plotID, string graphName)
- set the graph's name of plot plotID.
- setPointXMovementClamped(bool clamped)
- Set whether the x position of the selected graph point should be clamped
- setRenderAll(bool renderAll)
- Set whether or not a position should be rendered on every point or just the last selected.
- setRenderGraphTooltip(bool renderGraphTooltip)
- Set whether or not to render the graph tooltip.
- setSelectedPlot(int plotID)
- Set the selected plot (a.k.a. graph).
- setSelectedPoint(int point)
- Set the selected point on the graph.
- GuiProgressCtrl
GuiTextCtrl
- GuiRadioCtrl
GuiCheckBoxCtrl
- GuiRolloutCtrl
GuiControl
-
Methods
- collapse()
- expand()
- instantCollapse()
- instantExpand()
- isExpanded()
- sizeToContents()
Fields
- Caption
- ClickCollapse
- Collapsed
- DefaultHeight
- Margin
- GuiScriptNotifyCtrl
GuiControl
Fields
- onChildAdded
- onChildRemoved
- onChildResized
- onGainFirstResponder
- bool onGainFirstResponder
- onLoseFirstResponder
- bool onLoseFirstResponder
- onParentResized
- onResize
- GuiScrollCtrl
GuiControl
-
Methods
- getScrollPositionX()
- - get the current x scroll position of the scroll control.
- getScrollPositionY()
- - get the current y scroll position of the scroll control.
- 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.
- setScrollPosition(x, y)
- - scrolls the scroll control to the specified position.
Fields
- childMargin
- constantThumbHeight
- hScrollBar
- vScrollBar
- willFirstRespond
- GuiSeparatorCtrl
GuiControl
Fields
- BorderMargin
- Caption
- Invisible
- LeftMargin
- type
- GuiSliderCtrl
GuiControl
-
Methods
- getValue()
- Get the position of the slider.
Fields
- GuiStackControl
GuiControl
-
Methods
- updateStack()
- - Restacks controls it owns
Fields
- HorizStacking
- Padding
- StackingType
- VertStacking
- guiT2DObjectCtrl
GuiButtonCtrl
-
Methods
- getSceneObject()
- - returns displaying sceneobject id
- setCaption( string caption )
- setSceneObject(string object-id/name)
- - Set the T2D sceneObject displayed in the control.
Fields
- GuiTabBookCtrl
GuiControl
-
Methods
- addPage(no arguments expected)
- selectPage(int pageIndex)
Fields
- MinTabWidth
- TabHeight
- TabMargin
- TabPosition
- GuiTabPageCtrl
GuiTextCtrl
- GuiTextCtrl
GuiControl
-
Methods
- setText( newText )
- setTextID( newText )
Fields
- GuiTextEditCtrl
GuiTextCtrl
-
Methods
- forceValidateText()
- getCursorPos()
- getText()
- selectAllText()
- setCursorPos( newPos )
Fields
- deniedSound
- escapeCommand
- historySize
- password
- passwordMask
- sinkAllKeyEvents
- tabComplete
- validate
- GuiTextEditSliderCtrl
GuiTextEditCtrl
- GuiTextListCtrl
GuiArrayCtrl
-
Methods
- addRow(int id, string text, int index=0)
- Returns row number of the new item.
- clear()
- 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()
- 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
- clipColumnText
- columns
- enumerate
- fitParentWidth
- resizeCell
- GuiTheoraCtrl
GuiControl
-
Methods
- getCurrentTime()
- Return the time elapsed in playback, in seconds.
- setFile(string filename)
- Set an Ogg Theora file to play.
- stop()
Fields
- backgroundColor
- done
- stopOnSleep
- theoraFile
- GuiTickCtrl
GuiControl
-
Methods
- setProcessTicks( [tick = true] )
- - This will set this object to either be processing ticks or not
- GuiToolboxButtonCtrl
GuiButtonCtrl
-
Methods
- 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
- hoverBitmap
- loweredBitmap
- normalBitmap
- GuiTreeViewCtrl
GuiArrayCtrl
-
Methods
- addChildSelectionByValue(TreeItemId parent, value)
- addSelection(selects an item)
- buildIconTable(builds an icon table)
- buildVisibleTree()
- clear()
- 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()
- 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
- getSelectedItemsCount()
- getSelectedObject()
- returns the currently selected simObject in inspector mode or -1
- 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.
- removeAllChildren(TreeItemId parent)
- removeChildSelectionByValue(TreeItemId parent, value)
- removeItem(TreeItemId item)
- removeSelection(deselects an item)
- scrollVisible(TreeItemId item)
- selectItem(TreeItemId item, bool select=true)
Fields
- DeleteObjectAllowed
- destroyTreeOnSleep
- DragToItemAllowed
- fullRowSelect
- itemHeight
- MouseDragging
- MultipleSelections
- tabSize
- textOffset
- GuiVectorFieldCtrl
GuiTickCtrl
- GuiWindowCtrl
GuiTextCtrl
Fields
- canClose
- canMaximize
- canMinimize
- canMove
- closeCommand
- minSize
- resizeHeight
- resizeWidth
- HTTPObject
TCPObject
-
Methods
- get(TransportAddress addr, string requirstURI, string query=NULL)
- post(TransportAddress addr, string requestURI, string query, string post)
- LangTable
SimObject
-
Methods
- addLanguage(string filename, [string languageName])
- getCurrentLanguage()
- getLangName(int language)
- getNumLang()
- getString(string filename)
- setCurrentLanguage(int language)
- setDefaultLanguage(int language)
- LevelBuilder3DShapeTool
LevelBuilderCreateTool
-
Methods
- setShape()
- Sets the shape for the created 3D shapes.
- LevelBuilderAnimatedSpriteTool
LevelBuilderCreateTool
-
Methods
- setAnimation()
- Sets the animation for the created animated sprites.
- LevelBuilderBaseEditTool
LevelBuilderBaseTool
- LevelBuilderBaseTool
SimObject
-
Methods
- getToolName()
- - Returns this tools display name
- getToolTexture()
- - Returns this tools associated texture
- setToolName(string toolName)
- - set the name associated with this tool
- setToolTexture(string - NO PATH - filename)
- - set the texture associated with this tool
- LevelBuilderCameraTool
LevelBuilderBaseEditTool
-
Methods
- getCameraPosition()
- getCameraSize()
- setCameraPosition()
- setCameraSize()
- LevelBuilderChunkedSpriteTool
LevelBuilderCreateTool
-
Methods
- setImageMap()
- Sets the image map for the created chunked sprites.
- LevelBuilderCreateTool
LevelBuilderBaseEditTool
-
Methods
- createObject()
- getAcquireCreatedObjects()
- setAcquireCreatedObjects()
- setClassName()
- Sets the script class namespace to link the created object to.
- setConfigDatablock()
- Sets the script class namespace to link the created object to.
- setSuperClassName()
- Sets the script super class namespace to link the created object to.
- LevelBuilderLinkPointTool
LevelBuilderBaseTool
-
Methods
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- LevelBuilderMountTool
LevelBuilderBaseTool
-
Methods
- dismountObject()
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- LevelBuilderParticleTool
LevelBuilderCreateTool
-
Methods
- setEffect()
- Sets the effect file for the created particle effects.
- LevelBuilderPathEditTool
LevelBuilderBaseEditTool
-
Methods
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- LevelBuilderPathTool
LevelBuilderCreateTool
- LevelBuilderPolyTool
LevelBuilderBaseTool
-
Methods
- cancelEdit()
- Cancels editing of an object.
- checkConvexPoly()
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- getLocalMousePosition()
- getScript()
- getVertexCount()
- setPolyPrimitive(%numEdges)
- LevelBuilderSceneEdit
SimObject
-
Methods
- acquireObject()
- addTool(ToolObject, default)
- breakApartAcquiredObjects()
- Removes all acquired objects from there group.
- clearAcquisition()
- Relinquishes acquisition of an object.
- deleteAcquiredObjects()
- Deletes all acquired objects.
- getAcquiredGroup()
- Returns the acquired object group.
- getAcquiredObjectCount()
- Returns the acquired object count.
- getAcquiredObjects()
- Returns the acquired object set.
- getActiveTool()
- getCameraPosition()
- getCameraVisibility()
- turns grid drawing on/off
- getCameraZoom()
- getDesignResolution()
- Returns the design resolution.
- getFillColor()
- returns current fill color
- 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
- getGuidesVisibility()
- turns grid drawing on/off
- getLastWindow()
- getMousePosition()
- getRecycledObject(int index)
- - Returns the recycled object at the given index.
- getRecycledObjectCount()
- - Returns the number of objects in the recycle bin.
- getRotationSnap()
- Gets the snap rotation flag.
- getRotationSnapAngle()
- Gets the rotation snap angle.
- getRotationSnapThreshold()
- Gets the rotation snap threshold for snap to grid.
- getSnapThreshold()
- Gets the snap threshold for snap to grid.
- getSnapToGrid()
- getSnapToGridX()
- getSnapToGridY()
- groupAcquiredObjects()
- Puts all acquired objects in a t2dSceneObjectGroup.
- isAcquired()
- Returns whether or not an object is acquired.
- moveFromRecycleBin()
- Move an object from the recycle bin back to the scene.
- moveToRecycleBin()
- Move an object from scene to the recycle bin.
- redo()
- removeTool(ToolObject)
- setActiveTool()
- setCameraVisibility()
- turns camera drawing on/off
- setDesignResolution()
- Set the design resolution.
- setFillColor()
- sets the fill color for the control
- 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
- setGuidesVisibility()
- turns guides drawing on/off
- setLastWindow()
- setRotationSnap()
- Sets the snap rotation flag.
- setRotationSnapAngle()
- Sets the rotation snap angle.
- setRotationSnapThreshold()
- Sets the rotation snap threshold for snap to grid.
- setSnapThreshold()
- Sets the snap threshold for snap to grid.
- setSnapToGrid()
- setSnapToGridX()
- sets whether we'll snap to X axis
- setSnapToGridY()
- sets whether we'll snap to Y axis
- undo()
- updateAcquiredObjectSet()
- Updates the t2dSceneObjectSet of acquired objects.
- LevelBuilderSceneObjectTool
LevelBuilderCreateTool
- LevelBuilderSceneWindow
t2dSceneWindow
-
Methods
- clearToolOverride()
- - Clears the tool override on this window
- getGroupMask()
- - Gets the group mask for picking
- getLayerMask()
- - Gets the layer mask for picking
- getSceneEdit()
- - Gets the tool manager for this edit window)
- setGroupMask()
- - Sets the group mask for picking
- setLayerMask()
- - Sets the layer mask for picking
- setSceneEdit(toolManager)
- - Sets the tool manager for this edit window)
- setToolOverride()
- - Sets a tool override for this edit window)
- LevelBuilderScrollerTool
LevelBuilderCreateTool
-
Methods
- setImageMap()
- Sets the image map for the created scrollers.
- LevelBuilderSelectionTool
LevelBuilderBaseEditTool
-
Methods
- addWidget(widget)
- getFullContainSelect()
- getUndoSelections()
- RefreshWidgets()
- setFullContainSelect(true/false)
- setUndoSelections(true/false)
- LevelBuilderSortPointTool
LevelBuilderBaseTool
-
Methods
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- LevelBuilderStaticSpriteTool
LevelBuilderCreateTool
-
Methods
- setImageMap()
- Sets the image map for the created static sprites.
- LevelBuilderTextObjectTool
LevelBuilderCreateTool
-
Methods
- setFontDB()
- Sets font Datablock for the Text Object.
- LevelBuilderTileMapEditTool
LevelBuilderBaseEditTool
-
Methods
- applyToSelection()
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- getTileSize()
- resetAutoPanSettings()
- - Egregious hack for getting layers to save auto pan correctly.
- setAutoPanSettings()
- - Egregious hack for getting layers to save auto pan correctly.
- setCollision()
- setCollisionPoly()
- setCustomData()
- setEraserTool()
- setEyeTool()
- setFlipX()
- setFlipY()
- setFloodTool()
- setFrame()
- setIconBitmap(bitmapName)
- setImage()
- setPaintTool()
- setSelectTool()
- setTileScript()
- LevelBuilderTileMapTool
LevelBuilderCreateTool
-
Methods
- setTileLayerFile()
- Sets the tile layer file for the created tile layers.
- setTileMap()
- Sets the tile map to place created layers in
- LevelBuilderTriggerTool
LevelBuilderCreateTool
- LevelBuilderWorldLimitTool
LevelBuilderBaseEditTool
-
Methods
- cancelEdit()
- Cancels editing of an object.
- editObject()
- Selects an object for editing.
- finishEdit()
- Applies changes and ends editing of an object.
- MaterialPropertyMap
SimObject
- MessageVector
SimObject
-
Methods
- 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
- 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
- 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
- RemoteCommandEvent
- ScriptClass
SimObject
Fields
- className
- Script Class Namespace this object defines.
- libraryName
- Class Library This Belongs to.
- ScriptGroup
SimGroup
- ScriptObject
SimObject
- SelectionToolWidget
SimObject
-
Methods
- addClass(className)
- setDisplayRule("Rule")
- setTexture(textureName)
Fields
- callback
- position
- priority
- showClasses
- tooltip
- SimChunk
SimGroup
- SimDataBlock
SimObject
- SimGroup
SimSet
-
Methods
- findObjectByInternalName()
- SimObject
-
Methods
- delete()
- dump()
- dumpClassHierarchy()
- getClassName()
- getDynamicField(index)
- getDynamicFieldCount()
- getFieldValue(fieldName)
- getGroup()
- getId()
- getInternalName()
- getInternalName returns the objects internal name
- 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
- isMethod(string method name)
- save(fileName, <selectedOnly>)
- schedule(time, command, <arg1...argN>)
- setFieldValue(fieldName,value)
- setInternalName()
- setName(newName)
Fields
- canSaveDynamicFields
- bool canSaveDynamicFields
- internalName
- SimpleMessageEvent
- SimpleNetObject
NetObject
- SimSet
SimObject
-
Methods
- add(obj1,...)
- bringToFront(object)
- clear()
- getCount()
- getObject(objIndex)
- isMember(object)
- listObjects()
- pushToBack(object)
- remove(obj1,...)
- reorderChild()
- (child1, child2) uses simset reorder to push child 1 before child 2 - both must already be child controls of this control
- t2dActiveTile
SimObject
- t2dActiveTileDatablock
t2dBaseDatablock
- t2dAnimatedSprite
t2dSceneObject
-
Methods
- getAnimation()
- Gets current animation name.
- getAnimationFrame()
- Gets current animation frame.
- getAnimationName()
- Gets current animation name.
- getAnimationTime()
- Gets current animation time.
- getIsAnimationFinished()
- playAnimation(animationName$, [autoRestore?], [frameIndex], [mergeTime?])
- setAnimation(animationName)
- setAnimationFrame(frame)
- - Sets the current animation frame.
- setFrameChangeCallback(status?)
- - Sets the frame-change callback status.
Fields
- t2dAnimationDatablock
t2dBaseDatablock
Fields
- animationCycle
- animationFrames
- animationTime
- imageMap
- randomStart
- startFrame
- t2dBaseDatablock
SimDataBlock
-
Methods
- getDatablockClassName()
- Gets datablocks unique classname.
- getDefaultConfigDatablock()
- Gets the datablock being applied to objects using this image map.
- setDefaultConfigDatablock()
- Sets the datablock to be applied to objects using this image map.
Fields
- t2dChunkedImageDatablock
t2dBaseDatablock
- t2dChunkedSprite
t2dSceneObject
-
Methods
- setChunkedImage(chunkedImageName$)
- setRepeat(repeatX / repeatY)
- - Sets the Repeat X/Y repetition.
- t2dCollisionMaterialDatablock
t2dBaseDatablock
Fields
- AutoMassInertia
- Damping
- Density
- ForceScale
- Friction
- Immovable
- inertialmoment
- Mass
- Restitution
- T2DDatablockDropDownCtrl
GuiPopUpMenuCtrlEx
-
Methods
- setFilter(datablock classname)
- - no parameters for all t2d datablocks
Fields
- t2dGunTurret
t2dActiveTile
-
Methods
- setFrame(frame)
- setImageMap(imageMapName$, [int frame])
- setTrackObject(t2dSceneObject)
- t2dImageMapDatablock
t2dBaseDatablock
-
Methods
- compile()
- getFilterMode()
- getFrameCount()
- Get ImageMap Frame Count.
- getFrameSize(int frame)
- - Get ImageMap Frame Size.
- getFrameTexturePage(int frame)
- - Get ImageMap Frame Texture Page.
- getImageMapMode()
- getSrcBitmapName()
- getSrcBitmapSize()
- getTexturePageCount()
- Get ImageMap Texture-Page Count.
- getTexturePageFrameCount(int texturePage)
- - Get ImageMap Texture-Page Frame Count.
- getTexturePageSize(int texturePage)
- - Get ImageMap Texture-Page Size.
- setFilterMode()
Fields
- allowUnload
- cellCountX
- cellCountY
- cellHeight
- cellOffsetX
- cellOffsetY
- cellRowOrder
- cellStrideX
- cellStrideY
- cellWidth
- filterMode
- filterPad
- frameCount
- imageMode
- imageName
- linkImageMaps
- preferPerf
- preload
- t2dParticleEffect
t2dSceneObject
-
Methods
- addDataKey(time, value)
- addEmitter(emitter)
- - Adds an Emitter to the Effect creating a new one if necessary.
- clearDataKeys()
- Clear Data-Key(s) from Graph.
- clearEmitters()
- Clear all Emitters from the Effect.
- findEmitterObject(emitterName$)
- - Finds Emitter Object by name from Effect.
- findParticlePeak(searchTime, timeStep, peakLimit)
- - Find Particle Peak-Time.
- 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()
- getMinValue()
- Get Min-Value from Graph.
- getTimeRepeat()
- Get Time-Repeat for Graph.
- getValueScale()
- Get Value-Scale for Graph.
- loadEffect(effectFile$)
- - Loads a Particle Effect.
- moveEffectTo(moveTime, timeStep)
- moveEmitter(fromEmitterIndex, toEmitterIndex)
- - Moves the Emitter Object.
- playEffect(resetParticles?)
- - Plays the Particle Effect.
- removeDataKey(keyIndex)
- - Remove Data-Key from Graph.
- removeEmitter(emitterObject, deleteEmitter)
- - Removes an Emitter from the Effect.
- saveEffect(effectFile$)
- - Saves a Particle Effect.
- selectGraph(graphName)
- 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.
- setValueScale(valueScale)
- - Set Value-Scale For Graph.
- stopEffect([waitForParticles?, killEffect?])
- - Stops the Particle Effect.
Fields
- effectFile
- effectMode
- effectTime
- useEffectCollisions
- t2dParticleEmitter
SimObject
-
Methods
- addDataKey(time, value)
- clearDataKeys()
- Clear Data-Key(s) from Graph.
- getAlignAngleOffset()
- Get Align-Orientation Angle-Offset.
- getAlignKeepAligned()
- Get Align-Orientation Keep-Aligned Flag.
- getAnimationName()
- 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()
- getEmitterType()
- getFirstInFrontOrder()
- Get First-In-Front-Order Flag.
- getFixedAngleOffset()
- Get Fixed-Orientation Angle-Offset.
- getFixedAspect()
- getFixedForceAngle()
- Get Fixed-Force-Direction.
- getGraphValue(time)
- 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()
- getMinValue()
- Get Min-Value from Graph.
- getParentEffect()
- Returns the effect containing this emitter.
- getParticleOrientation()
- Get Particle Orientation.
- getParticleOrientationMode()
- Get Particle Orientation.
- getPivotPoint()
- 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.
- getValueScale()
- Get Value-Scale for Graph.
- 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)
- setAlignAngleOffset(alignAngleOffset)
- - Set Align-Orientation Angle Offset.
- setAlignKeepAligned(keepAligned)
- - Set Align-Orientation Keep-Aligned Flag.
- setAnimationName(animationName$)
- 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$)
- setEmitterType(emitterType$)
- setFirstInFrontOrder(firstInFrontOrder)
- - Set First-InFront-Order Flag.
- setFixedAngleOffset(randomAngle)
- - Set Fixed-Orientation Angle-Offset.
- setFixedAspect(fixedAspect)
- setFixedForceAngle(fixedForceAngle)
- 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)
- 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.
- setValueScale(valueScale)
- - Set Value-Scale For Graph.
- setVisible(status?)
- - Set the Emitters Visibility.
- t2dPath
t2dSceneObject
-
Methods
- addNode(%position, %location, %rotation, %weight)
- attachObject(%obj, %speed, %dir, %start, %end, %pathMode, %loops, %sendToStart)
- clear()
- detachObject(%object)
- getEndNode(object)
- getFollowMode(object)
- getLoops(object)
- getMoveForward(object)
- getNodeCount()
- getOrient(object)
- getPathType()
- Gets the interpolation type.
- getRotationOffset(object)
- getSpeed(object)
- getStartNode(object)
- removeNode(%index)
- setEndNode(object, node)
- setFollowMode(object, pathMode)
- setLoops(object, loops)
- setMoveForward(object, forward)
- setOrient(object, orient)
- setPathType()
- Sets the interpolation type for the path.
- setRotationOffset(object, offset)
- setSpeed(object, speed)
- setStartNode(object, node)
Fields
- t2dSceneGraph
SimSet
-
Methods
- addToScene(t2dSceneObject)
- - Add t2dSceneObject to Scene.
- clearScene([deleteObjects?])
- - Clear Scene of all t2dSceneObject objects.
- getConstantForce()
- Gets the scene constant-force.
- getDebugOn(debug mode)
- - Gets the state of the debug mode
- getGlobalTileMap()
- getSceneObject()
- Gets the selected Scene Object.
- getSceneObjectCount()
- Gets the Scene Object-Count.
- getSceneObjectList()
- Gets the Scene Object-List.
- getScenePause()
- getScenePhysicsFPSActive()
- Gets physics FPS Active status.
- getScenePhysicsLimitFPS()
- getScenePhysicsMaxIterations()
- Gets physics maximum iterations.
- getScenePhysicsTargetFPS()
- getSceneTime()
- Gets the Scene Graph Time.
- initialise(containerBinSize, containerBinCount, useLayerSorting?, lastInFrontSorting?)
- - Initialise Scene Graph.
- loadScene(file$)
- - Loads a Scene from a Disk File.
- performPostInit()
- - Performs mount and other post initialization tasks
- 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)
- 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
- class
- config
- layerSortMode0
- layerSortMode1
- layerSortMode10
- layerSortMode11
- layerSortMode12
- layerSortMode13
- layerSortMode14
- layerSortMode15
- layerSortMode16
- layerSortMode17
- layerSortMode18
- layerSortMode19
- layerSortMode2
- layerSortMode20
- layerSortMode21
- layerSortMode22
- layerSortMode23
- layerSortMode24
- layerSortMode25
- layerSortMode26
- layerSortMode27
- layerSortMode28
- layerSortMode29
- layerSortMode3
- layerSortMode30
- layerSortMode31
- layerSortMode4
- layerSortMode5
- layerSortMode6
- layerSortMode7
- layerSortMode8
- layerSortMode9
- scenePhysicsFPSActive
- bool scenePhysicsFPSActive
- scenePhysicsLimitFPS
- float scenePhysicsLimitFPS
- scenePhysicsMaxIterations
- int scenePhysicsMaxIterations
- scenePhysicsTargetFPS
- float scenePhysicsTargetFPS
- superclass
- UseLayerSorting
- t2dSceneGraphDatablock
t2dBaseDatablock
Fields
- containerBinCount
- containerBinSize
- lastInFrontSorting
- scenePhysicsFPSActive
- bool scenePhysicsFPSActive
- scenePhysicsLimitFPS
- float scenePhysicsLimitFPS
- scenePhysicsMaxIterations
- int scenePhysicsMaxIterations
- scenePhysicsTargetFPS
- float scenePhysicsTargetFPS
- UseLayerSorting
- t2dSceneObject
SimObject
-
Methods
- addLinkPoint([offsetX / offsetY])
- addToScene(t2dSceneGraph)
- attachGui(guiObject, t2dSceneWindow, [sizeControl?])
- castCollision(elapsedTime)
- - Returns collision details for object over elapsed-time.
- castCollisionList(elapsedTime)
- - Returns list of objects collided with over elapsed-time.
- clone(copyFields?)
- copy(t2dSceneObject, [copyFields?])
- - Copies one object from another.
- detachGui()
- dismount()
- getAngularVelocity()
- Gets Object Angular Velocity.
- getArea()
- getAreaMax()
- Gets the current area maximum.
- getAreaMin()
- Gets the current area minimum.
- getAtRest()
- Gets whether the Object is at Rest.
- getAttachedToPath()
- 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.
- getBlendingStatus()
- - Returns the blending status.
- getClassNamespace()
- getCollisionActive()
- Gets the collision active directions.
- getCollisionActiveReceive()
- Gets the collision active receive status.
- getCollisionActiveSend()
- Gets the collision active send status.
- getCollisionCallback()
- Gets the collision callback status.
- getCollisionCircleScale()
- Gets the collision-circle Scale.
- getCollisionCircleSuperscribed()
- getCollisionDetection()
- Get the Collision-Detection mode.
- getCollisionGroups()
- - Gets the collision groups.
- getCollisionLayers()
- - Gets the collision layers.
- getCollisionMasks()
- Gets the collision group/layer masks.
- getCollisionMaxIterations()
- Gets the Objects Maximum Collision Iterations
- getCollisionPhysics()
- Gets the collision physics directions.
- getCollisionPhysicsReceive()
- Gets the collision physics receive status.
- getCollisionPhysicsSend()
- Gets the collision physics send status.
- getCollisionPoly()
- getCollisionPolyCount()
- Gets Collision Poly Edge Count.
- getCollisionPolyScale()
- Gets the collision-polygon Scale.
- getCollisionResponse()
- Get the Collision-Response mode.
- getCollisionSuppress()
- Gets the collision suppress status.
- getConfigDatablock()
- getConstantForce()
- Gets the objects constant-force.
- getConstantForceX()
- getConstantForceY()
- getDamping()
- getDensity()
- getDstBlendFactor()
- - Returns the dst blend factor.
- getEnabled()
- Gets the objects enabled status.
- getFlip()
- Gets the Flip for each axis.
- getFlipX()
- - Gets Horizontal Flipping.
- getFlipY()
- - Gets Vertical Flipping.
- getForceScale()
- Gets the objects force-scale.
- getForwardMovementOnly()
- Gets the object 'forward' movement only status.
- getFriction()
- getGraphGroup()
- getGraviticConstantForce()
- getHeight()
- getImmovable()
- Gets the immovable status.
- getInertialMoment()
- Gets Object Inertial Moment.
- getIsChild()
- Gets the objects Child status.
- getIsMounted()
- getIsPointInObject(X / Y)
- - Returns whether point intersects with object.
- getLayer()
- 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)
- getLocalPoint(X / Y)
- - Returns local-point for object.
- getMass()
- 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.
- getMountForce()
- getMountInheritAttributes()
- Returns the inherit attributes status.
- getMountOwned()
- Returns the mount owned status.
- getMountRotation()
- getMountTrackRotation()
- Returns the track rotation status.
- getPaused()
- Gets the objects paused status.
- 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()
- getRotation()
- Gets the current rotation.
- getSceneGraph()
- Retrieve the objects scenegraph
- getSize()
- getSizeX()
- Gets Objects Size X-Component.
- getSizeY()
- Gets Objects Size Y-Component.
- getSortPoint()
- Gets the layer draw order sorting point.
- getSortPointX()
- Gets the X-component of the layer draw order sorting point.
- getSortPointY()
- Gets the Y-component of the layer draw order sorting point.
- getSrcBlendFactor()
- - Returns the src blend factor.
- getSuperClassNamespace()
- getUseMouseEvents()
- Gets whether mouses-events are monitored by this object.
- getVisible()
- Gets the objects visible status.
- getWidth()
- getWorldLimit()
- 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.
- redirectCallback(callbackName, ...)
- removeAllLinkPoints()
- removeFromScene()
- removeLinkPoint(mountID)
- rotateTo(rotationTarget, angularSpeed, [autoStop?], [callback?], [snap?], [targetMargin] )
- - Rotates-To/Sets the objects rotation-target.
- safeDelete()
- saveCopy(objectFile$)
- - Saves a copy of the object to disk.
- setAngularVelocity()
- Sets Objects Angular Velocity.
- setArea(x1 / y1 / x2 / y2)
- setAtRest()
- 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.
- setBlendingStatus(blendStatus)
- setClassNamespace()
- setCollisionActive(send, receive)
- - Sets the collision check directions.
- setCollisionActiveReceive()
- Sets the collision active receive status.
- setCollisionActiveSend()
- Sets the collision active send status.
- 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.
- setCollisionPhysicsReceive()
- Sets the collision physics receive status.
- setCollisionPhysicsSend()
- Gets the collision physics send status.
- 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.
- setConfigDatablock( [newDatablockName = no config] )
- setConstantForce(forceX / forceY, [gravitic?])
- - Apply a continuous force.
- setConstantForcePolar(angle, force, [gravitic?])
- - Apply a continuous polar force.
- setConstantForceX(forceX)
- setConstantForceY(forceY)
- setDamping(damping)
- setDebugOff(debugMask)
- setDebugOn(debugMode)
- setDefaultWorldLimit()
- Set to the world limit to default values.
- setDensity(density)
- setDstBlendFactor(dstBlend)
- setEnabled(status?)
- - Sets the objects enabled status.
- setFlip(flipX?, flipY?)
- - Sets Flipping for each axis.
- setFlipX(flipX)
- - Sets Horizontal Flipping.
- setFlipY(flipY)
- - Sets Vertical Flipping.
- 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)
- setGraphGroup(group)
- - Sets the objects group (0-31).
- setGraviticConstantForce(gravitic)
- setHeight()
- 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)
- 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)
- 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.
- setMountForce()
- setMountInheritAttributes()
- Sets the mount inherit attributes status.
- setMountOwned()
- Sets the mount owned status.
- setMountRotation(mountRotation)
- - Sets the objects Mount rotation.
- setMountTrackRotation()
- Sets the track rotation status.
- setPaused(status?)
- - Sets the objects paused status.
- 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])
- setSizeX()
- Sets Objects Size X-Component.
- setSizeY()
- Sets Objects Size Y-Component.
- setSortPoint(X / Y)
- - Sets the layer draw order sorting point.
- setSortPointX()
- Sets the X-component of the layer draw order sorting point.
- setSortPointY()
- Sets the Y-component of the layer draw order sorting point.
- setSrcBlendFactor(srcBlend)
- setSuperClassNamespace()
- 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()
- setWorldLimit(limitMode, [minX / minY / maxX / maxY], [callback?])
- stopConstantForce()
- Stops any continuous force.
Fields
- AngularVelocity
- AutoMassInertia
- AutoMountRotation
- AutoRotation
- BlendColor
- BlendingEnabled
- class
- CollisionActiveReceive
- bool CollisionActiveReceive
- CollisionActiveSend
- CollisionCallback
- CollisionCircleScale
- float CollisionCircleScale
- CollisionCircleSuperscribed
- bool CollisionCircleSuperscribed
- CollisionDetectionMode
- enumval CollisionDetectionMode
- CollisionGroups
- CollisionLayers
- CollisionMaxIterations
- int CollisionMaxIterations
- CollisionPhysicsReceive
- bool CollisionPhysicsReceive
- CollisionPhysicsSend
- bool CollisionPhysicsSend
- CollisionPolyList
- point2FList CollisionPolyList
- CollisionPolyScale
- Point2F CollisionPolyScale
- CollisionResponseMode
- enumval CollisionResponseMode
- config
- ConstantForce
- ConstantForceGravitic
- bool ConstantForceGravitic
- Damping
- Density
- DstBlendFactor
- Enabled
- FlipX
- FlipY
- ForceScale
- ForwardOnly
- Friction
- GraphGroup
- Immovable
- Inertia
- Layer
- Lifetime
- LinearVelocity
- LinkPoints
- Mass
- MaxAngularVelocity
- MaxLinearVelocity
- MinAngularVelocity
- MinLinearVelocity
- MountForce
- MountInheritAttributes
- bool MountInheritAttributes
- MountOffset
- MountOwned
- MountRotation
- MountTrackRotation
- Paused
- position
- Restitution
- Rotation
- scenegraph
- size
- SortPoint
- SrcBlendFactor
- superclass
- UseMouseEvents
- Visible
- WorldLimitCallback
- WorldLimitMax
- WorldLimitMin
- WorldLimitMode
- t2dSceneObjectDatablock
t2dBaseDatablock
Fields
- AngularVelocity
- AutoMassInertia
- AutoMountRotation
- AutoRotation
- BlendColor
- BlendingEnabled
- class
- CollisionActiveReceive
- bool CollisionActiveReceive
- CollisionActiveSend
- CollisionCallback
- CollisionCircleScale
- float CollisionCircleScale
- CollisionCircleSuperscribed
- bool CollisionCircleSuperscribed
- CollisionDetectionMode
- enumval CollisionDetectionMode
- CollisionGroups
- CollisionLayers
- CollisionMaxIterations
- int CollisionMaxIterations
- CollisionPhysicsReceive
- bool CollisionPhysicsReceive
- CollisionPhysicsSend
- bool CollisionPhysicsSend
- CollisionPolyList
- point2FList CollisionPolyList
- CollisionPolyScale
- Point2F CollisionPolyScale
- CollisionResponseMode
- enumval CollisionResponseMode
- ConstantForce
- ConstantForceGravitic
- bool ConstantForceGravitic
- Damping
- Density
- DstBlendFactor
- Enabled
- FlipX
- FlipY
- ForceScale
- ForwardOnly
- Friction
- GraphGroup
- Immovable
- Inertia
- Layer
- Lifetime
- LinearVelocity
- LinkPoints
- Mass
- MaxAngularVelocity
- MaxLinearVelocity
- MinAngularVelocity
- MinLinearVelocity
- MountForce
- MountInheritAttributes
- bool MountInheritAttributes
- MountOffset
- MountOwned
- MountRotation
- MountTrackRotation
- Paused
- position
- Restitution
- Rotation
- size
- SortPoint
- SrcBlendFactor
- superclass
- UseMouseEvents
- Visible
- WorldLimitCallback
- WorldLimitMax
- WorldLimitMin
- WorldLimitMode
- t2dSceneObjectGroup
t2dSceneObjectSet
- t2dSceneObjectSet
SimSet
-
Methods
- getFlipX()
- getFlipY()
- getGraphGroup()
- - Returns the graph group.
- getHeight()
- getLayer()
- getPositionX()
- getPositionY()
- getRotation()
- getWidth()
- setFlipX(flipX)
- setFlipY(flipY)
- setGraphGroup(graph group)
- setHeight(height)
- setLayer(layer)
- setPositionX(x position)
- setPositionY(y position)
- setRotation(height)
- setWidth(width)
- t2dSceneWindow
GuiControl
-
Methods
- completeCameraMove()
- dismount()
- Dismounts Camera from object.
- getCanvasPoint(X / Y)
- - Returns Canvas coordinate of Window coordinate.
- getCurrentCameraArea()
- getCurrentCameraPosition()
- Get current camera Position.
- getCurrentCameraZoom()
- getIsCameraMounted()
- Is Camera Mounted Status.
- getIsCameraMoving()
- getIsWindowPoint(X / Y)
- - Checks if World coordinate is inside Window.
- getLockMouse()
- Gets the window mouse-lock status.
- getMousePosition()
- Gets Current Mouse Position.
- getRenderGroupMask()
- - Gets the group mask which controls what is rendered.
- getRenderLayerMask()
- - Gets the layer mask which controls what is rendered.
- getSceneGraph()
- - Returns the t2dSceneGraph associated with this window.
- 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$)
- setObjectMouseEventInvisibleFilter()
- useInvisible - Sets the use invisible flag
- setObjectMouseEventLayerFilter(layers$)
- 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()
- setViewLimitOn([minX / minY / maxX / maxY])
- startCameraMove([interpolationTime])
- startCameraShake(shakeMagnitude, time)
- - Starts the camera shaking.
- stopCameraMove()
- stopCameraShake()
- Stops the camera shaking.
- undoCameraMove([interpolationTime])
Fields
- lockMouse
- useObjectMouseEvents
- bool useObjectMouseEvents
- useWindowMouseEvents
- bool useWindowMouseEvents
- t2dScroller
t2dSceneObject
-
Methods
- getImageMap()
- getRepeatX()
- getRepeatY()
- getScrollPositionX()
- getScrollPositionY()
- getScrollX()
- getScrollY()
- setImageMap(imageMapName$)
- - Sets the imageMap Name.
- setRepeat(repeatX / repeatY)
- - Sets the Repeat X/Y repetition.
- setRepeatX(repeatX)
- setRepeatY(repeatY)
- setScroll(offsetX / offsetY)
- setScrollPolar(angle, scrollSpeed)
- - Sets Auto-Pan Polarwise.
- setScrollPosition(positionX / positionY)
- - Sets the Scroll position X/Y.
- setScrollPositionX(ScrollPositionX)
- setScrollPositionY(ScrollPositionY)
- setScrollX(ScrollX)
- setScrollY(ScrollY)
Fields
- imageMap
- repeatX
- repeatY
- scrollPositionX
- scrollPositionY
- scrollX
- scrollY
- t2dShape3D
t2dSceneObject
-
Methods
- getCurrentDetailLevel()
- getCurrentIntraDetailLevel()
- getDetailLevelCount()
- getShapeAngularVelocity()
- getShapeOffset()
- getShapeRotation()
- getShapeScale()
- getTextureFileList()
- - Retrieves a tab separated list of all textures used by this shape.
- 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)
- setShapeRotation(x / y / z)
- setShapeScale(x [/ y / z])
- setSkin( skinSet$, skinName$ )
- - Changes the skin to the specified texture
- setTimeScale( timeScale )
- - Set the animation time-scale.
- setTriggerActive(status)
Fields
- animation
- detailLevel
- intraDetailLevel
- shape
- shapeAngularVelocity
- Point3F shapeAngularVelocity
- shapeOffset
- shapeRotation
- shapeScale
- t2dShapeVector
t2dSceneObject
-
Methods
- 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$)
- setPolyPrimitive(vertexCount)
- - Sets a regular polygon primitive.
- setPolyScale(widthScale / [heightScale])
- - Sets the polygon scale.
- t2dStaticSprite
t2dSceneObject
-
Methods
- getFrame()
- Gets current imageMap Frame.
- getImageMap()
- Gets current imageMap name.
- setFrame(frame)
- setImageMap(imageMapName$, [int frame])
Fields
- t2dTestTile
t2dActiveTile
- t2dTestTileDatablock
t2dActiveTileDatablock
- t2dTextObject
t2dSceneObject
Fields
- aspectRatio
- autoSize
- characterSpacing
- font
- fontColor
- fontSize
- lineHeight
- lineSpacing
- renderMode
- text
- t2dTileLayer
t2dSceneObject
-
Methods
- clearLayer()
- - Deletes All Layer Tiles.
- clearTile( tileX / tileY )
- getAutoPanX(autoPanX)
- getAutoPanY(autoPanY)
- getPanPositionX(autoPanX)
- getPanPositionY(autoPanY)
- getTileCollision( x / y )
- - Gets a tile collision options.
- getTileCount()
- getTileCountX()
- getTileCountY()
- getTileCustomData( x / y )
- - Gets a tile custom-data.
- getTileFlip( x / y )
- - Gets a tile flip options.
- getTileScript( x / y )
- getTileScriptActioned( x / y )
- - Gets a tile script actioned-flag.
- getTileSize()
- getTileSizeX()
- getTileSizeY()
- getTileType( x / y )
- getWrapX(wrapX)
- getWrapY(wrapY)
- 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 )
- saveTileLayer(tileLayerFile$)
- - Saves a Tile-Layer File.
- setActiveTile(tileX / tileY, activeTileClass, [activeTileDatablockName])
- setAnimatedTile( tileX / tileY, animationName, [forceUnique])
- setAutoPan(autoPanX / autoPanY)
- setAutoPanPolar(angle, panSpeed)
- - Sets Auto-Pan Polarwise.
- setAutoPanX(autoPanX)
- setAutoPanY(autoPanY)
- setCursorIconActive(status, blinkTime)
- - Set cursor-icon status.
- setCursorPosition(x / y)
- setCustomIconActive(status)
- - Set custom-data-icon status.
- setGridActive(status)
- setPanPosition(panX / panY)
- setPanPositionX(autoPanX)
- setPanPositionY(autoPanY)
- setScriptIconActive(status)
- - Set script-icon status.
- setStaticTile( tileX / tileY, imageMapName, [frame] )
- 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.
- setTileCountX()
- setTileCountY()
- setTileCustomData(tileX / tileY, data)
- - Sets custom data on a Tile.
- setTileFlip(tileX / tileY, flipHorz, flipVert)
- setTileIcons(tileIconImageMap)
- - Set tile-icons imagemap.
- setTileScript(tileX / tileY, script)
- - Sets a Script on a Tile.
- setTileSize(tileSizeX / [tileSizeY])
- setTileSizeX()
- setTileSizeY()
- setWrap(wrapX, wrapY)
- setWrapX(wrapX)
- setWrapY(wrapY)
Fields
- t2dTileMap
t2dSceneObject
-
Methods
- addTileLayer()
- createTileLayer(tileCountX / tileCountY / tileSizeX / tileSizeY)
- deleteAllLayers()
- Deletes all Tile Layer(s).
- deleteTileLayer(layerIndex)
- deleteTileLayerId(tileLayerID)
- - Deletes a Tile Layer (by Id).
- getTileLayer(layerIndex)
- - Returns Tile Layer by Index.
- getTileLayerCount()
- Returns Tile Layer Count.
- loadTileMap(tileMapFile$)
- loadTileMapDataBlock(tileMapDatablock$)
- - Loads a Tilemap from a Datablock.
- removeTileLayer()
- saveTileMap(tileMapFile$)
- setAllLayersToParent()
- Synchronizes all tile-layers to parents position/size/rotation.
- t2dTrigger
t2dSceneObject
-
Methods
- getEnterCallback()
- getLeaveCallback()
- getStayCallback()
- setEnterCallback(true)
- setLeaveCallback(true)
- setStayCallback(true)
Fields
- EnterCallback
- LeaveCallback
- StayCallback
- TCPObject
SimObject
-
Methods
- 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
- TSShapeConstructor
SimDataBlock
Fields
- baseShape
- sequence0
- sequence1
- sequence10
- sequence100
- sequence101
- sequence102
- sequence103
- sequence104
- sequence105
- sequence106
- sequence107
- sequence108
- sequence109
- sequence11
- sequence110
- sequence111
- sequence112
- sequence113
- sequence114
- sequence115
- sequence116
- sequence117
- sequence118
- sequence119
- sequence12
- sequence120
- sequence121
- sequence122
- sequence123
- sequence124
- sequence125
- sequence126
- sequence13
- sequence14
- sequence15
- sequence16
- sequence17
- sequence18
- sequence19
- sequence2
- sequence20
- sequence21
- sequence22
- sequence23
- sequence24
- sequence25
- sequence26
- sequence27
- sequence28
- sequence29
- sequence3
- sequence30
- sequence31
- sequence32
- sequence33
- sequence34
- sequence35
- sequence36
- sequence37
- sequence38
- sequence39
- sequence4
- sequence40
- sequence41
- sequence42
- sequence43
- sequence44
- sequence45
- sequence46
- sequence47
- sequence48
- sequence49
- sequence5
- sequence50
- sequence51
- sequence52
- sequence53
- sequence54
- sequence55
- sequence56
- sequence57
- sequence58
- sequence59
- sequence6
- sequence60
- sequence61
- sequence62
- sequence63
- sequence64
- sequence65
- sequence66
- sequence67
- sequence68
- sequence69
- sequence7
- sequence70
- sequence71
- sequence72
- sequence73
- sequence74
- sequence75
- sequence76
- sequence77
- sequence78
- sequence79
- sequence8
- sequence80
- sequence81
- sequence82
- sequence83
- sequence84
- sequence85
- sequence86
- sequence87
- sequence88
- sequence89
- sequence9
- sequence90
- sequence91
- sequence92
- sequence93
- sequence94
- sequence95
- sequence96
- sequence97
- sequence98
- sequence99
- UndoAction
SimObject
-
Methods
- addToManager([undoManager])
Fields
- actionName
- A brief description of the action, for UI representation of this undo/redo action.
- UndoManager
SimObject
-
Methods
- clearAll()
- getNextRedoName()
- getNextUndoName()
- getRedoCount()
- getRedoName(index)
- getUndoCount()
- getUndoName(index)
- redo()
- undo()
Fields
- numLevels
- Number of undo & redo levels.
- UndoScriptAction
UndoAction
Fields
- class
- superclass
- Script SuperClass of object.
- UnknownChunk
SimChunk
-
Functions
- activateDirectInput()
- Activate input. (ie, grab the mouse again so the user can play our game.
- activateKeyboard()
- activatePackage(packageName)
- addBitToMask( mask, bit )
- - Returns the mask with a bit added to it
- 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)
- 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()
- backtrace()
- bit()
- Converts a bit-position into a value.
- bitInverse()
- Returns the ones complement of a bit.
- bits()
- Converts a list of bit-positions into a value.
- buildTaggedString(string format, ...)
- call(funcName [,args ...])
- cancel(eventId)
- cancelServerQuery()
- clearTextureHolds()
- cls()
- 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")
- dbgDisconnect()
- Forcibly disconnects any attached script debugging client.
- dbgIsConnected()
- Returns true if a script debugging client is connected else return false.
- 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.
- findFirstFileMultiExpr(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.
- findNextFileMultiExpr(string pattern)
- Returns the next file matching a search begun in findFirstFile.
- firstWord(text)
- flushTextureCache()
- 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.
- getDirectoryList(%path, %depth)
- 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
- getFileCountMultiExpr(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()
- 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 URL 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.
- initDisplayDeviceInfo()
- 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)
- 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()
- 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()
- quitWithErrorMessage(msg)
- - Quit, showing the provided error message. This is equivalent to an AssertISV.
- recompileAllImageMaps()
- Recompiles all image map datablocks
- 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()
- redbookOpen(string device=NULL)
- redbookPlay(int track)
- redbookSetVolume(float volume)
- redbookStop()
- removeBitFromMask( mask, bit )
- - Returns the mask with a bit removed from it
- removeField(text, index)
- removeRecord(text, index)
- removeTaggedString(int tag)
- removeWord(text, index)
- restartInstance()
- 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)
- setDefaultSceneObjectDatablock()
- 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)
- 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$)
- 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$)
- t2dVectorNormalise(t2dVector v1$)
- t2dVectorScale(t2dVector v1$, scale)
- - Returns v1 scaled by scale.
- t2dVectorSub(t2dVector v1$, t2dVector 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)
- 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)
- videoSetGammaCorrection()
- setGammaCorrection(gamma);
- warn(text [, ... ])
- writeFontCache()
- - force all cached fonts toserialize themselves to the cache.