SetWaveHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 10: Line 10:
*'''height:''' A float between 0 and 100.
*'''height:''' A float between 0 and 100.


===Returns===
==Returns==
Returns ''true'' if the function was successful, ''false'' otherwise.
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.


==Example==  
==Example==  

Revision as of 15:53, 1 August 2007

This function sets the wave height to the desired value, the default is 0.

Syntax

bool setWaveHeight ( float height )

Required Arguments

  • height: A float between 0 and 100.

Returns

Returns a boolean value true or false that tells you if it was successful or not.

Example

This example changes the wave height to the given amount.

function scriptWave ( player, command, height )
  local oldHeight = getWaveHeight()
  height = tonumber ( height )
  success = setWaveHeight ( height )
  if ( success ) then
    outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getClientName ( player ) .. " set it to: " .. height )
  else outputChatBox ( "Invalid number." )
  end
end
addCommandHandler ( "setwave", scriptWave )

See Also