HandlingGetTractionMultiplier: Difference between revisions

From Multi Theft Auto: Wiki
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
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
 
Returns the traction multiplier of a handling element or vehicle ID. Low values correspond to slippery tires, high values mean good grip.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
 
float handlingGetTractionMultiplier ( handling theHandling )
float handlingGetTractionMultiplier ( int vehicleID )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
 
*'''theHandling:''' the handling of which you want to get the traction multiplier, ''or''
*'''vehicleID:''' the vehicle ID of which you want to get the traction multiplier.


===Returns===
===Returns===
If you specified a handling element, returns its traction multiplier if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the traction multiplier that currently applies to vehicles of that ID. Returns ''false'' in case of failure.


==Example==
==Example==

Latest revision as of 19:54, 27 March 2008

Returns the traction multiplier of a handling element or vehicle ID. Low values correspond to slippery tires, high values mean good grip.

Syntax

float handlingGetTractionMultiplier ( handling theHandling )
float handlingGetTractionMultiplier ( int vehicleID )

Required Arguments

  • theHandling: the handling of which you want to get the traction multiplier, or
  • vehicleID: the vehicle ID of which you want to get the traction multiplier.

Returns

If you specified a handling element, returns its traction multiplier if one is set, or nil otherwise. If you specified a vehicle ID, returns the traction multiplier that currently applies to vehicles of that ID. Returns false in case of failure.

Example

--TODO

See Also