https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=DakotaRenoMulti Theft Auto: Wiki - User contributions [en]2026-04-15T07:53:13ZUser contributionsMediaWiki 1.39.3https://wiki.multitheftauto.com/index.php?title=GetWaterLevel&diff=33757GetWaterLevel2012-10-16T23:10:40Z<p>DakotaReno: /* Optional Arguments */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}} <br />
{{Needs Checking|Explain bCheckWaves. --[[User:Winky-|Winky-]] 20:32, 10 August 2012 (UTC)}}<br />
This function allows you to retrieve the water level from a certain location. The water level is 0 in most places though it can vary (e.g. it's higher near the dam).<br />
{{Note|Some small water areas within parts of the city do not count as water to be used with this function. For example, the shallow water area in Northwest San Fierro.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
float getWaterLevel ( float posX, float posY, float posZ [ , bool bCheckWaves = false ] )<br />
float getWaterLevel ( water theWater )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''x:''' The X axis position<br />
*'''y:''' The Y axis position<br />
*'''z:''' The Z axis position<br />
<br />
''or:''<br />
*'''theWater:''' the water element<br />
<br />
===Optional Arguments=== <br />
*'''bCheckWaves''' Include the water levels of waves in the ocean, lakes and ...<br />
<br />
===Returns===<br />
Returns ''false'' if there's no water in that location or the water level as an ''integer'' if you're near the water (-3 to 20 on the Z coordinate).<br />
<br />
==Example==<br />
This example will tell you what's the water level where the specified player is located.<br />
<syntaxhighlight lang="lua"><br />
function scriptGetLevel ( command, playername ) --when getlevel is called<br />
local thePlayer = getPlayerFromName ( playername ) --get the player from nickname<br />
if ( thePlayer ~= false ) then --if there is a player from the nickname<br />
local x, y, z = getElementPosition ( thePlayer ) -- get his position<br />
local level = getWaterLevel ( x, y, z )<br />
if level then -- if it's not false<br />
level = z - level -- calculate how far away is he from the water<br />
outputChatBox( "You are " .. level .. " units away from the water!", source )<br />
else outputChatBox ( "There's no sign of water" )<br />
end<br />
else outputChatBox ( "Player does not exist" )<br />
end<br />
end<br />
addCommandHandler( "getlevel", scriptGetLevel ) -- add a command "getloc" which<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client water functions}}</div>DakotaRenohttps://wiki.multitheftauto.com/index.php?title=GetWaterLevel&diff=33756GetWaterLevel2012-10-16T23:07:38Z<p>DakotaReno: /* Optional Arguments */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}} <br />
{{Needs Checking|Explain bCheckWaves. --[[User:Winky-|Winky-]] 20:32, 10 August 2012 (UTC)}}<br />
This function allows you to retrieve the water level from a certain location. The water level is 0 in most places though it can vary (e.g. it's higher near the dam).<br />
{{Note|Some small water areas within parts of the city do not count as water to be used with this function. For example, the shallow water area in Northwest San Fierro.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
float getWaterLevel ( float posX, float posY, float posZ [ , bool bCheckWaves = false ] )<br />
float getWaterLevel ( water theWater )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''x:''' The X axis position<br />
*'''y:''' The Y axis position<br />
*'''z:''' The Z axis position<br />
<br />
''or:''<br />
*'''theWater:''' the water element<br />
<br />
===Optional Arguments=== <br />
*'''bCheckWaves''' Include water levels of waves in the ocean, lakes and ...<br />
<br />
===Returns===<br />
Returns ''false'' if there's no water in that location or the water level as an ''integer'' if you're near the water (-3 to 20 on the Z coordinate).<br />
<br />
==Example==<br />
This example will tell you what's the water level where the specified player is located.<br />
<syntaxhighlight lang="lua"><br />
function scriptGetLevel ( command, playername ) --when getlevel is called<br />
local thePlayer = getPlayerFromName ( playername ) --get the player from nickname<br />
if ( thePlayer ~= false ) then --if there is a player from the nickname<br />
local x, y, z = getElementPosition ( thePlayer ) -- get his position<br />
local level = getWaterLevel ( x, y, z )<br />
if level then -- if it's not false<br />
level = z - level -- calculate how far away is he from the water<br />
outputChatBox( "You are " .. level .. " units away from the water!", source )<br />
else outputChatBox ( "There's no sign of water" )<br />
end<br />
else outputChatBox ( "Player does not exist" )<br />
end<br />
end<br />
addCommandHandler( "getlevel", scriptGetLevel ) -- add a command "getloc" which<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client water functions}}</div>DakotaReno