HandlingGetDragCoefficiency: 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 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{Disabled|It has never existed.}} | |||
Returns the drag coefficient (amount of air resistance) of a handling element or a vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetDragCoefficiency ( handling theHandling ) | |||
float handlingGetDragCoefficiency ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theHandling:''' the handling you wish to get the drag coefficient of, ''or'' | |||
*'''vehicleID:''' the vehicle ID you wish to get the drag coefficient of. | |||
===Returns=== | ===Returns=== | ||
If you specified a handling element, returns its drag coefficient if one was set, or ''nil'' otherwise. If you specified a (valid) vehicle ID, returns the drag coefficient that currently applies to vehicles of that ID. Returns ''false'' in case of failure. | |||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function getDragCoefficiency ( player, command ) | |||
local vehicle = getPedOccupiedVehicle(player) | |||
if vehicle then | |||
str = handlingGetDragCoefficiency(getElementModel(vehicle)) | |||
outputChatBox("Your vehicle's handling drag coefficiency is "..str,player,0,255,255) | |||
end | |||
end | |||
addCommandHandler ( "dragcoe", getDragCoefficiency ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Handling_functions}} | {{Handling_functions}} | ||
Latest revision as of 20:48, 29 October 2014
|
Function has been disabled. |
Reason/Note: It has never existed. |
Returns the drag coefficient (amount of air resistance) of a handling element or a vehicle ID.
Syntax
float handlingGetDragCoefficiency ( handling theHandling ) float handlingGetDragCoefficiency ( int vehicleID )
Required Arguments
- theHandling: the handling you wish to get the drag coefficient of, or
- vehicleID: the vehicle ID you wish to get the drag coefficient of.
Returns
If you specified a handling element, returns its drag coefficient if one was set, or nil otherwise. If you specified a (valid) vehicle ID, returns the drag coefficient that currently applies to vehicles of that ID. Returns false in case of failure.
Example
function getDragCoefficiency ( player, command )
local vehicle = getPedOccupiedVehicle(player)
if vehicle then
str = handlingGetDragCoefficiency(getElementModel(vehicle))
outputChatBox("Your vehicle's handling drag coefficiency is "..str,player,0,255,255)
end
end
addCommandHandler ( "dragcoe", getDragCoefficiency )