HandlingGetMass: 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 |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{Disabled|It has never existed.}} | |||
Returns the mass of a handling element or vehicle ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float handlingGetMass ( handling theHandling ) | |||
float handlingGetMass ( int vehicleID ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===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=== | ===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== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function getMass ( player, command ) | |||
local vehicle = getPedOccupiedVehicle(player) | |||
if vehicle then | |||
str = handlingGetMass(getElementModel(vehicle)) | |||
outputChatBox("Your vehicle's handling mass is "..str,player,0,255,255) | |||
end | |||
end | |||
addCommandHandler ( "getmass", getMass ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Handling_functions}} | {{Handling_functions}} |
Latest revision as of 20:49, 29 October 2014
Function has been disabled. | |
Reason/Note: It has never existed. |
Returns the mass of a handling element or vehicle ID.
Syntax
float handlingGetMass ( handling theHandling ) float handlingGetMass ( 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
function getMass ( player, command ) local vehicle = getPedOccupiedVehicle(player) if vehicle then str = handlingGetMass(getElementModel(vehicle)) outputChatBox("Your vehicle's handling mass is "..str,player,0,255,255) end end addCommandHandler ( "getmass", getMass )