HandlingGetMaxVelocity: 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}}) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
Returns the maximum velocity of a handling element or vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetMaximumVelocity ( handling theHandling ) | |||
float handlingGetMaximumVelocity ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling of which you want to get the maximum velocity, ''or'' | |||
*'''vehicleID:''' the vehicle ID of which you want to get the maximum velocity. | |||
===Returns=== | ===Returns=== | ||
If you specified a handling element, returns its maximum velocity if one is set, or ''nil'' otherwise. If you specified a vehicle ID, returns the maximum velocity that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
==Example== | ==Example== | ||
Revision as of 20:30, 27 March 2008
Returns the maximum velocity of a handling element or vehicle ID.
Syntax
float handlingGetMaximumVelocity ( handling theHandling ) float handlingGetMaximumVelocity ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the maximum velocity, or
- vehicleID: the vehicle ID of which you want to get the maximum velocity.
Returns
If you specified a handling element, returns its maximum velocity if one is set, or nil otherwise. If you specified a vehicle ID, returns the maximum velocity that currently applies to vehicles of that ID. Returns false in case of failure.
Example
--TODO