IsPlayerInVehicle: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function | This function checks if a player is in a vehicle. | ||
==Syntax== | ==Syntax== | ||
Line 6: | Line 6: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''player''': The [[player]] you are checking. | *'''player''': The [[player]] element you are checking. | ||
===Returns=== | ===Returns=== | ||
Returns true if | Returns ''true'' if the player is inside a vehicle, ''false'' if he isn't or an invalid player was passed. | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua">if ( isPlayerInVehicle ( | This code defines an ''isinvehicle'' command which tells a player whether another player is in a vehicle or not. | ||
<syntaxhighlight lang="lua"> | |||
-- define a handler for the isinvehicle command | |||
addCommandHandler ( "isinvehicle", "outputIsInVehicle" ) | |||
-- 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 | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Player functions}} | {{Player functions}} |
Revision as of 14:59, 22 April 2007
This function checks if a player is in a vehicle.
Syntax
bool isPlayerInVehicle ( player thePlayer )
Required Arguments
- player: 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.
-- define a handler for the isinvehicle command addCommandHandler ( "isinvehicle", "outputIsInVehicle" ) -- 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
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState