IsPlayerInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(watch the spelling pal)
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function is used to determine whether or not a player is currently in water.
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==
==Syntax==

Revision as of 19:01, 2 November 2008

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


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerInWater?oldid=17798"