GetWaterLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 24: Line 24:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function scriptGetLevel ( command, playername ) --when getlevel is called
function scriptGetLevel ( command, playername ) --when getlevel is called
   local player = getPlayerFromNick ( playername ) --get the player from nickname
   local thePlayer = getPlayerFromNick ( playername ) --get the player from nickname
   if ( player ~= false ) then --if there is a player from the nickname
   if ( thePlayer ~= false ) then --if there is a player from the nickname
     local x, y, z = getElementPosition ( player ) -- get his position
     local x, y, z = getElementPosition ( player ) -- get his position
     local bool, level = getWaterLevel ( x, y, z )
     local bool, level = getWaterLevel ( x, y, z )
outputChatBox ( tostring ( bool ) )
--outputChatBox ( tostring ( bool ) )
outputChatBox ( level )
--outputChatBox ( level )
outputChatBox ( "You are " .. level .. " meters away from the water!", source )
   else outputChatBox ( "Player does not exist" )
   else outputChatBox ( "Player does not exist" )
   end
   end

Revision as of 11:57, 11 August 2007

This function allows you to retrieve the water level from 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 thePlayer = getPlayerFromNick ( playername ) --get the player from nickname
  if ( thePlayer ~= 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 )
	outputChatBox ( "You are " .. level .. " meters away from the water!", source )
  else outputChatBox ( "Player does not exist" )
  end
end
addCommandHandler( "getlevel", scriptGetLevel ) -- add a command "getloc" which

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetWaterLevel?oldid=10091"