GetWaterLevel: Difference between revisions

Revision as of 09:38, 5 August 2007

This function allows you to retrieve water level in a certain position.

Syntax

bool float getWaterLevel ( float posX, float posY, float posZ, [ bool checkWaves ] )

Required Arguments

x: The X axis position
y: The Y axis position
z: The Z axis position

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

checkWaves: An optional argument to choose if you want to return the height of the waves. ??

Returns

I'm not sure what it must return, all I got was false and 0. ??

Example

This example will tell you what's the water level where the specified player is located. NEEDS UPDATING!!!

function scriptGetLevel ( command, playername ) --when getlevel is called
  local player = getPlayerFromNick ( playername ) --get the player from nickname
  if ( player ~= false ) then --if there is a player from the nickname
    local x, y, z = getElementPosition ( player ) -- get his position
    local bool, level = getWaterLevel ( x, y, z )
	outputChatBox ( tostring ( bool ) )
	outputChatBox ( level )
  else outputChatBox ( "Player does not exist" )
  end
end
addCommandHandler( "getlevel", scriptGetLevel ) -- add a command "getloc" which

@@ Line 21: / Line 21: @@
 ==Example==
-<section name="Client" class="client" show="true">
 This example will tell you what's the water level where the specified player is located. '''NEEDS UPDATING!!!'''
 <syntaxhighlight lang="lua">
@@ Line 36: / Line 35: @@
 addCommandHandler( "getlevel", scriptGetLevel ) -- add a command "getloc" which
 </syntaxhighlight>
-</section>
 ==See Also==
 {{Client_world_functions}}