Regular API function list (by category)

The list of API functions below allows you to access many V-REP parameters. There are however too many parameters in V-REP 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.

File operations

                                                       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.exportIk (Lua)                                     simExportIk (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.getCollectionHandle (Lua)                          simGetCollectionHandle (C/C++)
sim.getCollisionHandle (Lua)                           simGetCollisionHandle (C/C++)
sim.getDistanceHandle (Lua)                            simGetDistanceHandle (C/C++)
sim.getMechanismHandle (Lua)                           simGetMechanismHandle (C/C++)
sim.getIkGroupHandle (Lua)                             simGetIkGroupHandle (C/C++)
sim.getScriptHandle (Lua)                              simGetScriptHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.getObjectAssociatedWithScript (Lua)                simGetObjectAssociatedWithScript (C/C++)
sim.getObjects (Lua)                                   simGetObjects (C/C++)
sim.getObjectsInTree (Lua)                             simGetObjectsInTree (C/C++)
sim.getCollectionObjects (Lua)                         simGetCollectionObjects (C/C++)
sim.getNameSuffix (Lua)                                simGetNameSuffix (C/C++)
sim.setNameSuffix (Lua)                                simSetNameSuffix (C/C++)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)

General functionality handling

                                                       simHandleMainScript (C/C++)
sim.handleChildScripts (Lua)
sim.launchThreadedChildScripts (Lua)
                                                       simResetScript (C/C++)
sim.handleCollision (Lua)                              simHandleCollision (C/C++)
sim.resetCollision (Lua)                               simResetCollision (C/C++)
sim.handleDistance (Lua)                               simHandleDistance (C/C++)
sim.resetDistance (Lua)                                simResetDistance (C/C++)
sim.handleMechanism (Lua)                              simHandleMechanism (C/C++)
sim.handleGraph (Lua)                                  simHandleGraph (C/C++)
sim.resetGraph (Lua)                                   simResetGraph (C/C++)
sim.handleIkGroup (Lua)                                simHandleIkGroup (C/C++)
sim.handleModule (Lua)
sim.handleProximitySensor (Lua)                        simHandleProximitySensor (C/C++)
sim.resetProximitySensor (Lua)                         simResetProximitySensor (C/C++)
sim.handleVisionSensor (Lua)                           simHandleVisionSensor (C/C++)
sim.resetVisionSensor (Lua)                            simResetVisionSensor (C/C++)
sim.handleMill (Lua)                                   simHandleMill (C/C++)
sim.resetMill (Lua)                                    simResetMill (C/C++)
sim.applyMilling (Lua)                                 simApplyMilling (C/C++)
sim.resetMilling (Lua)                                 simResetMilling (C/C++)
sim.handleSensingStart (Lua)                           simHandleSensingStart (C/C++)
sim.handleSimulationStart (Lua)                        simHandleSimulationStart (C/C++)
sim.getExplicitHandling (Lua)                          simGetExplicitHandling (C/C++)
sim.setExplicitHandling (Lua)                          simSetExplicitHandling (C/C++)

Collision detection functionality

sim.getCollisionHandle (Lua)                           simGetCollisionHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleCollision (Lua)                              simHandleCollision (C/C++)
sim.readCollision (Lua)                                simReadCollision (C/C++)
sim.resetCollision (Lua)                               simResetCollision (C/C++)
sim.checkCollision (Lua)                               simCheckCollision (C/C++)
sim.checkCollisionEx (Lua)                             simCheckCollisionEx (C/C++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their collision object related parameters.

Minimum distance calculation functionality

sim.getDistanceHandle (Lua)                            simGetDistanceHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleDistance (Lua)                               simHandleDistance (C/C++)
sim.readDistance (Lua)                                 simReadDistance (C/C++)
sim.resetDistance (Lua)                                simResetDistance (C/C++)
sim.checkDistance (Lua)                                simCheckDistance (C/C++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their distance object related parameters.

IK and geometric constraint solver functionalities

sim.getIkGroupHandle (Lua)                             simGetIkGroupHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleIkGroup (Lua)                                simHandleIkGroup (C/C++)
sim.checkIkGroup (Lua)                                 simCheckIkGroup (C/C++)
sim.computeJacobian (Lua)                              simComputeJacobian (C/C++)
sim.setIkElementProperties (Lua)                       simSetIkElementProperties (C/C++)
sim.setIkGroupProperties (Lua)                         simSetIkGroupProperties (C/C++)
sim.getIkGroupMatrix (Lua)                             simGetIkGroupMatrix (C/C++)
sim.getMechanismHandle (Lua)                           simGetMechanismHandle (C/C++)
sim.handleMechanism (Lua)                              simHandleMechanism (C/C++)
sim.getLinkDummy (Lua)                                 simGetLinkDummy (C/C++)
sim.setLinkDummy (Lua)                                 simSetLinkDummy (C/C++)
sim.generateIkPath (Lua)                               simGenerateIkPath (C/C++)
sim.createIkGroup (Lua)                                simCreateIkGroup (C/C++)
sim.removeIkGroup (Lua)                                simRemoveIkGroup (C/C++)
sim.createIkElement (Lua)                              simCreateIkElement (C/C++)
sim.exportIk (Lua)                                     simExportIk (C/C++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their IK group and geometric constraint solver object related parameters.

Path/Motion planning functionality

OMPL plugin API functions with some explanation here
sim.getConfigForTipPose (Lua)                          simGetConfigForTipPose (C/C++)
sim.generateIkPath (Lua)                               simGenerateIkPath (C/C++)

Dynamics functionality

sim.handleDynamics (Lua)                               simHandleDynamics (C/C++)
sim.setJointTargetPosition (Lua)                       simSetJointTargetPosition (C/C++)
sim.setJointTargetVelocity (Lua)                       simSetJointTargetVelocity (C/C++)
sim.setJointForce (Lua)                                simSetJointForce (C/C++)
sim.readForceSensor (Lua)                              simReadForceSensor (C/C++)
sim.breakForceSensor (Lua)                             simBreakForceSensor (C/C++)
sim.getJointForce (Lua)                                simGetJointForce (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.getShapeMassAndInertia (Lua)                       simGetShapeMassAndInertia (C/C++)
sim.setShapeMassAndInertia (Lua)                       simSetShapeMassAndInertia (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.setShapeMaterial (Lua)                             simSetShapeMaterial (C/C++)
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++)

Proximity sensor functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their proximity sensor related parameters.

Vision sensor functionality

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.getVisionSensorFilter (Lua)                        simGetVisionSensorFilter (C/C++)
sim.setVisionSensorFilter (Lua)                        simSetVisionSensorFilter (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
sim.createVisionSensor (Lua)                           simCreateVisionSensor (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their vision sensor related parameters.

Force sensor functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their force sensor related parameters.

Milling functionality

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleMill (Lua)                                   simHandleMill (C/C++)
sim.resetMill (Lua)                                    simResetMill (C/C++)
sim.applyMilling (Lua)                                 simApplyMilling (C/C++)
sim.resetMilling (Lua)                                 simResetMilling (C/C++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their mill related parameters.

Joint object functionality

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.setJointForce (Lua)                                simSetJointForce (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.getJointForce (Lua)                                simGetJointForce (C/C++)
sim.rmlPos (Lua)                                       simRMLPos (C/C++)
sim.rmlVel (Lua)                                       simRMLVel (C/C++)
sim.rmlMoveToJointPositions (Lua)
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++)
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++)


See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their joint related parameters.

Path object functionality

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.setPathPosition (Lua)                              simSetPathPosition (C/C++)
sim.getPathPosition (Lua)                              simGetPathPosition (C/C++)
sim.getPathLength (Lua)                                simGetPathLength (C/C++)
sim.getOrientationOnPath (Lua)                         simGetOrientationOnPath (C/C++)
sim.getPositionOnPath (Lua)                            simGetPositionOnPath (C/C++)
sim.getDataOnPath (Lua)                                simGetDataOnPath (C/C++)
sim.getClosestPositionOnPath (Lua)                     simGetClosestPositionOnPath (C/C++)
sim.followPath (Lua)
sim.moveToObject (Lua)
sim.createPath (Lua)                                   simCreatePath (C/C++)
sim.insertPathCtrlPoints (Lua)                         simInsertPathCtrlPoints (C/C++)
sim.cutPathCtrlPoints (Lua)                            simCutPathCtrlPoints (C/C++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their path related parameters.

Shape object functionality

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++)
sim.getShapeGeomInfo (Lua)                             simGetShapeGeomInfo (C/C++)
sim.getShapeMassAndInertia (Lua)                       simGetShapeMassAndInertia (C/C++)
sim.setShapeMassAndInertia (Lua)                       simSetShapeMassAndInertia (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++)
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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their shape related parameters.

Graph object functionality

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.handleGraph (Lua)                                  simHandleGraph (C/C++)
sim.resetGraph (Lua)                                   simResetGraph (C/C++)
sim.setGraphUserData (Lua)                             simSetGraphUserData (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their graph related parameters.

Light object functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their light related parameters.

Camera object functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their camera related parameters.

Dummy object functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their dummy related parameters.

Mirror object functionality

sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their mirror related parameters.

Octree functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their octree related parameters.

Point cloud functionality

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++)
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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their point cloud related parameters.

Scene object functionality

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.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.moveToObject (Lua)
sim.rmlMoveToPosition (Lua)
sim.followPath (Lua)
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.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++)

See also the sim.setObjectXXXParameter and sim.getObjectXXXParameter functions
and their scene object related parameters.

Collections

sim.getCollectionHandle (Lua)                          simGetCollectionHandle (C/C++)
sim.getCollectionName (Lua)                            simGetCollectionName (C/C++)
sim.setCollectionName (Lua)                            simSetCollectionName (C/C++)
sim.getCollectionObjects (Lua)                         simGetCollectionObjects (C/C++)
sim.createCollection (Lua)                             simCreateCollection (C/C++)
sim.addObjectToCollection (Lua)                        simAddObjectToCollection (C/C++)
sim.emptyCollection (Lua)                              simEmptyCollection (C/C++)
sim.removeCollection (Lua)                             simRemoveCollection (C/C++)

Wireless communication functionality

sim.sendData (Lua)                                     simSendData (C/C++)
sim.receiveData (Lua)                                  simReceiveData (C/C++)

Serial communication functionality

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++)

Tube communication functionality

sim.tubeClose (Lua)                                    simTubeClose (C/C++)
sim.tubeOpen (Lua)                                     simTubeOpen (C/C++)
sim.tubeRead (Lua)                                     simTubeRead (C/C++)
sim.tubeStatus (Lua)                                   simTubeStatus (C/C++)
sim.tubeWrite (Lua)                                    simTubeWrite (C/C++)

Drawing object functionality

sim.addDrawingObject (Lua)                             simAddDrawingObject (C/C++)
sim.addDrawingObjectItem (Lua)                         simAddDrawingObjectItem (C/C++)
sim.removeDrawingObject (Lua)                          simRemoveDrawingObject (C/C++)

Banner functionality

sim.addBanner (Lua)                                    simAddBanner (C/C++)
sim.removeBanner (Lua)                                 simRemoveBanner (C/C++)

Particle object functionality

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

Generic dialog functionality

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

Model functionality

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 functionality

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 functionality

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.createPath (Lua)                                   simCreatePath (C/C++)
sim.createOctree (Lua)                                 simCreateOctree (C/C++)
sim.createPointCloud (Lua)                             simCreatePointCloud (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)
sim.createIkGroup (Lua)                                simCreateIkGroup (C/C++)
sim.createIkElement (Lua)                              simCreateIkElement (C/C++)

Script object functionality

sim.getScriptHandle (Lua)                              simGetScriptHandle (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.addScript (Lua)                                    simAddScript (C/C++)
sim.removeScript (Lua)                                 simRemoveScript (C/C++)
                                                       simGetScript (C/C++)
sim.getScriptAssociatedWithObject (Lua)                simGetScriptAssociatedWithObject (C/C++)
sim.getCustomizationScriptAssociatedWithObject (Lua)   simGetCustomizationScriptAssociatedWithObject (C/C++)
sim.getObjectAssociatedWithScript (Lua)                simGetObjectAssociatedWithScript (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.launchThreadedChildScripts (Lua)
                                                       simResetScript (C/C++)
sim.getScriptName (Lua)                                simGetScriptName (C/C++)
                                                       simGetScriptProperty (C/C++)
                                                       simGetScriptText (C/C++)
sim.setScriptText (Lua)                                simSetScriptText (C/C++)
sim.getScriptExecutionCount (Lua)
sim.isScriptExecutionThreaded (Lua)
                                                       simSetScriptRawBuffer (C/C++)
                                                       simGetScriptRawBuffer (C/C++)
                                                       simReleaseScriptRawBuffer (C/C++)
sim.setScriptSimulationParameter (Lua)                 simSetScriptSimulationParameter (C/C++)
sim.getScriptSimulationParameter (Lua)                 simGetScriptSimulationParameter (C/C++)
sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
                                                       simRegisterScriptCallbackFunction (C/C++)
                                                       simRegisterScriptVariable (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)

Simulation functionality

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++)

Thread related functionality

sim.setThreadSwitchTiming (Lua)
sim.getThreadAutomaticSwitch (Lua)
sim.setThreadAutomaticSwitch (Lua
sim.switchThread (Lua)                                 simSwitchThread (C/C++)
sim.setThreadResumeLocation (Lua)
sim.resumeThreads (Lua)
sim.isScriptExecutionThreaded (Lua)
sim.setThreadIsFree (Lua)                              simSetThreadIsFree (C/C++)
sim.launchExecutable (Lua)
sim.getThreadId (Lua)                                  simGetThreadId (C/C++)

Customization functionality

sim.getModuleInfo (Lua)                                simGetModuleInfo (C/C++)
                                                       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++)
sim.getThreadId (Lua)                                  simGetThreadId (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++)
sim.openTextEditor (Lua)                               simOpenTextEditor (C/C++)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)

Customizing Lua function

                                                       simRegisterScriptCallbackFunction (C/C++)
                                                       simRegisterScriptVariable (C/C++)

Lua boolean functions

sim.boolAnd32 (Lua)
sim.boolOr32 (Lua)
sim.boolXor32 (Lua)

C-API only functions (not available in Lua)

                                                       simSendModuleMessage (C/C++)
                                                       simSetModuleInfo (C/C++)
                                                       simBroadcastMessage (C/C++)
                                                       simAddModuleMenuEntry (C/C++)
                                                       simSetModuleMenuItemState (C/C++)
                                                       simGetMainWindow (C/C++)
                                                       simRunSimulator (C/C++)
                                                       simCreateBuffer (C/C++)
                                                       simReleaseBuffer (C/C++)
                                                       simGetScript (C/C++)
                                                       simHandleMainScript (C/C++)
                                                       simResetScript (C/C++)
                                                       simGetScriptProperty (C/C++)
                                                       simSetScriptRawBuffer (C/C++)
                                                       simGetScriptRawBuffer (C/C++)
                                                       simRegisterScriptCallbackFunction (C/C++)
                                                       simRegisterScriptVariable (C/C++)
                                                       simCloseScene (C/C++)
                                                       simDoesFileExist (C/C++)
                                                       simAdvanceSimulationByOneStep (C/C++)
                                                       simGetSimulationPassesPerRenderingPass (C/C++)
                                                       simAdjustRealTimeTimer (C/C++)
                                                       simIsRealTimeSimulationStepNeeded (C/C++)
                                                       simTransformVector (C/C++)
                                                       simEnableEventCallback (C/C++)
                                                       simLockResources (C/C++)
                                                       simUnlockResources (C/C++)

Lua-API only functions (not available in C/C++)

sim.openModule (Lua)
sim.handleModule (Lua)
sim.closeModule (Lua)
sim.boolAnd32 (Lua)
sim.boolOr32 (Lua)
sim.boolXor32 (Lua)
sim.getScriptExecutionCount (Lua)
sim.isScriptExecutionThreaded (Lua)
sim.handleChildScripts (Lua)
sim.launchThreadedChildScripts (Lua)
sim.multiplyVector (Lua)
sim.setThreadSwitchTiming (Lua)
sim.waitForSignal (Lua)
sim.moveToObject (Lua)
sim.rmlMoveToPosition (Lua)
sim.rmlMoveToJointPositions (Lua)
sim.followPath (Lua)
sim.packUInt8Table (Lua)
sim.packDoubleTable (Lua)
sim.packFloatTable (Lua)
sim.packInt32Table (Lua)
sim.packUInt32Table (Lua)
sim.packUInt16Table (Lua)
sim.unpackUInt8Table (Lua)
sim.unpackDoubleTable (Lua)
sim.unpackFloatTable (Lua)
sim.unpackInt32Table (Lua)
sim.unpackUInt32Table (Lua)
sim.unpackUInt16Table (Lua)
sim.transformBuffer (Lua)
sim.wait (Lua)
sim.launchExecutable (Lua)
sim.setThreadResumeLocation (Lua)
sim.getThreadAutomaticSwitch (Lua)
sim.setThreadAutomaticSwitch (Lua
sim.resumeThreads (Lua)

Matrix operations & transformations

sim.buildIdentityMatrix (Lua)                          simBuildIdentityMatrix (C/C++)
sim.buildMatrix (Lua)                                  simBuildMatrix (C/C++)
sim.buildMatrixQ (Lua)                                 simBuildMatrixQ (C/C++)
sim.copyMatrix (Lua)                                   simCopyMatrix (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.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++)

Messaging commands

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.addStatusbarMessage (Lua)                          simAddStatusbarMessage (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++)
                                                       simSetScriptRawBuffer (C/C++)
                                                       simGetScriptRawBuffer (C/C++)
                                                       simReleaseScriptRawBuffer (C/C++)
sim.setScriptSimulationParameter (Lua)                 simSetScriptSimulationParameter (C/C++)
sim.getScriptSimulationParameter (Lua)                 simGetScriptSimulationParameter (C/C++)
                                                       simRegisterScriptCallbackFunction (C/C++)
                                                       simRegisterScriptVariable (C/C++)
sim.sendData (Lua)                                     simSendData (C/C++)
sim.receiveData (Lua)                                  simReceiveData (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.tubeClose (Lua)                                    simTubeClose (C/C++)
sim.tubeOpen (Lua)                                     simTubeOpen (C/C++)
sim.tubeRead (Lua)                                     simTubeRead (C/C++)
sim.tubeStatus (Lua)                                   simTubeStatus (C/C++)
sim.tubeWrite (Lua)                                    simTubeWrite (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.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++)
                                                       simEnableEventCallback (C/C++)
sim.callScriptFunction (Lua)
                                                       simCallScriptFunctionEx (C/C++)
sim.executeScriptString (Lua)                          simExecuteScriptString (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)

Script simulation parameter commands

sim.setScriptSimulationParameter (Lua)                 simSetScriptSimulationParameter (C/C++)
sim.getScriptSimulationParameter (Lua)                 simGetScriptSimulationParameter (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.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)

Persistent Data

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

Custom data blocks

sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
sim.packUInt8Table (Lua)
sim.packDoubleTable (Lua)
sim.packFloatTable (Lua)
sim.packInt32Table (Lua)
sim.packUInt32Table (Lua)
sim.packUInt16Table (Lua)
sim.packTable (Lua)                                    simPackTable (C/C++)
sim.unpackUInt8Table (Lua)
sim.unpackDoubleTable (Lua)
sim.unpackFloatTable (Lua)
sim.unpackInt32Table (Lua)
sim.unpackUInt32Table (Lua)
sim.unpackUInt16Table (Lua)
sim.unpackTable (Lua)                                  simUnpackTable (C/C++)
sim.transformBuffer (Lua)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)

Textures

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 (only available from threaded child scripts)

sim.wait (Lua)
sim.waitForSignal (Lua)
sim.rmlMoveToJointPositions (Lua)
sim.rmlMoveToPosition (Lua)
sim.moveToObject (Lua)
sim.followPath (Lua)
sim.displayDialog (Lua)                                simDisplayDialog (C/C++)
sim.serialRead (Lua)                                   simSerialRead (C/C++)
sim.tubeRead (Lua)                                     simTubeRead (C/C++)

Auxiliary console functions

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

Import / Export functions

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

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 parameter retrieval

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++)
                                                       simGetUInt64Parameter (C/C++)

Reflexxes Motion Library type II or IV

sim.rmlMoveToJointPositions (Lua)
sim.rmlMoveToPosition (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++)

Ghost objects

sim.addGhost (Lua)                                     simAddGhost (C/C++)
sim.modifyGhost (Lua)                                  simModifyGhost (C/C++)

Packing / unpacking

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

Stack functionality

                                                       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 engine properties

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.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.getLastError (Lua)                                 simGetLastError (C/C++)
                                                       simSetLastError (C/C++)
sim.getCollectionName (Lua)                            simGetCollectionName (C/C++)
sim.setCollectionName (Lua)                            simSetCollectionName (C/C++)
sim.removeCollection (Lua)                             simRemoveCollection (C/C++)
sim.getModuleName (Lua)                                simGetModuleName (C/C++)
sim.getNameSuffix (Lua)                                simGetNameSuffix (C/C++)
sim.setNameSuffix (Lua)                                simSetNameSuffix (C/C++)
sim.getNavigationMode (Lua)                            simGetNavigationMode (C/C++)
sim.getSystemTime (Lua)                                simGetSystemTime (C/C++)
sim.getSystemTimeInMs (Lua)                            simGetSystemTimeInMs (C/C++)
sim.addStatusbarMessage (Lua)                          simAddStatusbarMessage (C/C++)
sim.refreshDialogs (Lua)                               simRefreshDialogs (C/C++)
sim.setThreadSwitchTiming (Lua)
sim.switchThread (Lua)                                 simSwitchThread (C/C++)
sim.setThreadIsFree (Lua)                              simSetThreadIsFree (C/C++)
sim.setThreadResumeLocation (Lua)
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++)
sim.getThreadId (Lua)                                  simGetThreadId (C/C++)
                                                       simEnableEventCallback (C/C++)
                                                       simLockResources (C/C++)
                                                       simUnlockResources (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)
sim.openTextEditor (Lua)                               simOpenTextEditor (C/C++)


Following are additional API functions, only available from the C/C++ interface, that extend functionality and allow faster data access. They however do not perform input data checking, so use them wisely. Refer to the source code for details.

_simAddForceSensorCumulativeForcesAndTorques
_simAddJointCumulativeForcesOrTorques
_simClearAdditionalForceAndTorque
_simDisableDynamicTreeForManipulation
_simDoEntitiesCollide
_simGetAdditionalForceAndTorque
_simGetAllGeometrics
_simGetBulletCollisionMargin
_simGetBulletRestitution
_simGetBulletStickyContact
_simGetContactCallback
_simGetContactCallbackCount
_simGetCumulativeMeshes
_simGetDamping
_simGetDistanceBetweenEntitiesIfSmaller
_simGetDummyLinkType
_simGetDynamicCollisionMask
_simGetDynamicForceSensorLocalTransformationPart2
_simGetDynamicMotorMaxForce
_simGetDynamicMotorTargetPosition
_simGetDynamicMotorTargetVelocity
_simGetDynamicMotorUpperLimitVelocity
_simGetDynamicsFullRefreshFlag
_simGetFriction
_simGetGeometricCount
_simGetGeomProxyDynamicsFullRefreshFlag
_simGetGeomProxyFromShape
_simGetGeomWrapFromGeomProxy
_simGetGravity
_simGetHeightfieldData
_simGetInitialDynamicAngVelocity
_simGetInitialDynamicVelocity
_simGetJointBulletParameters
_simGetJointMode
_simGetJointOdeParameters
_simGetJointPosition
_simGetJointPositionInterval
_simGetJointType
_simGetLastParentForLocalGlobalCollidable
_simGetLocalInertiaFrame
_simGetMass
_simGetMotorPid
_simGetObject
_simGetObjectChildren
_simGetObjectCumulativeTransformation
_simGetObjectFromIndex
_simGetObjectID
_simGetObjectListSize
_simGetObjectLocalTransformation
_simGetObjectType
_simGetOdeHeightfieldHeight
_simGetOdeMaxContactFrictionCFMandERP
_simGetParentFollowsDynamic
_simGetParentObject
_simGetPrincipalMomentOfInertia
_simGetPurePrimitiveSizes
_simGetPurePrimitiveType
_simGetShapeIsStaticAndNotRespondableButDynamicTag
_simGetStartSleeping
_simGetTimeDiffInMs
_simGetTreeDynamicProperty
_simGetVerticesLocalFrame
_simGetWasPutToSleepOnce
_simIsDynamicMotorEnabled
_simIsDynamicMotorPositionCtrlEnabled
_simIsDynamicMotorTorqueModulationEnabled
_simIsForceSensorBroken
_simIsGeomWrapGeometric
_simIsJointInHybridOperation
_simIsShapeDynamicallyRespondable
_simIsShapeDynamicallyStatic
_simMakeDynamicAnnouncement
_simSetDynamicForceSensorLocalTransformationPart2
_simSetDynamicForceSensorLocalTransformationPart2IsValid
_simSetDynamicJointLocalTransformationPart2
_simSetDynamicJointLocalTransformationPart2IsValid
_simSetDynamicMotorPositionControlTargetPosition
_simSetDynamicMotorReflectedPositionFromDynamicEngine
_simSetDynamicObjectFlagForVisualization
_simSetDynamicsFullRefreshFlag
_simSetDynamicSimulationIconCode
_simSetGeomProxyDynamicsFullRefreshFlag
_simSetInitialDynamicAngVelocity
_simSetInitialDynamicVelocity
_simSetJointPosition
_simSetJointSphericalTransformation
_simSetObjectCumulativeTransformation
_simSetObjectLocalTransformation
_simSetOdeHeightfieldAuxData
_simSetShapeDynamicVelocity
_simSetShapeIsStaticAndNotRespondableButDynamicTag
_simGetIkGroupObject
_simMpHandleIkGroupObject
_simGetPureHollowScaling
_simGetVortexParameters
_simGetJointCallbackCallOrder
_simGetNewtonParameters

Recommended topics

  • Regular API function list (alphabetical order)
  • API constants
  • Object parameter IDs