IsPedInWater

From Multi Theft Auto: Wiki
Revision as of 19:44, 20 April 2011 by Arran Fortuna (talk | contribs)
Jump to navigation Jump to search

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 isElementInWater

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