GetWaveHeight: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (fix oop) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
float getWaveHeight() | float getWaveHeight() | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Water]].getWaveHeight||setWaveHeight}} | |||
===Returns=== | ===Returns=== | ||
| Line 16: | Line 18: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function scriptWave ( thePlayer, command, height ) | function scriptWave ( thePlayer, command, height ) | ||
local oldHeight = getWaveHeight() | |||
height = tonumber ( height ) | |||
success = setWaveHeight ( height ) | |||
if ( success ) then | |||
outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getPlayerName ( thePlayer ) .. " set it to: " .. height ) | |||
else | |||
outputChatBox ( "Invalid number." ) | |||
end | |||
end | end | ||
addCommandHandler ( "setwave", scriptWave ) | addCommandHandler ( "setwave", scriptWave ) | ||
Latest revision as of 15:07, 7 August 2016
This function returns the current wave height.
Syntax
float getWaveHeight()
OOP Syntax Help! I don't understand this!
- Method: Water.getWaveHeight(...)
- Counterpart: setWaveHeight
Returns
Returns the height as a float, false otherwise.
Example
Click to collapse [-]
ServerThis example changes the wave height to the given amount.
function scriptWave ( thePlayer, command, height ) local oldHeight = getWaveHeight() height = tonumber ( height ) success = setWaveHeight ( height ) if ( success ) then outputChatBox ( "The old wave height was: " .. oldHeight .. "; " .. getPlayerName ( thePlayer ) .. " set it to: " .. height ) else outputChatBox ( "Invalid number." ) end end addCommandHandler ( "setwave", scriptWave )
See Also
- createWater
- getWaterColor
- getWaterVertexPosition
- getWaveHeight
- resetWaterColor
- resetWaterLevel
- setWaterColor
- setWaterLevel
- setWaterVertexPosition
- setWaveHeight