HandlingGetSuspensionAntidiveMultiplier: 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}}) |
m (Visual improvement) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{Deprecated|getVehicleHandling|You can also use [[getModelHandling]] to retrieve the handling data per model.}} | |||
Returns the suspension antidive multiplier of a handling element or vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetSuspensionAntidiveMultiplier ( handling theHandling ) | |||
float handlingGetSuspensionAntidiveMultiplier ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling of which you want to get the suspension antidive multiplier, ''or'' | |||
*'''vehicleID:''' the vehicle ID of which you want to get the suspension antidive multiplier. | |||
===Returns=== | ===Returns=== | ||
If you specified a handling element, returns its suspension antidive multiplier if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the antidive multiplier that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
==Example== | ==Example== | ||
Latest revision as of 11:40, 26 June 2014
|
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use getVehicleHandling instead. You can also use getModelHandling to retrieve the handling data per model. |
Returns the suspension antidive multiplier of a handling element or vehicle ID.
Syntax
float handlingGetSuspensionAntidiveMultiplier ( handling theHandling ) float handlingGetSuspensionAntidiveMultiplier ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the suspension antidive multiplier, or
- vehicleID: the vehicle ID of which you want to get the suspension antidive multiplier.
Returns
If you specified a handling element, returns its suspension antidive multiplier if one is set, or nil otherwise. If you specified a vehicle ID, returns the antidive multiplier that currently applies to vehicles of that ID. Returns false in case of failure.
Example
--TODO