btDiscreteDynamicsWorld::stepSimulation() won't return the number of actual steps performed if number was clamped

[przecze]

The return value of btDynamicsWorld::stepSimulation() is not documented, but I assumed it returns the number of substeps performed, so it can be used for other calculations.
However, in implementation: btDiscreteDynamicsWorld::stepSimulation() (in src/BulletDynamics/Dynamics/btDiscreteDynamicsWorld.cpp) it returns numSimulationSubSteps while it should return clampedSimulationSteps.

I encountered this problem when playing with the examples. In GUI versions of examples, the deltaTime is 0.1 while maxSubSteps takes the default value of 1. So clamping occurs every time.

So either:

1. The return value of this method is supposed something else than I assumed. Then better documentation would be good. Also, if this is the case, how to get the actual number of steps performed?
2. There's a bug in this method.

[przecze]

Hey, any update here? I found a related forum discussion:
https://pybullet.org/Bullet/phpBB3/viewtopic.php?t=9256
It looks to me that the return value should definitely be clampedSimulationSteps.