GetVehicleTurnVelocity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to retrieve a vehicle's turning velocity for each axis.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float float getVehicleTurnVelocity ( vehicle theVehicle )
float float float getVehicleTurnVelocity ( vehicle theVehicle )
Line 11: Line 9:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theVehicle:''' The [[vehicle]] you wish to get the turning velocities of.
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns 3 ''floats'' that represent the vehicle's turning velocity on the x, y and z axis.
*Returns ''true'' if blah, ''false'' otherwise.
*x, y, z  


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
 
This example does...
This page does not currently have an example
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
--enter an example here
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 
{{FunctionArea_functions}}
{{Vehicle Functions}}
[[Category:Incomplete]] -- leave this unless you complete the function
[[Category:Needs_Example]]

Revision as of 16:52, 27 August 2007

This function is used to retrieve a vehicle's turning velocity for each axis.

Syntax

float float float getVehicleTurnVelocity ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle you wish to get the turning velocities of.

Returns

Returns 3 floats that represent the vehicle's turning velocity on the x, y and z axis.

Example

This page does not currently have an example

--enter an example here

See Also

Template:Vehicle Functions