IsPedInWater: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Visual improvement)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Server client function}}
{{Deprecated|isElementInWater}}


Checks whether or not a ped is currently in water.
Checks whether or not a ped is currently in water.
Line 16: Line 17:


==Example==
==Example==
<section name="Client" class="client" 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">
<syntaxhighlight lang="lua">
function showPlayersInWater(sourcePlayer, command)
function showPlayersInWater ( sourcePlayer, command )
local players = getElementsByType("player")
local players = getElementsByType ( "player" )
local list = ""
local list = ""
for k,v in ipairs(players) do
for k,v in ipairs ( players ) do
if isPedInWater(v) then
if isPedInWater ( v ) then
list = list .. " " .. getPlayerName(v)
list = list .. " " .. getPlayerName ( v )
end
end
end
end
Line 30: Line 32:
addCommandHandler("playersInWater", showPlayersInWater)
addCommandHandler("playersInWater", showPlayersInWater)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client_ped_functions}}
{{Ped_functions}}

Latest revision as of 11:43, 26 June 2014

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.


Checks whether or not a ped is currently in water.

Syntax

bool isPedInWater ( ped thePed )

Required Arguments

  • thePed: the ped you want to check

Returns

Returns true if the ped is in water, false if he is not or an invalid element was passed.

Example

Click to collapse [-]
Client

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 isPedInWater ( v ) then
			list = list .. " " .. getPlayerName ( v )
		end
	end
	outputChatBox("Players pretending to be trouts: " .. list, sourcePlayer)
end
addCommandHandler("playersInWater", showPlayersInWater)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPedInWater?oldid=40330"