HandlingGetSuspensionForceLevel: 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}})
 
No edit summary
 
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
 
Returns the suspension force level (strength of the springs) of a handling element or vehicle ID.


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


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


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


==Example==
==Example==

Latest revision as of 21:15, 27 March 2008

Returns the suspension force level (strength of the springs) of a handling element or vehicle ID.

Syntax

float handlingGetSuspensionForceLevel ( handling theHandling )
float handlingGetSuspensionForceLevel ( int vehicleID )

Required Arguments

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

Returns

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

Example

--TODO

See Also