IsPedInVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Server and client now.)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Server client function}}


Checks whether or not a given ped is currently in a vehicle.
Checks whether or not a given ped is currently in a vehicle.

Revision as of 23:19, 18 January 2009

Checks whether or not a given ped is currently in a vehicle.

Syntax

bool isPedInVehicle ( ped thePed )

Required Arguments

  • thePed: the ped you want to check.

Returns

Returns true if the ped is in a vehicle, false if he is on foot or an invalid element 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 there exists a player with that nick
	if ( checkedPlayer ) then
		-- if he's in a vehicle,
		if isPedInVehicle ( checkedPlayer ) then
			-- tell the source player
			outputChatBox ( checkedPlayerName .. " is in a vehicle.", sourcePlayer )
		-- if he'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