HandlingGetABS: 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 |
||
(2 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{Needs_Example}} | |||
Returns the ABS (Anti-lock Braking System) setting of a handling element or vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool handlingGetABS ( handling theHandling ) | |||
bool handlingGetABS ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling of which you want to get the ABS setting, ''or'' | |||
*'''vehicleID:''' the vehicle ID of which you want to get the ABS setting. | |||
===Returns=== | ===Returns=== | ||
If you specified a handling element, returns its ABS setting if one is set (''true'' if ABS is active, ''false'' if not), or ''nil'' otherwise. If you specified a vehicle ID, returns the ABS setting that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
==Example== | ==Example== |
Latest revision as of 10:08, 12 July 2013
Script Example Missing Function HandlingGetABS needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
Returns the ABS (Anti-lock Braking System) setting of a handling element or vehicle ID.
Syntax
bool handlingGetABS ( handling theHandling ) bool handlingGetABS ( int vehicleID )
Required Arguments
- theHandling: the handling of which you want to get the ABS setting, or
- vehicleID: the vehicle ID of which you want to get the ABS setting.
Returns
If you specified a handling element, returns its ABS setting if one is set (true if ABS is active, false if not), or nil otherwise. If you specified a vehicle ID, returns the ABS setting that currently applies to vehicles of that ID. Returns false in case of failure.
Example
--TODO