Lua: Keep collinearity and toleranceRatioToStopCommand

[Yoarii]

Two questions for you, @NQ-Ligo

 

Can we please have a more detail description of the keepForceCollinearity parameter? What does it actually mean?

https://github.com/dual-universe/lua-examples/blob/main/api-mockup/controlunit.lua#L97

 

Secondly, what's the unit and range of toleranceRatioToStopCommand ? 0-1? 0-100?

https://github.com/dual-universe/lua-examples/blob/main/api-mockup/controlunit.lua#L103

 

Br,

 

Yoarii

[Nayropux]

I agree that the documentation should be better, but before that point:

 

keepForceCollinearity: if true this forces the resulting acceleration to be in the same direction as the requested acceleration, even if it is less. If it is false the actual acceleration given can be in a slightly different direction, but at the requested magnitude. This is handy for fixed engines with a long warmup, since they can start warming up sooner even if they are not pointed in exactly the correct direction. Basically, you set this true if you need precise movement, and false if you just need a lot of engine power in roughly the correct direction.

 

toleranceRatioToStopCommand: it's a ratio, so it is unitless, and it is 0-1.