Regular API function list (alphabetical order)

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.

sim.addBanner (Lua)                                    simAddBanner (C/C++)
sim.addDrawingObject (Lua)                             simAddDrawingObject (C/C++)
sim.addDrawingObjectItem (Lua)                         simAddDrawingObjectItem (C/C++)
sim.addForce (Lua)                                     simAddForce (C/C++)
sim.addForceAndTorque (Lua)                            simAddForceAndTorque (C/C++)
sim.addGhost (Lua)                                     simAddGhost (C/C++)
                                                       simAddModuleMenuEntry (C/C++)
sim.addObjectToCollection (Lua)                        simAddObjectToCollection (C/C++)
sim.addObjectToSelection (Lua)                         simAddObjectToSelection (C/C++)
sim.addParticleObject (Lua)                            simAddParticleObject (C/C++)
sim.addParticleObjectItem (Lua)                        simAddParticleObjectItem (C/C++)
sim.addScript (Lua)                                    simAddScript (C/C++)
sim.addStatusbarMessage (Lua)                          simAddStatusbarMessage (C/C++)
                                                       simAdjustRealTimeTimer (C/C++)
sim.adjustView (Lua)                                   simAdjustView (C/C++)
                                                       simAdvanceSimulationByOneStep (C/C++)
sim.announceSceneContentChange (Lua)                   simAnnounceSceneContentChange (C/C++)
sim.applyMilling (Lua)                                 simApplyMilling (C/C++)
sim.associateScriptWithObject (Lua)                    simAssociateScriptWithObject (C/C++)
sim.auxiliaryConsoleClose (Lua)                        simAuxiliaryConsoleClose (C/C++)
sim.auxiliaryConsoleOpen (Lua)                         simAuxiliaryConsoleOpen (C/C++)
sim.auxiliaryConsolePrint (Lua)                        simAuxiliaryConsolePrint (C/C++)
sim.auxiliaryConsoleShow (Lua)                         simAuxiliaryConsoleShow (C/C++)
sim.boolAnd32 (Lua)
sim.boolOr32 (Lua)
sim.boolXor32 (Lua)
sim.breakForceSensor (Lua)                             simBreakForceSensor (C/C++)
                                                       simBroadcastMessage (C/C++)
sim.buildIdentityMatrix (Lua)                          simBuildIdentityMatrix (C/C++)
sim.buildMatrix (Lua)                                  simBuildMatrix (C/C++)
sim.buildMatrixQ (Lua)                                 simBuildMatrixQ (C/C++)
sim.callScriptFunction (Lua)                           simCallScriptFunction (C/C++)
                                                       simCallScriptFunctionEx (C/C++)
sim.cameraFitToView (Lua)                              simCameraFitToView (C/C++)
sim.checkCollision (Lua)                               simCheckCollision (C/C++)
sim.checkCollisionEx (Lua)                             simCheckCollisionEx (C/C++)
sim.checkDistance (Lua)                                simCheckDistance (C/C++)
sim.checkIkGroup (Lua)                                 simCheckIkGroup (C/C++)
sim.checkOctreePointOccupancy (Lua)                    simCheckOctreePointOccupancy (C/C++)
sim.checkProximitySensor (Lua)                         simCheckProximitySensor (C/C++)
sim.checkProximitySensorEx (Lua)                       simCheckProximitySensorEx (C/C++)
sim.checkProximitySensorEx2 (Lua)                      simCheckProximitySensorEx2 (C/C++)
sim.checkVisionSensor (Lua)                            simCheckVisionSensor (C/C++)
sim.checkVisionSensorEx (Lua)                          simCheckVisionSensorEx (C/C++)
sim.clearFloatSignal (Lua)                             simClearFloatSignal (C/C++)
sim.clearIntegerSignal (Lua)                           simClearIntegerSignal (C/C++)
sim.clearStringSignal (Lua)                            simClearStringSignal (C/C++)
sim.closeModule (Lua)
                                                       simCloseScene (C/C++)
sim.computeJacobian (Lua)                              simComputeJacobian (C/C++)
sim.computeMassAndInertia (Lua)                        simComputeMassAndInertia (C/C++)
sim.convexDecompose (Lua)                              simConvexDecompose (C/C++)
sim.copyMatrix (Lua)                                   simCopyMatrix (C/C++)
sim.copyPasteObjects (Lua)                             simCopyPasteObjects (C/C++)
                                                       simCopyStack (C/C++)
                                                       simCreateBuffer (C/C++)
sim.createCollection (Lua)                             simCreateCollection (C/C++)
sim.createDummy (Lua)                                  simCreateDummy (C/C++)
sim.createForceSensor (Lua)                            simCreateForceSensor (C/C++)
sim.createHeightfieldShape (Lua)                       simCreateHeightfieldShape (C/C++)
sim.createIkElement (Lua)                              simCreateIkElement (C/C++)
sim.createIkGroup (Lua)                                simCreateIkGroup (C/C++)
sim.createJoint (Lua)                                  simCreateJoint (C/C++)
sim.createMeshShape (Lua)                              simCreateMeshShape (C/C++)
sim.createOctree (Lua)                                 simCreateOctree (C/C++)
sim.createPath (Lua)                                   simCreatePath (C/C++)
sim.createPointCloud (Lua)                             simCreatePointCloud (C/C++)
sim.createProximitySensor (Lua)                        simCreateProximitySensor (C/C++)
sim.createPureShape (Lua)                              simCreatePureShape (C/C++)
                                                       simCreateStack (C/C++)
sim.createTexture (Lua)                                simCreateTexture (C/C++)
sim.createVisionSensor (Lua)                           simCreateVisionSensor (C/C++)
sim.cutPathCtrlPoints (Lua)                            simCutPathCtrlPoints (C/C++)
                                                       simDebugStack (C/C++)
sim.displayDialog (Lua)                                simDisplayDialog (C/C++)
                                                       simDoesFileExist (C/C++)
sim.emptyCollection (Lua)                              simEmptyCollection (C/C++)
                                                       simEnableEventCallback (C/C++)
sim.endDialog (Lua)                                    simEndDialog (C/C++)
sim.executeScriptString (Lua)                          simExecuteScriptString (C/C++)
sim.exportIk (Lua)                                     simExportIk (C/C++)
sim.exportMesh (Lua)                                   simExportMesh (C/C++)
sim.fileDialog (Lua)                                   simFileDialog (C/C++)
sim.floatingViewAdd (Lua)                              simFloatingViewAdd (C/C++)
sim.floatingViewRemove (Lua)                           simFloatingViewRemove (C/C++)
sim.followPath (Lua)
sim.generateIkPath (Lua)                               simGenerateIkPath (C/C++)
sim.getApiFunc (Lua)                                   simGetApiFunc (C/C++)
sim.getApiInfo (Lua)                                   simGetApiInfo (C/C++)
sim.getArrayParameter (Lua)                            simGetArrayParameter (C/C++)
sim.getBoolParameter (Lua)                             simGetBoolParameter (C/C++)
sim.getClosestPositionOnPath (Lua)                     simGetClosestPositionOnPath (C/C++)
sim.getCollectionHandle (Lua)                          simGetCollectionHandle (C/C++)
sim.getCollectionName (Lua)                            simGetCollectionName (C/C++)
sim.getCollectionObjects (Lua)                         simGetCollectionObjects (C/C++)
sim.getCollisionHandle (Lua)                           simGetCollisionHandle (C/C++)
sim.getConfigForTipPose (Lua)                          simGetConfigForTipPose (C/C++)
sim.getConfigurationTree (Lua)                         simGetConfigurationTree (C/C++)
sim.getContactInfo (Lua)                               simGetContactInfo (C/C++)
sim.getCustomizationScriptAssociatedWithObject (Lua)   simGetCustomizationScriptAssociatedWithObject (C/C++)
sim.getDataOnPath (Lua)                                simGetDataOnPath (C/C++)
sim.getDecimatedMesh (Lua)                             simGetDecimatedMesh (C/C++)
sim.getDialogInput (Lua)                               simGetDialogInput (C/C++)
sim.getDialogResult (Lua)                              simGetDialogResult (C/C++)
sim.getDistanceHandle (Lua)                            simGetDistanceHandle (C/C++)
sim.getEngineBoolParameter (Lua)                       simGetEngineBoolParameter (C/C++)
sim.getEngineFloatParameter (Lua)                      simGetEngineFloatParameter (C/C++)
sim.getEngineInt32Parameter (Lua)                      simGetEngineInt32Parameter (C/C++)
sim.getEulerAnglesFromMatrix (Lua)                     simGetEulerAnglesFromMatrix (C/C++)
sim.getExplicitHandling (Lua)                          simGetExplicitHandling (C/C++)
sim.getFloatParameter (Lua)                            simGetFloatParameter (C/C++)
sim.getFloatSignal (Lua)                               simGetFloatSignal (C/C++)
sim.getIkGroupHandle (Lua)                             simGetIkGroupHandle (C/C++)
sim.getIkGroupMatrix (Lua)                             simGetIkGroupMatrix (C/C++)
sim.getInt32Parameter (Lua)                            simGetInt32Parameter (C/C++)
sim.getIntegerSignal (Lua)                             simGetIntegerSignal (C/C++)
sim.getJointForce (Lua)                                simGetJointForce (C/C++)
sim.getJointInterval (Lua)                             simGetJointInterval (C/C++)
sim.getJointMatrix (Lua)                               simGetJointMatrix (C/C++)
sim.getJointMode (Lua)                                 simGetJointMode (C/C++)
sim.getJointPosition (Lua)                             simGetJointPosition (C/C++)
sim.getJointTargetPosition (Lua)                       simGetJointTargetPosition (C/C++)
sim.getJointTargetVelocity (Lua)                       simGetJointTargetVelocity (C/C++)
sim.getJointType (Lua)                                 simGetJointType (C/C++)
sim.getLastError (Lua)                                 simGetLastError (C/C++)
sim.getLightParameters (Lua)                           simGetLightParameters (C/C++)
sim.getLinkDummy (Lua)                                 simGetLinkDummy (C/C++)
                                                       simGetMainWindow (C/C++)
sim.getMechanismHandle (Lua)                           simGetMechanismHandle (C/C++)
sim.getModelProperty (Lua)                             simGetModelProperty (C/C++)
sim.getModuleInfo (Lua)                                simGetModuleInfo (C/C++)
sim.getModuleName (Lua)                                simGetModuleName (C/C++)
sim.getNameSuffix (Lua)                                simGetNameSuffix (C/C++)
sim.getNavigationMode (Lua)                            simGetNavigationMode (C/C++)
sim.getObjectAssociatedWithScript (Lua)                simGetObjectAssociatedWithScript (C/C++)
sim.getObjectConfiguration (Lua)                       simGetObjectConfiguration (C/C++)
sim.getObjectChild (Lua)                               simGetObjectChild (C/C++)
sim.getObjectFloatParameter (Lua)                      simGetObjectFloatParameter (C/C++)
sim.getObjectHandle (Lua)                              simGetObjectHandle (C/C++)
sim.getObjectInt32Parameter (Lua)                      simGetObjectInt32Parameter (C/C++)
sim.getObjectMatrix (Lua)                              simGetObjectMatrix (C/C++)
sim.getObjectName (Lua)                                simGetObjectName (C/C++)
sim.getObjectOrientation (Lua)                         simGetObjectOrientation (C/C++)
sim.getObjectParent (Lua)                              simGetObjectParent (C/C++)
sim.getObjectPosition (Lua)                            simGetObjectPosition (C/C++)
sim.getObjectProperty (Lua)                            simGetObjectProperty (C/C++)
sim.getObjectQuaternion (Lua)                          simGetObjectQuaternion (C/C++)
sim.getObjects (Lua)                                   simGetObjects (C/C++)
sim.getObjectSelection (Lua)                           simGetObjectSelection (C/C++)
                                                       simGetObjectSelectionSize (C/C++)
sim.getObjectsInTree (Lua)                             simGetObjectsInTree (C/C++)
sim.getObjectSizeFactor (Lua)                          simGetObjectSizeFactor (C/C++)
sim.getObjectSizeValues (Lua)                          simGetObjectSizeValues (C/C++)
sim.getObjectSpecialProperty (Lua)                     simGetObjectSpecialProperty (C/C++)
sim.getObjectStringParameter (Lua)                     simGetObjectStringParameter (C/C++)
sim.getObjectType (Lua)                                simGetObjectType (C/C++)
sim.getObjectUniqueIdentifier (Lua)                    simGetObjectUniqueIdentifier (C/C++)
sim.getObjectVelocity (Lua)                            simGetObjectVelocity (C/C++)
sim.getOctreeVoxels (Lua)                              simGetOctreeVoxels (C/C++)
sim.getOrientationOnPath (Lua)                         simGetOrientationOnPath (C/C++)
sim.getPage (Lua)                                      simGetPage (C/C++)
sim.getPathLength (Lua)                                simGetPathLength (C/C++)
sim.getPathPosition (Lua)                              simGetPathPosition (C/C++)
sim.getPointCloudOptions (Lua)                         simGetPointCloudOptions (C/C++)
sim.getPointCloudPoints (Lua)                          simGetPointCloudPoints (C/C++)
sim.getPositionOnPath (Lua)                            simGetPositionOnPath (C/C++)
sim.getQHull (Lua)                                     simGetQHull (C/C++)
sim.getQuaternionFromMatrix (Lua)                      simGetQuaternionFromMatrix (C/C++)
sim.getRealTimeSimulation (Lua)                        simGetRealTimeSimulation (C/C++)
sim.getExtensionString (Lua)                           simGetExtensionString (C/C++)
sim.getReferencedHandles (Lua)                         simGetReferencedHandles (C/C++)
sim.getRotationAxis (Lua)                              simGetRotationAxis (C/C++)
sim.getScaledImage (Lua)                               simGetScaledImage (C/C++)
                                                       simGetScript (C/C++)
sim.getScriptAssociatedWithObject (Lua)                simGetScriptAssociatedWithObject (C/C++)
sim.getScriptAttribute (Lua)                           simGetScriptAttribute (C/C++)
sim.getScriptExecutionCount (Lua)
sim.getScriptHandle (Lua)                              simGetScriptHandle (C/C++)
sim.getScriptName (Lua)                                simGetScriptName (C/C++)
                                                       simGetScriptProperty (C/C++)
                                                       simGetScriptRawBuffer (C/C++)
sim.getScriptSimulationParameter (Lua)                 simGetScriptSimulationParameter (C/C++)
                                                       simGetScriptText (C/C++)
sim.getShapeColor (Lua)                                simGetShapeColor (C/C++)
sim.getShapeGeomInfo (Lua)                             simGetShapeGeomInfo (C/C++)
sim.getShapeMassAndInertia (Lua)                       simGetShapeMassAndInertia (C/C++)
sim.getShapeMesh (Lua)                                 simGetShapeMesh (C/C++)
sim.getShapeTextureId (Lua)                            simGetShapeTextureId (C/C++)
sim.getShapeViz (Lua)                                  simGetShapeViz (C/C++)
sim.getSignalName (Lua)                                simGetSignalName (C/C++)
                                                       simGetSimulationPassesPerRenderingPass (C/C++)
sim.getSimulationState (Lua)                           simGetSimulationState (C/C++)
sim.getSimulationTime (Lua)                            simGetSimulationTime (C/C++)
sim.getSimulationTimeStep (Lua)                        simGetSimulationTimeStep (C/C++)
sim.getSimulatorMessage (Lua)                          simGetSimulatorMessage (C/C++)
                                                       simGetStackBoolValue (C/C++)
                                                       simGetStackDoubleTable (C/C++)
                                                       simGetStackDoubleValue (C/C++)
                                                       simGetStackFloatTable (C/C++)
                                                       simGetStackFloatValue (C/C++)
                                                       simGetStackInt32Table (C/C++)
                                                       simGetStackInt32Value (C/C++)
                                                       simGetStackSize (C/C++)
                                                       simGetStackStringValue (C/C++)
                                                       simGetStackTableInfo (C/C++)
                                                       simGetStackUInt8Table (C/C++)
sim.getStringParameter (Lua)                           simGetStringParameter (C/C++)
sim.getStringSignal (Lua)                              simGetStringSignal (C/C++)
sim.getSystemTime (Lua)                                simGetSystemTime (C/C++)
sim.getSystemTimeInMs (Lua)                            simGetSystemTimeInMs (C/C++)
sim.getTextureId (Lua)                                 simGetTextureId (C/C++)
sim.getThreadAutomaticSwitch (Lua)                     simGetThreadAutomaticSwitch (C/C++)
sim.getThreadId (Lua)                                  simGetThreadId (C/C++)
                                                       simGetUInt64Parameter (C/C++)
sim.getVelocity (Lua)                                  simGetVelocity (C/C++)
sim.getVisionSensorDepthBuffer (Lua)                   simGetVisionSensorDepthBuffer (C/C++)
sim.getVisionSensorCharImage (Lua)                     simGetVisionSensorCharImage (C/C++)
sim.getVisionSensorFilter (Lua)                        simGetVisionSensorFilter (C/C++)
sim.getVisionSensorImage (Lua)                         simGetVisionSensorImage (C/C++)
sim.getVisionSensorResolution (Lua)                    simGetVisionSensorResolution (C/C++)
sim.groupShapes (Lua)                                  simGroupShapes (C/C++)
sim.handleChildScripts (Lua)
sim.handleCollision (Lua)                              simHandleCollision (C/C++)
sim.handleDistance (Lua)                               simHandleDistance (C/C++)
sim.handleDynamics (Lua)                               simHandleDynamics (C/C++)
sim.handleGraph (Lua)                                  simHandleGraph (C/C++)
sim.handleIkGroup (Lua)                                simHandleIkGroup (C/C++)
                                                       simHandleMainScript (C/C++)
sim.handleMechanism (Lua)                              simHandleMechanism (C/C++)
sim.handleMill (Lua)                                   simHandleMill (C/C++)
sim.handleModule (Lua)
sim.handleProximitySensor (Lua)                        simHandleProximitySensor (C/C++)
sim.handleSensingStart (Lua)                           simHandleSensingStart (C/C++)
sim.handleSimulationStart (Lua)                        simHandleSimulationStart (C/C++)
sim.handleVisionSensor (Lua)                           simHandleVisionSensor (C/C++)
sim.importMesh (Lua)                                   simImportMesh (C/C++)
sim.importShape (Lua)                                  simImportShape (C/C++)
                                                       simInsertDataIntoStackTable (C/C++)
sim.insertObjectIntoOctree (Lua)                       simInsertObjectIntoOctree (C/C++)
sim.insertObjectIntoPointCloud (Lua)                   simInsertObjectIntoPointCloud (C/C++)
sim.insertPathCtrlPoints (Lua)                         simInsertPathCtrlPoints (C/C++)
sim.insertPointsIntoPointCloud (Lua)                   simInsertPointsIntoPointCloud (C/C++)
sim.insertVoxelsIntoOctree (Lua)                       simInsertVoxelsIntoOctree (C/C++)
sim.interpolateMatrices (Lua)                          simInterpolateMatrices (C/C++)
sim.intersectPointsWithPointCloud (Lua)                simIntersectPointsWithPointCloud (C/C++)
sim.invertMatrix (Lua)                                 simInvertMatrix (C/C++)
sim.isHandleValid (Lua)                                simIsHandleValid (C/C++)
sim.isObjectInSelection (Lua)                          simIsObjectInSelection (C/C++)
                                                       simIsRealTimeSimulationStepNeeded (C/C++)
sim.isScriptExecutionThreaded (Lua)
                                                       simIsStackValueNull (C/C++)
sim.launchExecutable (Lua)
sim.launchThreadedChildScripts (Lua)
sim.loadImage (Lua)                                    simLoadImage (C/C++)
sim.loadModel (Lua)                                    simLoadModel (C/C++)
sim.loadModule (Lua)                                   simLoadModule (C/C++)
sim.loadScene (Lua)                                    simLoadScene (C/C++)
                                                       simLockResources (C/C++)
sim.modifyGhost (Lua)                                  simModifyGhost (C/C++)
                                                       simMoveStackItemToTop (C/C++)
sim.moveToObject (Lua)
sim.msgBox (Lua)                                       simMsgBox (C/C++)
sim.multiplyMatrices (Lua)                             simMultiplyMatrices (C/C++)
sim.multiplyVector (Lua)
sim.openModule (Lua)
sim.openTextEditor (Lua)                               simOpenTextEditor (C/C++)
sim.packDoubleTable (Lua)
sim.packFloatTable (Lua)
sim.packInt32Table (Lua)
sim.packTable (Lua)                                    simPackTable (C/C++)
sim.packUInt8Table (Lua)
sim.packUInt16Table (Lua)
sim.packUInt32Table (Lua)
sim.pauseSimulation (Lua)                              simPauseSimulation (C/C++)
sim.persistentDataRead (Lua)                           simPersistentDataRead (C/C++)
sim.persistentDataWrite (Lua)                          simPersistentDataWrite (C/C++)
                                                       simPopStackItem (C/C++)
                                                       simPushBoolOntoStack (C/C++)
                                                       simPushDoubleOntoStack (C/C++)
                                                       simPushDoubleTableOntoStack (C/C++)
                                                       simPushFloatOntoStack (C/C++)
                                                       simPushFloatTableOntoStack (C/C++)
                                                       simPushInt32OntoStack (C/C++)
                                                       simPushInt32TableOntoStack (C/C++)
                                                       simPushNullOntoStack (C/C++)
                                                       simPushStringOntoStack (C/C++)
                                                       simPushTableOntoStack (C/C++)
                                                       simPushUInt8TableOntoStack (C/C++)
sim.quitSimulator (Lua)                                simQuitSimulator (C/C++)
sim.readCollision (Lua)                                simReadCollision (C/C++)
sim.readCustomDataBlock (Lua)                          simReadCustomDataBlock (C/C++)
sim.readCustomDataBlockTags (Lua)                      simReadCustomDataBlockTags (C/C++)
sim.readDistance (Lua)                                 simReadDistance (C/C++)
sim.readForceSensor (Lua)                              simReadForceSensor (C/C++)
sim.readProximitySensor (Lua)                          simReadProximitySensor (C/C++)
sim.readTexture (Lua)                                  simReadTexture (C/C++)
sim.readVisionSensor (Lua)                             simReadVisionSensor (C/C++)
sim.receiveData (Lua)                                  simReceiveData (C/C++)
sim.refreshDialogs (Lua)                               simRefreshDialogs (C/C++)
                                                       simRegisterScriptCallbackFunction (C/C++)
                                                       simRegisterScriptVariable (C/C++)
                                                       simReleaseBuffer (C/C++)
                                                       simReleaseScriptRawBuffer (C/C++)
                                                       simReleaseStack (C/C++)
sim.removeBanner (Lua)                                 simRemoveBanner (C/C++)
sim.removeCollection (Lua)                             simRemoveCollection (C/C++)
sim.removeDrawingObject (Lua)                          simRemoveDrawingObject (C/C++)
sim.removeIkGroup (Lua)                                simRemoveIkGroup (C/C++)
sim.removeModel (Lua)                                  simRemoveModel (C/C++)
sim.removeObject (Lua)                                 simRemoveObject (C/C++)
sim.removeObjectFromSelection (Lua)                    simRemoveObjectFromSelection (C/C++)
sim.removeParticleObject (Lua)                         simRemoveParticleObject (C/C++)
sim.removePointsFromPointCloud (Lua)                   simRemovePointsFromPointCloud (C/C++)
sim.removeScript (Lua)                                 simRemoveScript (C/C++)
sim.removeVoxelsFromOctree (Lua)                       simRemoveVoxelsFromOctree (C/C++)
sim.reorientShapeBoundingBox (Lua)                     simReorientShapeBoundingBox (C/C++)
sim.resetCollision (Lua)                               simResetCollision (C/C++)
sim.resetDistance (Lua)                                simResetDistance (C/C++)
sim.resetDynamicObject (Lua)                           simResetDynamicObject (C/C++)
sim.resetGraph (Lua)                                   simResetGraph (C/C++)
sim.resetMill (Lua)                                    simResetMill (C/C++)
sim.resetMilling (Lua)                                 simResetMilling (C/C++)
sim.resetProximitySensor (Lua)                         simResetProximitySensor (C/C++)
                                                       simResetScript (C/C++)
sim.resetVisionSensor (Lua)                            simResetVisionSensor (C/C++)
sim.resumeThreads (Lua)                                simResumeThreads (C/C++)
sim.rmlMoveToJointPositions (Lua)                      simRMLMoveToJointPositions (C/C++)
sim.rmlMoveToPosition (Lua)                            simRMLMoveToPosition (C/C++)
sim.rmlPos (Lua)                                       simRMLPos (C/C++)
sim.rmlRemove (Lua)                                    simRMLRemove (C/C++)
sim.rmlStep (Lua)                                      simRMLStep (C/C++)
sim.rmlVel (Lua)                                       simRMLVel (C/C++)
sim.rotateAroundAxis (Lua)                             simRotateAroundAxis (C/C++)
                                                       simRunSimulator (C/C++)
sim.saveImage (Lua)                                    simSaveImage (C/C++)
sim.saveModel (Lua)                                    simSaveModel (C/C++)
sim.saveScene (Lua)                                    simSaveScene (C/C++)
sim.scaleObject (Lua)                                  simScaleObject (C/C++)
sim.scaleObjects (Lua)                                 simScaleObjects (C/C++)
sim.sendData (Lua)                                     simSendData (C/C++)
                                                       simSendModuleMessage (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.setArrayParameter (Lua)                            simSetArrayParameter (C/C++)
sim.setBoolParameter (Lua)                             simSetBoolParameter (C/C++)
sim.setCollectionName (Lua)                            simSetCollectionName (C/C++)
sim.setConfigurationTree (Lua)                         simSetConfigurationTree (C/C++)
sim.setEngineBoolParameter (Lua)                       simSetEngineBoolParameter (C/C++)
sim.setEngineFloatParameter (Lua)                      simSetEngineFloatParameter (C/C++)
sim.setEngineInt32Parameter (Lua)                      simSetEngineInt32Parameter (C/C++)
sim.setExplicitHandling (Lua)                          simSetExplicitHandling (C/C++)
sim.setFloatParameter (Lua)                            simSetFloatParameter (C/C++)
sim.setFloatSignal (Lua)                               simSetFloatSignal (C/C++)
sim.setGraphUserData (Lua)                             simSetGraphUserData (C/C++)
sim.setIkElementProperties (Lua)                       simSetIkElementProperties (C/C++)
sim.setIkGroupProperties (Lua)                         simSetIkGroupProperties (C/C++)
sim.setInt32Parameter (Lua)                            simSetInt32Parameter (C/C++)
sim.setIntegerSignal (Lua)                             simSetIntegerSignal (C/C++)
sim.setJointForce (Lua)                                simSetJointForce (C/C++)
sim.setJointInterval (Lua)                             simSetJointInterval (C/C++)
sim.setJointMode (Lua)                                 simSetJointMode (C/C++)
sim.setJointPosition (Lua)                             simSetJointPosition (C/C++)
sim.setJointTargetPosition (Lua)                       simSetJointTargetPosition (C/C++)
sim.setJointTargetVelocity (Lua)                       simSetJointTargetVelocity (C/C++)
                                                       simSetLastError (C/C++)
sim.setLightParameters (Lua)                           simSetLightParameters (C/C++)
sim.setLinkDummy (Lua)                                 simSetLinkDummy (C/C++)
sim.setModelProperty (Lua)                             simSetModelProperty (C/C++)
                                                       simSetModuleInfo (C/C++)
                                                       simSetModuleMenuItemState (C/C++)
sim.setNameSuffix (Lua)                                simSetNameSuffix (C/C++)
sim.setNavigationMode (Lua)                            simSetNavigationMode (C/C++)
sim.setObjectConfiguration (Lua)                       simSetObjectConfiguration (C/C++)
sim.setObjectFloatParameter (Lua)                      simSetObjectFloatParameter (C/C++)
sim.setObjectInt32Parameter (Lua)                      simSetObjectInt32Parameter (C/C++)
sim.setObjectMatrix (Lua)                              simSetObjectMatrix (C/C++)
sim.setObjectName (Lua)                                simSetObjectName (C/C++)
sim.setObjectOrientation (Lua)                         simSetObjectOrientation (C/C++)
sim.setObjectParent (Lua)                              simSetObjectParent (C/C++)
sim.setObjectPosition (Lua)                            simSetObjectPosition (C/C++)
sim.setObjectProperty (Lua)                            simSetObjectProperty (C/C++)
sim.setObjectQuaternion (Lua)                          simSetObjectQuaternion (C/C++)
sim.setObjectSizeValues (Lua)                          simSetObjectSizeValues (C/C++)
sim.setObjectSpecialProperty (Lua)                     simSetObjectSpecialProperty (C/C++)
sim.setObjectStringParameter (Lua)                     simSetObjectStringParameter (C/C++)
sim.setPage (Lua)                                      simSetPage (C/C++)
sim.setPathPosition (Lua)                              simSetPathPosition (C/C++)

sim.setPointCloudOptions (Lua)                         simSetPointCloudOptions (C/C++)
sim.setReferencedHandles (Lua)                         simSetReferencedHandles (C/C++)
sim.setScriptAttribute (Lua)                           simSetScriptAttribute (C/C++)
                                                       simSetScriptRawBuffer (C/C++)
sim.setScriptSimulationParameter (Lua)                 simSetScriptSimulationParameter (C/C++)
sim.setScriptText (Lua)                                simSetScriptText (C/C++)
sim.setScriptVariable (Lua)                            simSetScriptVariable (C/C++)
sim.setShapeColor (Lua)                                simSetShapeColor (C/C++)
sim.setShapeMassAndInertia (Lua)                       simSetShapeMassAndInertia (C/C++)
sim.setShapeMaterial (Lua)                             simSetShapeMaterial (C/C++)
sim.setShapeTexture (Lua)                              simSetShapeTexture (C/C++)
                                                       simSetSimulationPassesPerRenderingPass (C/C++)
sim.setSphericalJointMatrix (Lua)                      simSetSphericalJointMatrix (C/C++)
sim.setStringParameter (Lua)                           simSetStringParameter (C/C++)
sim.setStringSignal (Lua)                              simSetStringSignal (C/C++)
sim.setThreadAutomaticSwitch (Lua)
sim.setThreadIsFree (Lua)
sim.setThreadResumeLocation (Lua)
sim.setThreadSwitchTiming (Lua)
sim.setVisionSensorCharImage (Lua)                     simSetVisionSensorCharImage (C/C++)
sim.setVisionSensorFilter (Lua)                        simSetVisionSensorFilter (C/C++)
sim.setVisionSensorImage (Lua)                         simSetVisionSensorImage (C/C++)
sim.subtractObjectFromOctree (Lua)                     simSubtractObjectFromOctree (C/C++)
sim.subtractObjectFromPointCloud (Lua)                 simSubtractObjectFromPointCloud (C/C++)
sim.startSimulation (Lua)                              simStartSimulation (C/C++)
sim.stopSimulation (Lua)                               simStopSimulation (C/C++)
sim.switchThread (Lua)                                 simSwitchThread (C/C++)
sim.transformBuffer (Lua)                              simTransformBuffer (C/C++)
sim.transformImage (Lua)                               simTransformImage (C/C++)
                                                       simTransformVector (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++)
                                                       simUnfoldStackTable (C/C++)
sim.ungroupShape (Lua)                                 simUngroupShape (C/C++)
sim.unloadModule (Lua)                                 simUnloadModule (C/C++)
                                                       simUnlockResources (C/C++)
sim.unpackDoubleTable (Lua)
sim.unpackFloatTable (Lua)
sim.unpackInt32Table (Lua)
sim.unpackTable (Lua)                                  simUnpackTable (C/C++)
sim.unpackUInt8Table (Lua)
sim.unpackUInt16Table (Lua)
sim.unpackUInt32Table (Lua)
sim.wait (Lua)
sim.waitForSignal (Lua)
sim.writeCustomDataBlock (Lua)                         simWriteCustomDataBlock (C/C++)
sim.writeTexture (Lua)                                 simWriteTexture (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
_simGetOdeMaxContactFrictionCFMandERP
_simGetParentFollowsDynamic
_simGetParentObject
_simGetPrincipalMomentOfInertia
_simGetPurePrimitiveSizes
_simGetPurePrimitiveType
_simGetShapeIsStaticAndNotRespondableButDynamicTag
_simGetStartSleeping
_simGetTimeDiffInMs
_simGetTreeDynamicProperty
_simGetVerticesLocalFrame
_simGetWasPutToSleepOnce
_simIsDynamicMotorEnabled
_simIsDynamicMotorPositionCtrlEnabled
_simIsDynamicMotorTorqueModulationEnabled
_simIsForceSensorBroken
_simIsGeomWrapConvex
_simIsGeomWrapGeometric
_simIsJointInHybridOperation
_simIsShapeDynamicallyRespondable
_simIsShapeDynamicallyStatic
_simMakeDynamicAnnouncement
_simSetDynamicForceSensorLocalTransformationPart2
_simSetDynamicForceSensorLocalTransformationPart2IsValid
_simSetDynamicJointLocalTransformationPart2
_simSetDynamicJointLocalTransformationPart2IsValid
_simSetDynamicMotorPositionControlTargetPosition
_simSetDynamicMotorReflectedPositionFromDynamicEngine
_simSetDynamicObjectFlagForVisualization
_simSetDynamicsFullRefreshFlag
_simSetDynamicSimulationIconCode
_simSetGeomProxyDynamicsFullRefreshFlag
_simSetInitialDynamicAngVelocity
_simSetInitialDynamicVelocity
_simSetJointPosition
_simSetJointSphericalTransformation
_simSetObjectCumulativeTransformation
_simSetObjectLocalTransformation
_simSetShapeDynamicVelocity
_simSetShapeIsStaticAndNotRespondableButDynamicTag
_simGetIkGroupObject
_simMpHandleIkGroupObject
_simGetPureHollowScaling
_simGetVortexParameters
_simGetJointCallbackCallOrder
_simGetNewtonParameters

Recommended topics

  • Regular API function list (by category)
  • API constants
  • Object parameter IDs