HandlingGetSuspensionFrontRearBias: 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}}) |
mNo edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{Needs_Example}} | |||
Returns the suspension bias of a handling element or vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetSuspensionFrontRearBias ( handling theHandling ) | |||
float handlingGetSuspensionFrontRearBias ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling of which you want to get the suspension bias, ''or'' | |||
*'''vehicleID:''' the vehicle ID of which you want to get the suspension bias. | |||
===Returns=== | |||
If you specified a handling element, returns its suspension bias if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the suspension bias that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
The suspension bias is a number between 0 and 1. If it's 0, the back tires have all the suspension and the front tires have none. If it's 1, the front tires have suspension and the back tires have none. If it's 0.5, front and back tires have the same suspension strength. | |||
==Example== | ==Example== | ||
Latest revision as of 16:42, 19 July 2013
|
Script Example Missing Function HandlingGetSuspensionFrontRearBias needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
Returns the suspension bias of a handling element or vehicle ID.
Syntax
float handlingGetSuspensionFrontRearBias ( handling theHandling ) float handlingGetSuspensionFrontRearBias ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the suspension bias, or
- vehicleID: the vehicle ID of which you want to get the suspension bias.
Returns
If you specified a handling element, returns its suspension bias if one is set, or nil otherwise. If you specified a vehicle ID, returns the suspension bias that currently applies to vehicles of that ID. Returns false in case of failure.
The suspension bias is a number between 0 and 1. If it's 0, the back tires have all the suspension and the front tires have none. If it's 1, the front tires have suspension and the back tires have none. If it's 0.5, front and back tires have the same suspension strength.
Example
--TODO