HandlingGetMass: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
Returns the mass | Returns the mass of a handling element or vehicle ID. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetMass ( handling theHandling ) | float handlingGetMass ( handling theHandling ) | ||
float | float handlingGetNass ( int vehicleID ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling | *'''theHandling:''' the handling of which you want to get the mass, ''or'' | ||
*'''vehicleID:''' the vehicle ID you want to get the mass | *'''vehicleID:''' the vehicle ID of which you want to get the mass. | ||
===Returns=== | ===Returns=== | ||
If you specified a handling element, returns | If you specified a handling element, returns its mass if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the mass that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | ||
==Example== | ==Example== | ||
Revision as of 22:58, 27 March 2008
Returns the mass of a handling element or vehicle ID.
Syntax
float handlingGetMass ( handling theHandling ) float handlingGetNass ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the mass, or
- vehicleID: the vehicle ID of which you want to get the mass.
Returns
If you specified a handling element, returns its mass if one is set, or nil otherwise. If you specified a vehicle ID, returns the mass that currently applies to vehicles of that ID. Returns false in case of failure.
Example
--TODO