IsPlayerInVehicle: Difference between revisions

Latest revision as of 16:42, 17 November 2019

IsPlayerInVehicle

Type: Function
Context: Client
Introduced: v1.0

Check if player is in vehicle or not.

IsPlayerInVehicle( [, player])

AddEvent("OnKeyPress", function(key)

	if not IsPlayerInVehicle() then
		return
	end

	AddPlayerChat(player, "You are in a vehicle.")
end)

@@ Line 1: / Line 1: @@
 {{Info|Function|Client|1.0}}
-{{FuncDescription|__EDIT_ME__}}
+{{FuncDescription|Check if player is in vehicle or not.}}
 {{FuncSyntax|IsPlayerInVehicle( [, player])}}
 {{FuncParameters}}
-{{FuncParam||__EDIT_ME__}}
+{{FuncParamOptional|player|The player identifier}}
-{{FuncParamOptional|player|__EDIT_ME__}}
-{{FuncReturnValue|__EDIT_ME__}}
+{{FuncReturnValue|Returns '''true''' on success.}}
 == Example ==
-__EDIT_ME__
+<syntaxhighlight lang="Lua">
+AddEvent("OnKeyPress", function(key)
+	if not IsPlayerInVehicle() then
+		return
+	end
+	AddPlayerChat(player, "You are in a vehicle.")
+end)
+</syntaxhighlight>
 {{RelatedFunctions}}
-__EDIT_ME__
+{{VehicleFunctions}}