SetWaterLevel: Difference between revisions

Revision as of 19:46, 13 February 2009

Sets the height of some or all the water in the game world.

bool setWaterLevel ( [float x, float y, float z,] float level )

level: the new Z coordinate of the water surface. If x, y and z are specified, the area of water containing that point is changed. Otherwise, all water in the game world is changed.

x: the X coordinate of the point indicating the water area to change.
y: the Y coordinate of the point indicating the water area to change.
z: the Z coordinate of the point indicating the water area to change. This parameter is reserved and is currently ignored, set it to 0.

Returns true if successful, false in case of failure (there is no water at the specified coordinates).

Click to collapse [-]

Client

-- TODO

@@ Line 2: / Line 2: @@
 {{Client function}}
-Sets the height of the area of water that contains the specified point.
+Sets the height of some or all the water in the game world.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setWaterLevel ( float x, float y, float z, float level )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setWaterLevel ( [float x, float y, float z,] float level )</syntaxhighlight>
 ===Required Arguments===
+*'''level:''' the new Z coordinate of the water surface. If '''x''', '''y''' and '''z''' are specified, the area of water containing that point is changed. Otherwise, all water in the game world is changed.
+===Optional Arguments===
 *'''x:''' the X coordinate of the point indicating the water area to change.
 *'''y:''' the Y coordinate of the point indicating the water area to change.
 *'''z:''' the Z coordinate of the point indicating the water area to change. This parameter is reserved and is currently ignored, set it to 0.
-*'''level:''' the new Z coordinate of the water surface.
 ===Returns===