Regular API function

simSetJointForce / sim.setJointForce

Description Sets the maximum force or torque that a joint can exert. The joint will apply that force/torque until the joint target velocity has been reached. To apply a negative force/torque, set a negative target velocity. This function has no effect when the joint is not dynamically enabled, or when it is a spherical joint. See also sim.getJointForce. and sim.setJointTargetVelocity.
C synopsis simInt simSetJointForce(simInt objectHandle,simFloat forceOrTorque)
C parameters
objectHandle: handle of the joint object
forceOrTorque: the maximum force or torque that the joint can exert. This cannot be a negative value.
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=sim.setJointForce(number objectHandle,number forceOrTorque)
Lua parameters
Same as C-function
Lua return values
Same as C-function
Remote API equiv.
B0-based remote API: simxSetJointForce
Legacy remote API: simxSetJointForce

All regular API functions on one page