IsPlayerInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Change deprecated function alternative.)
 
(8 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Needs_Checking|bool isPlayerOnGround ( player thePlayer )  ... Shouldn't clientside also have player theplayer in the brackets here?--[[User:Ransom|Ransom]] 08:50, 19 September 2007 (CDT) }}
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function is used to determine whether or not a player is currenlty in water.
{{Deprecated|isElementInWater}}
 
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==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool isPlayerInWater ( player thePlayer )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isPlayerInWater ( player thePlayer )</syntaxhighlight>


Line 14: Line 13:
===Returns===
===Returns===
Returns ''true'' if the player is in water, ''false'' otherwise.
Returns ''true'' if the player is in water, ''false'' otherwise.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool isPlayerInWater (  )</syntaxhighlight>
===Returns===
Returns ''true'' if the player is in water, ''false'' otherwise.
</section>


==Example==
==Example==
<section name="Serverside example" class="server" show="true">
This example shows all players that are in water in a list to the player who enters the 'playersInWater' command.
This example shows all players that are in water in a list to the player who enters the 'playersInWater' command.
<syntaxhighlight lang="lua"> [lua]
<syntaxhighlight lang="lua">
function showPlayersInWater(sourcePlayer, command)
function showPlayersInWater(sourcePlayer, command)
local players = getElementsByType("player")
local players = getElementsByType("player")
Line 38: Line 30:
addCommandHandler("playersInWater", showPlayersInWater)
addCommandHandler("playersInWater", showPlayersInWater)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Latest revision as of 06:08, 22 September 2021

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 isElementInWater instead.


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

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. 

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=72413"