HandlingGetBrakeBias: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server function}} ==Syntax== <syntaxhighlight lang="lua"> </syntaxhighlight> ===Required Arguments=== ===Returns=== ==Example== <syntaxhighlight lang="lua"> --TODO </syntaxhighlight> ==See Also== {{Handling_functions}}) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
Returns the brake bias of a handling element or vehicle ID (the distribution of the braking power over the front and back tires). | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetBrakeBias ( handling theHandling ) | |||
float handlingGetBrakeBias ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling of which you want to get the brake bias, ''or'' | |||
*'''vehicleID:''' the vehicle ID of which you want to get the brake bias. | |||
===Returns=== | |||
If you specified a handling element, returns its brake bias if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the brake bias that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
The brake bias is a value between 0 and 1. 0 means the car only brakes on its back tires, 1 that it only brakes on the front tires. 0.5 means that front and back tires brake with the same strength. | |||
==Example== | ==Example== | ||
Revision as of 20:42, 27 March 2008
Returns the brake bias of a handling element or vehicle ID (the distribution of the braking power over the front and back tires).
Syntax
float handlingGetBrakeBias ( handling theHandling ) float handlingGetBrakeBias ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the brake bias, or
- vehicleID: the vehicle ID of which you want to get the brake bias.
Returns
If you specified a handling element, returns its brake bias if one is set, or nil otherwise. If you specified a vehicle ID, returns the brake bias that currently applies to vehicles of that ID. Returns false in case of failure.
The brake bias is a value between 0 and 1. 0 means the car only brakes on its back tires, 1 that it only brakes on the front tires. 0.5 means that front and back tires brake with the same strength.
Example
--TODO