IsPlayerInVehicle

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use isPedInVehicle instead.


This function checks if a player is in a vehicle.

Syntax

bool isPlayerInVehicle ( player thePlayer )

Required Arguments

  • thePlayer: The player element you are checking.

Returns

Returns true if the player is inside a vehicle, false if he isn't or an invalid player was passed.

Example

This code defines an isinvehicle command which tells a player whether another player is in a vehicle or not.

-- we create our handler function, where sourcePlayer is the player who sent the command,
-- and checkedPlayerName is the player name specified.
function outputIsInVehicle ( sourcePlayer, commandName, checkedPlayerName )
	-- we get the player element from the nick specified
	local checkedPlayer = getPlayerFromNick ( checkedPlayerName )
	-- if it exists,
	if ( checkedPlayer ) then
		-- if it's in a vehicle,
		if isPlayerInVehicle ( checkedPlayer ) then
			-- tell the source player
			outputChatBox ( checkedPlayerName .. " is in a vehicle.", sourcePlayer )
		-- if it's not in a vehicle,
		else
			-- tell the source player
			outputChatBox ( checkedPlayerName .. " is not in a vehicle.", sourcePlayer )
		end
	-- if it doesn't exist,
	else
		-- tell the source player
		outputChatBox ( "Invalid player name.", sourcePlayer )
	end
end

-- define a handler for the isinvehicle command
addCommandHandler ( "isinvehicle", outputIsInVehicle )

See Also