HandlingGetTurnMass: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
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 turn mass of a handling element or vehicle ID.
Returns the turn mass of a handling element or vehicle ID.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int handlingGetTurnMass ( handling theHandling )
float handlingGetTurnMass ( handling theHandling )
int handlingGetTurnMass ( int vehicleID )
float handlingGetTurnMass ( int vehicleID )
</syntaxhighlight>
</syntaxhighlight>


Line 18: Line 20:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function getTurnMass ( player, command )
local vehicle = getPedOccupiedVehicle(player)
    if vehicle then
      str = handlingGetTurnMass(getElementModel(vehicle))
      outputChatBox("Your vehicle's handling turn mass is "..str,player,0,255,255)
    end
end
addCommandHandler ( "turnmass", getTurnMass )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Handling_functions}}
{{Handling_functions}}

Latest revision as of 20:50, 29 October 2014

Dialog-warning.png Function has been disabled.

Reason/Note: It has never existed.


Returns the turn mass of a handling element or vehicle ID.

Syntax

float handlingGetTurnMass ( handling theHandling )
float handlingGetTurnMass ( int vehicleID )

Required Arguments

  • theHandling: the handling of which you want to get the turn mass, or
  • vehicleID: the vehicle ID of which you want to get the turn mass.

Returns

If you specified a handling element, returns its turn mass if one is set, or nil otherwise. If you specified a vehicle ID, returns the turn mass that currently applies to vehicles of that ID. Returns false in case of failure.

Example

function getTurnMass ( player, command )
local vehicle = getPedOccupiedVehicle(player)
    if vehicle then
      str = handlingGetTurnMass(getElementModel(vehicle))
      outputChatBox("Your vehicle's handling turn mass is "..str,player,0,255,255)
    end
end
addCommandHandler ( "turnmass", getTurnMass )

See Also