Regular API reference

The list of API functions below allows you to access many CoppeliaSim parameters. There are however too many parameters in CoppeliaSim to have a specific API function for each one of them. Auxiliary parameters can be accessed via a set of given functions that use object parameter IDs. Refer also to the global parameter IDs.
All units going to, or coming from the API are in meters, kilograms, seconds and radians or a combination of those (unless otherwise explicitly indicated).

File operations

sim.closeScene (Lua)                                   simCloseScene (C/C++)
sim.saveScene (Lua)                                    simSaveScene (C/C++)
sim.loadScene (Lua)                                    simLoadScene (C/C++)
sim.saveModel (Lua)                                    simSaveModel (C/C++)
sim.loadModel (Lua)                                    simLoadModel (C/C++)
                                                       simDoesFileExist (C/C++)
sim.importShape (Lua)                                  simImportShape (C/C++)
sim.importMesh (Lua)                                   simImportMesh (C/C++)
sim.exportMesh (Lua)                                   simExportMesh (C/C++)
sim.launchExecutable (Lua)
sim.fileDialog (Lua)                                   simFileDialog (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)

General object handle retrieval

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.getScriptHandle (Lua)                              simGetScriptHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.getObjects (Lua)                                   simGetObjects (C/C++)
sim.getObjectsInTree (Lua)                             simGetObjectsInTree (C/C++)
sim.getCollectionObjects (Lua)                         simGetCollectionObjects (C/C++)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)

General functionality handling

                                                       simHandleMainScript (C/C++)
sim.handleChildScripts (Lua)
sim.handleCustomizationScripts (Lua)
sim.handleAddOnScripts (Lua)
sim.handleSandboxScript (Lua)

Collision detection

sim.checkCollision (Lua)                               simCheckCollision (C/C++)
sim.checkCollisionEx (Lua)                             simCheckCollisionEx (C/C++)

Minimum distance calculation

sim.checkDistance (Lua)                                simCheckDistance (C/C++)

Dynamics

sim.handleDynamics (Lua)                               simHandleDynamics (C/C++)
sim.setJointTargetPosition (Lua)                       simSetJointTargetPosition (C/C++)
sim.setJointTargetVelocity (Lua)                       simSetJointTargetVelocity (C/C++)
sim.readForceSensor (Lua)                              simReadForceSensor (C/C++)
sim.breakForceSensor (Lua)                             simBreakForceSensor (C/C++)
sim.getJointForce (Lua)                                simGetJointForce (C/C++)
sim.getJointMaxForce (Lua)                             simGetJointMaxForce (C/C++)
sim.setJointMaxForce (Lua)                             simSetJointMaxForce (C/C++)
sim.addForce (Lua)                                     simAddForce (C/C++)
sim.addForceAndTorque (Lua)                            simAddForceAndTorque (C/C++)
sim.getVelocity (Lua)                                  simGetVelocity (C/C++)
sim.getLinkDummy (Lua)                                 simGetLinkDummy (C/C++)
sim.setLinkDummy (Lua)                                 simSetLinkDummy (C/C++)
sim.resetDynamicObject (Lua)                           simResetDynamicObject (C/C++)
sim.addParticleObject (Lua)                            simAddParticleObject (C/C++)
sim.addParticleObjectItem (Lua)                        simAddParticleObjectItem (C/C++)
sim.removeParticleObject (Lua)                         simRemoveParticleObject (C/C++)
sim.getContactInfo (Lua)                               simGetContactInfo (C/C++)
sim.getShapeMass (Lua)                                 simGetShapeMass (C/C++)
sim.setShapeMass (Lua)                                 simSetShapeMass (C/C++)
sim.getShapeInertia (Lua)                              simGetShapeInertia (C/C++)
sim.setShapeInertia (Lua)                              simSetShapeInertia (C/C++)
sim.computeMassAndInertia (Lua)                        simComputeMassAndInertia (C/C++)
sim.createForceSensor (Lua)                            simCreateForceSensor (C/C++)
sim.convexDecompose (Lua)                              simConvexDecompose (C/C++)
sim.getQHull (Lua)                                     simGetQHull (C/C++)
sim.getDecimatedMesh (Lua)                             simGetDecimatedMesh (C/C++)
sim.isDynamicallyEnabled (Lua)                         simIsDynamicallyEnabled (C/C++)
sim.setShapeMaterial (Lua)                             simSetShapeMaterial (C/C++)

See also:
physics engine parameter functions.

Proximity sensors

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleProximitySensor (Lua)                        simHandleProximitySensor (C/C++)
sim.readProximitySensor (Lua)                          simReadProximitySensor (C/C++)
sim.resetProximitySensor (Lua)                         simResetProximitySensor (C/C++)
sim.checkProximitySensor (Lua)                         simCheckProximitySensor (C/C++)
sim.checkProximitySensorEx (Lua)                       simCheckProximitySensorEx (C/C++)
sim.checkProximitySensorEx2 (Lua)                      simCheckProximitySensorEx2 (C/C++)
sim.createProximitySensor (Lua)                        simCreateProximitySensor (C/C++)

See also:
object parameter functions and parameters related to proximity sensors.

Vision sensors

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleVisionSensor (Lua)                           simHandleVisionSensor (C/C++)
sim.readVisionSensor (Lua)                             simReadVisionSensor (C/C++)
sim.resetVisionSensor (Lua)                            simResetVisionSensor (C/C++)
sim.checkVisionSensor (Lua)                            simCheckVisionSensor (C/C++)
sim.checkVisionSensorEx (Lua)                          simCheckVisionSensorEx (C/C++)
sim.getVisionSensorDepthBuffer (Lua)                   simGetVisionSensorDepthBuffer (C/C++)
sim.getVisionSensorCharImage (Lua)                     simGetVisionSensorCharImage (C/C++)
sim.setVisionSensorCharImage (Lua)                     simSetVisionSensorCharImage (C/C++)
sim.getVisionSensorImage (Lua)                         simGetVisionSensorImage (C/C++)
sim.setVisionSensorImage (Lua)                         simSetVisionSensorImage (C/C++)
sim.getVisionSensorResolution (Lua)                    simGetVisionSensorResolution (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
sim.createVisionSensor (Lua)                           simCreateVisionSensor (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)

See also:
object parameter functions and parameters related to vision sensors.

Force sensors

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.readForceSensor (Lua)                              simReadForceSensor (C/C++)
sim.breakForceSensor (Lua)                             simBreakForceSensor (C/C++)
sim.createForceSensor (Lua)                            simCreateForceSensor (C/C++)

See also:
object parameter functions and parameters related to force sensors.

Joints

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.setJointPosition (Lua)                             simSetJointPosition (C/C++)
sim.getJointPosition (Lua)                             simGetJointPosition (C/C++)
sim.setJointTargetPosition (Lua)                       simSetJointTargetPosition (C/C++)
sim.getJointTargetPosition (Lua)                       simGetJointTargetPosition (C/C++)
sim.setJointTargetVelocity (Lua)                       simSetJointTargetVelocity (C/C++)
sim.getJointTargetVelocity (Lua)                       simGetJointTargetVelocity (C/C++)
sim.getJointVelocity (Lua)                             simGetJointVelocity (C/C++)
sim.setSphericalJointMatrix (Lua)                      simSetSphericalJointMatrix (C/C++)
sim.getJointMatrix (Lua)                               simGetJointMatrix (C/C++)
sim.setJointInterval (Lua)                             simSetJointInterval (C/C++)
sim.getJointInterval (Lua)                             simGetJointInterval (C/C++)
sim.getJointType (Lua)                                 simGetJointType (C/C++)
sim.createJoint (Lua)                                  simCreateJoint (C/C++)
sim.setJointMode (Lua)                                 simSetJointMode (C/C++)
sim.getJointMode (Lua)                                 simGetJointMode (C/C++)
sim.setJointDependency (Lua)                           simSetJointDependency (C/C++)
sim.getJointDependency (Lua)                           simGetJointDependency (C/C++)
sim.getJointForce (Lua)                                simGetJointForce (C/C++)
sim.getJointMaxForce (Lua)                             simGetJointMaxForce (C/C++)
sim.setJointMaxForce (Lua)                             simSetJointMaxForce (C/C++)
sim.rmlPos (Lua)                                       simRMLPos (C/C++)
sim.rmlVel (Lua)                                       simRMLVel (C/C++)

See also:
object parameter functions and parameters related to joints.
physics engine parameter functions.

Shapes

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.addForce (Lua)                                     simAddForce (C/C++)
sim.addForceAndTorque (Lua)                            simAddForceAndTorque (C/C++)
sim.getVelocity (Lua)                                  simGetVelocity (C/C++)
sim.getShapeColor (Lua)                                simGetShapeColor (C/C++)
sim.setShapeColor (Lua)                                simSetShapeColor (C/C++)
sim.getShapeTextureId (Lua)                            simGetShapeTextureId (C/C++)
sim.setShapeTexture (Lua)                              simSetShapeTexture (C/C++)
sim.createMeshShape (Lua)                              simCreateMeshShape (C/C++)
sim.createPureShape (Lua)                              simCreatePureShape (C/C++)
sim.createHeightfieldShape (Lua)                       simCreateHeightfieldShape (C/C++)
sim.getShapeMesh (Lua)                                 simGetShapeMesh (C/C++)
sim.getShapeViz (Lua)                                  simGetShapeViz (C/C++)
                                                       simApplyTexture (C/C++)
sim.getShapeGeomInfo (Lua)                             simGetShapeGeomInfo (C/C++)
sim.getShapeMass (Lua)                                 simGetShapeMass (C/C++)
sim.setShapeMass (Lua)                                 simSetShapeMass (C/C++)
sim.getShapeInertia (Lua)                              simGetShapeInertia (C/C++)
sim.setShapeInertia (Lua)                              simSetShapeInertia (C/C++)
sim.computeMassAndInertia (Lua)                        simComputeMassAndInertia (C/C++)
sim.groupShapes (Lua)                                  simGroupShapes (C/C++)
sim.ungroupShape (Lua)                                 simUngroupShape (C/C++)
sim.importShape (Lua)                                  simImportShape (C/C++)
sim.convexDecompose (Lua)                              simConvexDecompose (C/C++)
sim.getQHull (Lua)                                     simGetQHull (C/C++)
sim.getDecimatedMesh (Lua)                             simGetDecimatedMesh (C/C++)
sim.reorientShapeBoundingBox (Lua)                     simReorientShapeBoundingBox (C/C++)
sim.setShapeMaterial (Lua)                             simSetShapeMaterial (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)

See also:
object parameter functions and parameters related to shapes.
physics engine parameter functions.

Graphs

sim.addGraphStream (Lua)                               simAddGraphStream (C/C++)
sim.setGraphStreamTransformation (Lua)                 simSetGraphStreamTransformation (C/C++)
sim.setGraphStreamValue (Lua)                          simSetGraphStreamValue (C/C++)
sim.addGraphCurve (Lua)                                simAddGraphCurve (C/C++)
sim.destroyGraphCurve (Lua)                            simDestroyGraphCurve (C/C++)
sim.duplicateGraphCurveToStatic (Lua)                  simDuplicateGraphCurveToStatic (C/C++)
sim.handleGraph (Lua)                                  simHandleGraph (C/C++)
sim.resetGraph (Lua)                                   simResetGraph (C/C++)

See also:
object parameter functions and parameters related to graphs.

Lights

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.getLightParameters (Lua)                           simGetLightParameters (C/C++)
sim.setLightParameters (Lua)                           simSetLightParameters (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)

See also:
object parameter functions and parameters related to lights.

Cameras

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.cameraFitToView (Lua)                              simCameraFitToView (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)

See also:
object parameter functions and parameters related to cameras.

Dummies

sim.createDummy (Lua)                                  simCreateDummy (C/C++)
sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.getLinkDummy (Lua)                                 simGetLinkDummy (C/C++)
sim.setLinkDummy (Lua)                                 simSetLinkDummy (C/C++)

See also:
object parameter functions and parameters related to dummies.

OC trees

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.createOctree (Lua)                                 simCreateOctree (C/C++)
sim.insertVoxelsIntoOctree (Lua)                       simInsertVoxelsIntoOctree (C/C++)
sim.removeVoxelsFromOctree (Lua)                       simRemoveVoxelsFromOctree (C/C++)
sim.insertObjectIntoOctree (Lua)                       simInsertObjectIntoOctree (C/C++)
sim.subtractObjectFromOctree (Lua)                     simSubtractObjectFromOctree (C/C++)
sim.getOctreeVoxels (Lua)                              simGetOctreeVoxels (C/C++)
sim.checkOctreePointOccupancy (Lua)                    simCheckOctreePointOccupancy (C/C++)

See also:
object parameter functions and parameters related to OC trees.

Point clouds

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.createPointCloud (Lua)                             simCreatePointCloud (C/C++)
sim.getPointCloudOptions (Lua)                         simGetPointCloudOptions (C/C++)
sim.setPointCloudOptions (Lua)                         simSetPointCloudOptions (C/C++)
sim.insertPointsIntoPointCloud (Lua)                   simInsertPointsIntoPointCloud (C/C++)
sim.removePointsFromPointCloud (Lua)                   simRemovePointsFromPointCloud (C/C++)
sim.subtractObjectFromPointCloud (Lua)                 simSubtractObjectFromPointCloud (C/C++)
sim.intersectPointsWithPointCloud (Lua)                simIntersectPointsWithPointCloud (C/C++)
sim.insertObjectIntoPointCloud (Lua)                   simInsertObjectIntoPointCloud (C/C++)
sim.getPointCloudPoints (Lua)                          simGetPointCloudPoints (C/C++)

See also:
object parameter functions and parameters related to point clouds.

Paths

sim.createPath (Lua)
sim.getConfigDistance (Lua)
sim.getPathLengths (Lua)
sim.getPathInterpolatedConfig (Lua)
sim.resamplePath (Lua)
sim.generateTimeOptimalTrajectory (Lua)
sim.generateShapeFromPath (Lua)                        simGenerateShapeFromPath (C/C++)
sim.getClosestPosOnPath (Lua)                          simGetClosestPosOnPath (C/C++)

Scene objects

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.removeObject (Lua)                                 simRemoveObject (C/C++)
sim.removeModel (Lua)                                  simRemoveModel (C/C++)
sim.getObjectName (Lua)                                simGetObjectName (C/C++)
sim.setObjectName (Lua)                                simSetObjectName (C/C++)
sim.getObjects (Lua)                                   simGetObjects (C/C++)
sim.getObjectsInTree (Lua)                             simGetObjectsInTree (C/C++)
sim.getObjectParent (Lua)                              simGetObjectParent (C/C++)
sim.setObjectParent (Lua)                              simSetObjectParent (C/C++)
sim.getObjectChild (Lua)                               simGetObjectChild (C/C++)
sim.getObjectMatrix (Lua)                              simGetObjectMatrix (C/C++)
sim.setObjectMatrix (Lua)                              simSetObjectMatrix (C/C++)
sim.getObjectPose (Lua)                                simGetObjectPose (C/C++)
sim.setObjectPose (Lua)                                simSetObjectPose (C/C++)
sim.getObjectPosition (Lua)                            simGetObjectPosition (C/C++)
sim.setObjectPosition (Lua)                            simSetObjectPosition (C/C++)
sim.getObjectOrientation (Lua)                         simGetObjectOrientation (C/C++)
sim.setObjectOrientation (Lua)                         simSetObjectOrientation (C/C++)
sim.getObjectQuaternion (Lua)                          simGetObjectQuaternion (C/C++)
sim.setObjectQuaternion (Lua)                          simSetObjectQuaternion (C/C++)
sim.getObjectType (Lua)                                simGetObjectType (C/C++)
sim.getObjectUniqueIdentifier (Lua)                    simGetObjectUniqueIdentifier (C/C++)
sim.getObjectConfiguration (Lua)                       simGetObjectConfiguration (C/C++)
sim.setObjectConfiguration (Lua)                       simSetObjectConfiguration (C/C++)
sim.getObjectSelection (Lua)                           simGetObjectSelection (C/C++)
                                                       simGetObjectSelectionSize (C/C++)
sim.getObjectSizeFactor (Lua)                          simGetObjectSizeFactor (C/C++)
sim.getObjectSizeValues (Lua)                          simGetObjectSizeValues (C/C++)
sim.setObjectSizeValues (Lua)                          simSetObjectSizeValues (C/C++)
sim.isObjectInSelection (Lua)                          simIsObjectInSelection (C/C++)
sim.addObjectToSelection (Lua)                         simAddObjectToSelection (C/C++)
sim.copyPasteObjects (Lua)                             simCopyPasteObjects (C/C++)
sim.scaleObject (Lua)                                  simScaleObject (C/C++)
sim.scaleObjects (Lua)                                 simScaleObjects (C/C++)
sim.getConfigurationTree (Lua)                         simGetConfigurationTree (C/C++)
sim.setConfigurationTree (Lua)                         simSetConfigurationTree (C/C++)
sim.getObjectProperty (Lua)                            simGetObjectProperty (C/C++)
sim.setObjectProperty (Lua)                            simSetObjectProperty (C/C++)
sim.getObjectSpecialProperty (Lua)                     simGetObjectSpecialProperty (C/C++)
sim.setObjectSpecialProperty (Lua)                     simSetObjectSpecialProperty (C/C++)
sim.rmlPos (Lua)                                       simRMLPos (C/C++)
sim.rmlVel (Lua)                                       simRMLVel (C/C++)
sim.getObjectVelocity (Lua)                            simGetObjectVelocity (C/C++)
sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)
sim.isDynamicallyEnabled (Lua)                         simIsDynamicallyEnabled (C/C++)

See also:
object parameter functions and parameters related to scene objects.

Collections

sim.createCollection (Lua)                             simCreateCollection (C/C++)
sim.destroyCollection (Lua)                            simDestroyCollection (C/C++)
sim.addItemToCollection (Lua)                          simAddItemToCollection (C/C++)
sim.getCollectionObjects (Lua)                         simGetCollectionObjects (C/C++)

Serial port

sim.serialCheck (Lua)                                  simSerialCheck (C/C++)
sim.serialClose (Lua)                                  simSerialClose (C/C++)
sim.serialOpen (Lua)                                   simSerialOpen (C/C++)
sim.serialRead (Lua)                                   simSerialRead (C/C++)
sim.serialSend (Lua)                                   simSerialSend (C/C++)

Rendering

sim.addDrawingObject (Lua)                             simAddDrawingObject (C/C++)
sim.addDrawingObjectItem (Lua)                         simAddDrawingObjectItem (C/C++)
sim.removeDrawingObject (Lua)                          simRemoveDrawingObject (C/C++)
sim.getShapeColor (Lua)                                simGetShapeColor (C/C++)
sim.setShapeColor (Lua)                                simSetShapeColor (C/C++)
sim.changeEntityColor (Lua)
sim.restoreEntityColor (Lua)

Particle objects

sim.addParticleObject (Lua)                            simAddParticleObject (C/C++)
sim.addParticleObjectItem (Lua)                        simAddParticleObjectItem (C/C++)
sim.removeParticleObject (Lua)                         simRemoveParticleObject (C/C++)

Generic dialogs

sim.displayDialog (Lua)                                simDisplayDialog (C/C++)
sim.getDialogInput (Lua)                               simGetDialogInput (C/C++)
sim.getDialogResult (Lua)                              simGetDialogResult (C/C++)
sim.endDialog (Lua)                                    simEndDialog (C/C++)

Models

sim.getModelProperty (Lua)                             simGetModelProperty (C/C++)
sim.setModelProperty (Lua)                             simSetModelProperty (C/C++)
sim.saveModel (Lua)                                    simSaveModel (C/C++)
sim.loadModel (Lua)                                    simLoadModel (C/C++)

Object selection

sim.getObjectSelection (Lua)                           simGetObjectSelection (C/C++)
                                                       simGetObjectSelectionSize (C/C++)
sim.isObjectInSelection (Lua)                          simIsObjectInSelection (C/C++)
sim.removeObjectFromSelection (Lua)                    simRemoveObjectFromSelection (C/C++)
sim.addObjectToSelection (Lua)                         simAddObjectToSelection (C/C++)

Object creation

sim.createDummy (Lua)                                  simCreateDummy (C/C++)
sim.createForceSensor (Lua)                            simCreateForceSensor (C/C++)
sim.createHeightfieldShape (Lua)                       simCreateHeightfieldShape (C/C++)
sim.createJoint (Lua)                                  simCreateJoint (C/C++)
sim.createMeshShape (Lua)                              simCreateMeshShape (C/C++)
sim.createProximitySensor (Lua)                        simCreateProximitySensor (C/C++)
sim.createPureShape (Lua)                              simCreatePureShape (C/C++)
sim.createVisionSensor (Lua)                           simCreateVisionSensor (C/C++)
sim.createOctree (Lua)                                 simCreateOctree (C/C++)
sim.createPointCloud (Lua)                             simCreatePointCloud (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)

Scripts

sim.getRandom (Lua)
sim.getScriptHandle (Lua)                              simGetScriptHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.addScript (Lua)                                    simAddScript (C/C++)
sim.initScript (Lua)                                   simInitScript (C/C++)
sim.removeScript (Lua)                                 simRemoveScript (C/C++)
                                                       simGetScript (C/C++)
sim.getScriptAssociatedWithObject (Lua)                simGetScriptAssociatedWithObject (C/C++)
sim.getCustomizationScriptAssociatedWithObject (Lua)   simGetCustomizationScriptAssociatedWithObject (C/C++)
sim.getScriptAttribute (Lua)                           simGetScriptAttribute (C/C++)
sim.setScriptAttribute (Lua)                           simSetScriptAttribute (C/C++)
sim.callScriptFunction (Lua)                           simCallScriptFunction (C/C++)
                                                       simCallScriptFunctionEx (C/C++)
sim.executeScriptString (Lua)                          simExecuteScriptString (C/C++)
sim.getApiFunc (Lua)                                   simGetApiFunc (C/C++)
sim.getApiInfo (Lua)                                   simGetApiInfo (C/C++)
                                                       simHandleMainScript (C/C++)
sim.handleChildScripts (Lua)
sim.handleCustomizationScripts (Lua)
sim.handleAddOnScripts (Lua)
sim.handleSandboxScript (Lua)
                                                       simResetScript (C/C++)
sim.getScriptName (Lua)                                simGetScriptName (C/C++)
                                                       simGetScriptProperty (C/C++)
                                                       simGetScriptText (C/C++)
sim.setScriptText (Lua)                                simSetScriptText (C/C++)
sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
sim.registerScriptFunction (Lua)                       simRegisterScriptCallbackFunction (C/C++)
sim.registerScriptVariable (Lua)                       simRegisterScriptVariable (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)


sim.getStackTraceback (Lua)

Simulation

sim.startSimulation (Lua)                              simStartSimulation (C/C++)
sim.pauseSimulation (Lua)                              simPauseSimulation (C/C++)
sim.stopSimulation (Lua)                               simStopSimulation (C/C++)
                                                       simAdvanceSimulationByOneStep (C/C++)
sim.getSimulationState (Lua)                           simGetSimulationState (C/C++)
sim.getSimulationTime (Lua)                            simGetSimulationTime (C/C++)
sim.getSimulationTimeStep (Lua)                        simGetSimulationTimeStep (C/C++)
                                                       simGetSimulationPassesPerRenderingPass (C/C++)
                                                       simSetSimulationPassesPerRenderingPass (C/C++)
sim.getRealTimeSimulation (Lua)                        simGetRealTimeSimulation (C/C++)
                                                       simAdjustRealTimeTimer (C/C++)
                                                       simIsRealTimeSimulationStepNeeded (C/C++)



Threads

sim.setThreadSwitchTiming (Lua)
sim.getThreadAutomaticSwitch (Lua)
sim.setThreadAutomaticSwitch (Lua
sim.getThreadSwitchAllowed (Lua)
sim.setThreadSwitchAllowed (Lua
sim.switchThread (Lua)

Customization

sim.getModuleInfo (Lua)                                simGetModuleInfo (C/C++)
sim.setModuleInfo (Lua)                                simSetModuleInfo (C/C++)
sim.loadModule (Lua)                                   simLoadModule (C/C++)
                                                       simSendModuleMessage (C/C++)
sim.unloadModule (Lua)                                 simUnloadModule (C/C++)
                                                       simBroadcastMessage (C/C++)
                                                       simAddModuleMenuEntry (C/C++)
                                                       simSetModuleMenuItemState (C/C++)
sim.getSimulatorMessage (Lua)                          simGetSimulatorMessage (C/C++)
sim.fileDialog (Lua)                                   simFileDialog (C/C++)
sim.msgBox (Lua)                                       simMsgBox (C/C++)
sim.quitSimulator (Lua)                                simQuitSimulator (C/C++)
                                                       simEnableEventCallback (C/C++)
sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)
                                                       simOpenTextEditor (C/C++)
sim.textEditorClose (Lua)
sim.textEditorGetInfo (Lua)
sim.textEditorOpen (Lua)
sim.textEditorShow (Lua)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)
sim.addLog (Lua)                                       simAddLog (C/C++)

Custom scripts

sim.registerScriptFunction (Lua)                       simRegisterScriptCallbackFunction (C/C++)
sim.registerScriptVariable (Lua)                       simRegisterScriptVariable (C/C++)

Transformations

sim.buildIdentityMatrix (Lua)                          simBuildIdentityMatrix (C/C++)
sim.buildMatrix (Lua)                                  simBuildMatrix (C/C++)
sim.buildMatrixQ (Lua)                                 simBuildMatrixQ (C/C++)
sim.getEulerAnglesFromMatrix (Lua)                     simGetEulerAnglesFromMatrix (C/C++)
sim.getQuaternionFromMatrix (Lua)                      simGetQuaternionFromMatrix (C/C++)
sim.multiplyMatrices (Lua)                             simMultiplyMatrices (C/C++)
sim.interpolateMatrices (Lua)                          simInterpolateMatrices (C/C++)
sim.invertMatrix (Lua)                                 simInvertMatrix (C/C++)
sim.getObjectMatrix (Lua)                              simGetObjectMatrix (C/C++)
sim.setObjectMatrix (Lua)                              simSetObjectMatrix (C/C++)
sim.getObjectPose (Lua)                                simGetObjectPose (C/C++)
sim.setObjectPose (Lua)                                simSetObjectPose (C/C++)
sim.getObjectPosition (Lua)                            simGetObjectPosition (C/C++)
sim.setObjectPosition (Lua)                            simSetObjectPosition (C/C++)
sim.getObjectOrientation (Lua)                         simGetObjectOrientation (C/C++)
sim.setObjectOrientation (Lua)                         simSetObjectOrientation (C/C++)
sim.getObjectQuaternion (Lua)                          simGetObjectQuaternion (C/C++)
sim.setObjectQuaternion (Lua)                          simSetObjectQuaternion (C/C++)
sim.setSphericalJointMatrix (Lua)                      simSetSphericalJointMatrix (C/C++)
sim.getJointMatrix (Lua)                               simGetJointMatrix (C/C++)
sim.multiplyVector (Lua)
                                                       simTransformVector (C/C++)
sim.getRotationAxis (Lua)                              simGetRotationAxis (C/C++)
sim.rotateAroundAxis (Lua)                             simRotateAroundAxis (C/C++)
sim.getObjectVelocity (Lua)                            simGetObjectVelocity (C/C++)
sim.reorientShapeBoundingBox (Lua)                     simReorientShapeBoundingBox (C/C++)
sim.alphaBetaGammaToYawPitchRoll (Lua)
sim.yawPitchRollToAlphaBetaGamma (Lua)

See also:
packing/unpacking functions

Messaging

sim.addLog (Lua)                                       simAddLog (C/C++)
sim.displayDialog (Lua)                                simDisplayDialog (C/C++)
sim.getDialogInput (Lua)                               simGetDialogInput (C/C++)
sim.getDialogResult (Lua)                              simGetDialogResult (C/C++)
sim.endDialog (Lua)                                    simEndDialog (C/C++)
                                                       simSetLastError (C/C++)
sim.loadModule (Lua)                                   simLoadModule (C/C++)
                                                       simSendModuleMessage (C/C++)
sim.unloadModule (Lua)                                 simUnloadModule (C/C++)
                                                       simBroadcastMessage (C/C++)
sim.getSimulatorMessage (Lua)                          simGetSimulatorMessage (C/C++)
sim.serialCheck (Lua)                                  simSerialCheck (C/C++)
sim.serialClose (Lua)                                  simSerialClose (C/C++)
sim.serialOpen (Lua)                                   simSerialOpen (C/C++)
sim.serialRead (Lua)                                   simSerialRead (C/C++)
sim.serialSend (Lua)                                   simSerialSend (C/C++)
sim.setIntegerSignal (Lua)                             simSetIntegerSignal (C/C++)
sim.getIntegerSignal (Lua)                             simGetIntegerSignal (C/C++)
sim.clearIntegerSignal (Lua)                           simClearIntegerSignal (C/C++)
sim.setFloatSignal (Lua)                               simSetFloatSignal (C/C++)
sim.getFloatSignal (Lua)                               simGetFloatSignal (C/C++)
sim.clearFloatSignal (Lua)                             simClearFloatSignal (C/C++)
sim.setDoubleSignal (Lua)                              simSetDoubleSignal (C/C++)
sim.getDoubleSignal (Lua)                              simGetDoubleSignal (C/C++)
sim.clearDoubleSignal (Lua)                            simClearDoubleSignal (C/C++)
sim.setStringSignal (Lua)                              simSetStringSignal (C/C++)
sim.getStringSignal (Lua)                              simGetStringSignal (C/C++)
sim.clearStringSignal (Lua)                            simClearStringSignal (C/C++)
sim.getSignalName (Lua)                                simGetSignalName (C/C++)
sim.waitForSignal (Lua)
sim.auxiliaryConsoleClose (Lua)                        simAuxiliaryConsoleClose (C/C++)
sim.auxiliaryConsoleOpen (Lua)                         simAuxiliaryConsoleOpen (C/C++)
sim.auxiliaryConsolePrint (Lua)                        simAuxiliaryConsolePrint (C/C++)
sim.persistentDataRead (Lua)                           simPersistentDataRead (C/C++)
sim.persistentDataWrite (Lua)                          simPersistentDataWrite (C/C++)
sim.getPersistentDataTags (Lua)                        simGetPersistentDataTags (C/C++)
sim.getMatchingPersistentDataTags (Lua)
                                                       simEnableEventCallback (C/C++)
sim.callScriptFunction (Lua)
                                                       simCallScriptFunctionEx (C/C++)
sim.executeScriptString (Lua)                          simExecuteScriptString (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)

Signals

sim.setIntegerSignal (Lua)                             simSetIntegerSignal (C/C++)
sim.getIntegerSignal (Lua)                             simGetIntegerSignal (C/C++)
sim.clearIntegerSignal (Lua)                           simClearIntegerSignal (C/C++)
sim.setFloatSignal (Lua)                               simSetFloatSignal (C/C++)
sim.getFloatSignal (Lua)                               simGetFloatSignal (C/C++)
sim.clearFloatSignal (Lua)                             simClearFloatSignal (C/C++)
sim.setDoubleSignal (Lua)                              simSetDoubleSignal (C/C++)
sim.getDoubleSignal (Lua)                              simGetDoubleSignal (C/C++)
sim.clearDoubleSignal (Lua)                            simClearDoubleSignal (C/C++)
sim.setStringSignal (Lua)                              simSetStringSignal (C/C++)
sim.getStringSignal (Lua)                              simGetStringSignal (C/C++)
sim.clearStringSignal (Lua)                            simClearStringSignal (C/C++)
sim.getSignalName (Lua)                                simGetSignalName (C/C++)
sim.waitForSignal (Lua)

See also:
data packing/unpacking.
persistent data.

Persistent Data

sim.persistentDataRead (Lua)                           simPersistentDataRead (C/C++)
sim.persistentDataWrite (Lua)                          simPersistentDataWrite (C/C++)
sim.getPersistentDataTags (Lua)                        simGetPersistentDataTags (C/C++)
sim.getMatchingPersistentDataTags (Lua)

Custom data blocks

sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)

See also:
data packing/unpacking.

Textures

                                                       simApplyTexture (C/C++)
sim.getTextureId (Lua)                                 simGetTextureId (C/C++)
sim.getShapeTextureId (Lua)                            simGetShapeTextureId (C/C++)
sim.readTexture (Lua)                                  simReadTexture (C/C++)
sim.saveImage (Lua)                                    simSaveImage (C/C++)
sim.loadImage (Lua)                                    simLoadImage (C/C++)
sim.getScaledImage (Lua)                               simGetScaledImage (C/C++)
sim.transformImage (Lua)                               simTransformImage (C/C++)
sim.writeTexture (Lua)                                 simWriteTexture (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)
sim.setShapeTexture (Lua)                              simSetShapeTexture (C/C++)

Blocking functions

sim.wait (Lua)
sim.waitForSignal (Lua)
sim.moveToConfig (Lua)
sim.moveToPose (Lua)
sim.displayDialog (Lua)
sim.serialRead (Lua)

Auxiliary consoles

sim.auxiliaryConsoleClose (Lua)                        simAuxiliaryConsoleClose (C/C++)
sim.auxiliaryConsoleOpen (Lua)                         simAuxiliaryConsoleOpen (C/C++)
sim.auxiliaryConsolePrint (Lua)                        simAuxiliaryConsolePrint (C/C++)
sim.auxiliaryConsoleShow (Lua)                         simAuxiliaryConsoleShow (C/C++)

See also:
Custom user interfaces.

Text/code editors

sim.textEditorClose (Lua)
sim.textEditorGetInfo (Lua)
sim.textEditorOpen (Lua)
sim.textEditorShow (Lua)

See also:
Custom user interfaces.

Import/export

sim.importShape (Lua)                                  simImportShape (C/C++)
sim.importMesh (Lua)                                   simImportMesh (C/C++)
sim.exportMesh (Lua)                                   simExportMesh (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)
sim.loadImage (Lua)                                    simLoadImage (C/C++)
sim.saveImage (Lua)                                    simSaveImage (C/C++)

See also:
Assimp plugin API reference.

Pages and views

sim.floatingViewAdd (Lua)                              simFloatingViewAdd (C/C++)
sim.floatingViewRemove (Lua)                           simFloatingViewRemove (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
sim.cameraFitToView (Lua)                              simCameraFitToView (C/C++)

Simulator parameters

sim.getArrayParameter (Lua)                            simGetArrayParameter (C/C++)
sim.setArrayParameter (Lua)                            simSetArrayParameter (C/C++)
sim.getBoolParameter (Lua)                             simGetBoolParameter (C/C++)
sim.setBoolParameter (Lua)                             simSetBoolParameter (C/C++)
sim.getInt32Parameter (Lua)                            simGetInt32Parameter (C/C++)
sim.setInt32Parameter (Lua)                            simSetInt32Parameter (C/C++)
sim.getFloatParameter (Lua)                            simGetFloatParameter (C/C++)
sim.setFloatParameter (Lua)                            simSetFloatParameter (C/C++)
sim.getStringParameter (Lua)                           simGetStringParameter (C/C++)
sim.setStringParameter (Lua)                           simSetStringParameter (C/C++)
sim.getStringNamedParam (Lua)                          simGetStringNamedParam (C/C++)
sim.setStringNamedParam (Lua)                          simSetStringNamedParam (C/C++)
                                                       simGetUInt64Parameter (C/C++)

Reflexxes Motion Library

sim.moveToConfig (Lua)
sim.moveToPose (Lua)
sim.rmlPos (Lua)                                       simRMLPos (C/C++)
sim.rmlVel (Lua)                                       simRMLVel (C/C++)
sim.rmlStep (Lua)                                      simRMLStep (C/C++)
sim.rmlRemove (Lua)                                    simRMLRemove (C/C++)

Packing / unpacking

sim.packTable (Lua)                                    simPackTable (C/C++)
sim.unpackTable (Lua)                                  simUnpackTable (C/C++)
sim.packUInt8Table (Lua)
sim.unpackUInt8Table (Lua)
sim.packUInt16Table (Lua)
sim.unpackUInt16Table (Lua)
sim.packUInt32Table (Lua)
sim.unpackUInt32Table (Lua)
sim.packInt32Table (Lua)
sim.unpackInt32Table (Lua)
sim.packFloatTable (Lua)
sim.unpackFloatTable (Lua)
sim.packDoubleTable (Lua)
sim.unpackDoubleTable (Lua)
sim.copyTable (Lua)
sim.transformBuffer (Lua)

Stacks

                                                       simCreateStack (C/C++)
                                                       simReleaseStack (C/C++)
                                                       simCopyStack (C/C++)
                                                       simPushNullOntoStack (C/C++)
                                                       simPushBoolOntoStack (C/C++)
                                                       simPushInt32OntoStack (C/C++)
                                                       simPushFloatOntoStack (C/C++)
                                                       simPushDoubleOntoStack (C/C++)
                                                       simPushStringOntoStack (C/C++)
                                                       simPushUInt8TableOntoStack (C/C++)
                                                       simPushInt32TableOntoStack (C/C++)
                                                       simPushFloatTableOntoStack (C/C++)
                                                       simPushDoubleTableOntoStack (C/C++)
                                                       simPushTableOntoStack (C/C++)
                                                       simInsertDataIntoStackTable (C/C++)
                                                       simGetStackSize (C/C++)
                                                       simPopStackItem (C/C++)
                                                       simMoveStackItemToTop (C/C++)
                                                       simIsStackValueNull (C/C++)
                                                       simGetStackBoolValue (C/C++)
                                                       simGetStackInt32Value (C/C++)
                                                       simGetStackFloatValue (C/C++)
                                                       simGetStackDoubleValue (C/C++)
                                                       simGetStackStringValue (C/C++)
                                                       simGetStackTableInfo (C/C++)
                                                       simGetStackUInt8Table (C/C++)
                                                       simGetStackInt32Table (C/C++)
                                                       simGetStackFloatTable (C/C++)
                                                       simGetStackDoubleTable (C/C++)
                                                       simUnfoldStackTable (C/C++)
                                                       simDebugStack (C/C++)
sim.packTable (Lua)                                    simPackTable (C/C++)
sim.unpackTable (Lua)                                  simUnpackTable (C/C++)

Object parameters

sim.getObjectInt32Parameter (Lua)                      simGetObjectInt32Parameter (C/C++)
sim.setObjectInt32Parameter (Lua)                      simSetObjectInt32Parameter (C/C++)
sim.getObjectFloatParameter (Lua)                      simGetObjectFloatParameter (C/C++)
sim.setObjectFloatParameter (Lua)                      simSetObjectFloatParameter (C/C++)
sim.getObjectStringParameter (Lua)                     simGetObjectStringParameter (C/C++)
sim.setObjectStringParameter (Lua)                     simSetObjectStringParameter (C/C++)

Physics engines

sim.getEngineFloatParameter (Lua)                      simGetEngineFloatParameter (C/C++)
sim.getEngineInt32Parameter (Lua)                      simGetEngineInt32Parameter (C/C++)
sim.getEngineBoolParameter (Lua)                       simGetEngineBoolParameter (C/C++)
sim.setEngineFloatParameter (Lua)                      simSetEngineFloatParameter (C/C++)
sim.setEngineInt32Parameter (Lua)                      simSetEngineInt32Parameter (C/C++)
sim.setEngineBoolParameter (Lua)                       simSetEngineBoolParameter (C/C++)

Other commands

sim.addLog (Lua)                                       simAddLog (C/C++)
sim.announceSceneContentChange (Lua)                   simAnnounceSceneContentChange (C/C++)
sim.getNavigationMode (Lua)                            simGetNavigationMode (C/C++)
sim.setNavigationMode (Lua)                            simSetNavigationMode (C/C++)
sim.getPage (Lua)                                      simGetPage (C/C++)
sim.setPage (Lua)                                      simSetPage (C/C++)
sim.displayDialog (Lua)                                simDisplayDialog (C/C++)
sim.getDialogInput (Lua)                               simGetDialogInput (C/C++)
sim.getDialogResult (Lua)                              simGetDialogResult (C/C++)
sim.endDialog (Lua)                                    simEndDialog (C/C++)
sim.getArrayParameter (Lua)                            simGetArrayParameter (C/C++)
sim.setArrayParameter (Lua)                            simSetArrayParameter (C/C++)
sim.getBoolParameter (Lua)                             simGetBoolParameter (C/C++)
sim.setBoolParameter (Lua)                             simSetBoolParameter (C/C++)
sim.getInt32Parameter (Lua)                            simGetInt32Parameter (C/C++)
sim.setInt32Parameter (Lua)                            simSetInt32Parameter (C/C++)
                                                       simGetUInt64Parameter (C/C++)
sim.getFloatParameter (Lua)                            simGetFloatParameter (C/C++)
sim.setFloatParameter (Lua)                            simSetFloatParameter (C/C++)
sim.getStringParameter (Lua)                           simGetStringParameter (C/C++)
sim.setStringParameter (Lua)                           simSetStringParameter (C/C++)
sim.getStringNamedParam (Lua)                          simGetStringNamedParam (C/C++)
sim.setStringNamedParam (Lua)                          simSetStringNamedParam (C/C++)
sim.getLastError (Lua)                                 simGetLastError (C/C++)
                                                       simSetLastError (C/C++)
sim.getModuleName (Lua)                                simGetModuleName (C/C++)
sim.getNavigationMode (Lua)                            simGetNavigationMode (C/C++)
sim.getSystemTime (Lua)                                simGetSystemTime (C/C++)
sim.getSystemTimeInMs (Lua)                            simGetSystemTimeInMs (C/C++)
sim.refreshDialogs (Lua)                               simRefreshDialogs (C/C++)
sim.setThreadSwitchTiming (Lua)
sim.switchThread (Lua)                                 simSwitchThread (C/C++)
sim.getExplicitHandling (Lua)                          simGetExplicitHandling (C/C++)
sim.setExplicitHandling (Lua)                          simSetExplicitHandling (C/C++)
sim.launchExecutable (Lua)
sim.fileDialog (Lua)                                   simFileDialog (C/C++)
sim.msgBox (Lua)                                       simMsgBox (C/C++)
sim.quitSimulator (Lua)                                simQuitSimulator (C/C++)
                                                       simEnableEventCallback (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)
                                                       simOpenTextEditor (C/C++)
sim.textEditorClose (Lua)
sim.textEditorGetInfo (Lua)
sim.textEditorOpen (Lua)
sim.textEditorShow (Lua)