IsVehicleOnGround: Difference between revisions

Revision as of 14:48, 20 June 2007

Checks to see if a vehicle has contact with the ground.

bool isVehicleOnGround ( vehicle thevehicle )

Returns true if vehicle is on the ground, false otherwise.

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

@@ Line 1: / Line 1: @@
 __NOTOC__
-<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+Checks to see if a vehicle has contact with the ground.
-This fake function is for use with blah & blah and does blahblahblabhalbhl
 ==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">
 bool isVehicleOnGround ( vehicle thevehicle )
@@ Line 10: / Line 8: @@
 ===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 check.
-*'''argumentName:''' description
-<!-- Only include this section below if there are optional arguments -->
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' description
-*'''argumentName3:''' description
 ===Returns===
-<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
+Returns ''true'' if vehicle is on the ground, ''false'' otherwise.
-Returns ''true'' if blah, ''false'' otherwise.
 ==Example==