IsPlayerInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed "DeprecatedWithAlt" template to "Deprecated" and removed an unnecessary section)
m (Unexpected [lua] tag.)
Line 17: Line 17:
<section name="Serverside example" class="server" show="true">
<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")

Revision as of 14:32, 26 August 2016

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 isPedInWater 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=48917"