IsPlayerInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
{{Deprecated}}
{{Deprecated}}
Please use [[isPedInWater]]
This function is used to determine whether or not a player is currently in water. Player is in water only if breath bar appears.
This function is used to determine whether or not a player is currently in water. Player is in water only if breath bar appears.



Revision as of 20:54, 20 April 2011

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


Please use isPedInWater

This function is used to determine whether or not a player is currently in water. Player is in water only if breath bar appears.

Syntax

Click to collapse [-]
Server and client
bool isPlayerInWater ( player thePlayer )

Required Arguments

  • thePlayer: The player you are checking.

Returns

Returns true if the player is in water, false otherwise.

Example

Click to collapse [-]
Serverside example

This example shows all players that are in water in a list to the player who enters the 'playersInWater' command.

 [lua]
function showPlayersInWater(sourcePlayer, command)
	local players = getElementsByType("player")
	local list = ""
	for k,v in ipairs(players) do
		if isPlayerInWater(v) then
			list = list .. " " .. getClientName(v)
		end
	end
	outputChatBox("Players pretending to be trouts: " .. list, sourcePlayer)
end
addCommandHandler("playersInWater", showPlayersInWater)

See Also