HandlingGetCenterOfMass: Difference between revisions

From Multi Theft Auto: Wiki
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}})
 
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
 
{{Needs_Example}}
Returns the center of mass of a handling element or vehicle ID. This is a 3D vector relative to the center of the mesh.


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


===Required Arguments===
===Required Arguments===
 
*'''theHandling:''' the handling of which you wish to get the center of mass, ''or''
*'''int vehicleID:''' the vehicle ID of which you want to get the center of mass.


===Returns===
===Returns===
If you specified a handling element, returns the x, y and z components of the center of mass vector of the handling element if it is set, or ''nil'' if not. If you specified a vehicle ID, returns the x, y, and z components of the center of mass that currently applies to vehicles of that ID. Returns ''false'' in case of failure.


==Example==
==Example==

Latest revision as of 14:00, 4 October 2016

Accessories-text-editor.png Script Example Missing Function HandlingGetCenterOfMass needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

Returns the center of mass of a handling element or vehicle ID. This is a 3D vector relative to the center of the mesh.

Syntax

float float float handlingGetCenterOfMass ( handling theHandling )
float float float handlingGetCenterOfMass ( int vehicleID )

Required Arguments

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

Returns

If you specified a handling element, returns the x, y and z components of the center of mass vector of the handling element if it is set, or nil if not. If you specified a vehicle ID, returns the x, y, and z components of the center of mass that currently applies to vehicles of that ID. Returns false in case of failure.

Example

--TODO

See Also