diff options
| author | tree786 <40580296+tree786@users.noreply.github.com> | 2019-06-10 03:36:29 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-10 03:36:29 +0100 |
| commit | e9b8ff273d98784273ec83ec89d50bb405f26583 (patch) | |
| tree | 95af8952e6106a2947eb2e30e7f8f7cfe76e043e /doc | |
| parent | 138a8f1a99f8b79556e46f487818a451d23170a4 (diff) | |
Update VehicleWheel.xml
It seems (please correct me if you understand it otherwise) that the description for the `get_skidinfo()` function is the inverse of what actually happens. I have run some simple tests, and it looks like setting low `Friction Slip` (e.g. try `1` or `2`) causes more skidding and returns smaller values for `get_skidinfo()`, while when the `Friction Slip` is increased, the car skids less and values printed to the console increase (get closer to `1.0`). So it seems that a value of `0.0` means skidding, while a value of `1.0` means no skidding (the description says the exact opposite to this, from what I understood).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/VehicleWheel.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index c3b668c170..0bc0e351e4 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -19,7 +19,7 @@ <return type="float"> </return> <description> - Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is not skidding, 1.0 means the wheel has lost grip. + Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). </description> </method> <method name="is_in_contact" qualifiers="const"> |