IsVehicleOnGround: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Added note regarding isVehicleWheelOnGround)
 
(8 intermediate revisions by 7 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
Checks to see if a vehicle has contact with the ground.
Checks to see if a vehicle has contact with the ground.
{{Note|This function has a few issues, see below. Consider using the clientside function [[isVehicleWheelOnGround]] instead.}}


==Syntax==  
==Syntax==  
Line 7: Line 9:
bool isVehicleOnGround ( vehicle theVehicle )
bool isVehicleOnGround ( vehicle theVehicle )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:isOnGround|onGround}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The vehicle you wish to check.
*'''theVehicle:''' The vehicle you wish to check.


===Returns===
===Returns===
Returns ''true'' if vehicle is on the ground, ''false'' otherwise.
Returns ''true'' if vehicle is on the ground, ''false'' if it is not.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
 
This example does...
This example tells you when you've jumped out of a vehicle.
<!-- 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 -->
 
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function checkVState ( vehicle, seat, jacked )
blabhalbalhb --abababa
vehName = getVehicleName ( vehicle )
--This line does this...
 
mooo
if isVehicleOnGround ( vehicle ) == false then
outputChatBox ( "You jumped out of a "..vehName.."!", source, 255, 0, 0  )
end
 
end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), checkVState )
</syntaxhighlight>
</syntaxhighlight>
</section>
== Issues ==
{{Issues|
{{Issue|471|isVehicleOnGround sometimes returns false incorrectly}}
{{Issue|2093|isVehicleOnGround does not work after setVehicleHandling}}
}}


==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 -->
{{Vehicle functions}}
{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

Latest revision as of 21:15, 31 January 2022

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

[[{{{image}}}|link=|]] Note: This function has a few issues, see below. Consider using the clientside function isVehicleWheelOnGround instead.

Syntax

bool isVehicleOnGround ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:isOnGround(...)
Variable: .onGround


Required Arguments

  • theVehicle: The vehicle you wish to check.

Returns

Returns true if vehicle is on the ground, false if it is not.

Example

This example tells you when you've jumped out of a vehicle.

Click to collapse [-]
Server
function checkVState ( vehicle, seat, jacked )
	vehName = getVehicleName ( vehicle )

	if isVehicleOnGround ( vehicle ) == false then
		outputChatBox ( "You jumped out of a "..vehName.."!", source, 255, 0, 0  )
	end

end
addEventHandler ( "onPlayerVehicleExit", getRootElement(), checkVState )

Issues

Issue ID Description
#471 isVehicleOnGround sometimes returns false incorrectly
#2093 isVehicleOnGround does not work after setVehicleHandling

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsVehicleOnGround?oldid=73942"