Difference between revisions of "SetWaterLevel"

From Multi Theft Auto: Wiki
m
m
Line 5: Line 5:
  
 
==Syntax==
 
==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 )
 +
bool setWaterLevel ( [element water], float level )</syntaxhighlight>
  
 
===Required Arguments===
 
===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.
+
*'''level:''' the new Z coordinate of the water surface. If '''x''', '''y''' and '''z''', or '''water''', are specified, the area of water containing that point or corresponding to that water element is changed. Otherwise, all water in the game world is changed.
  
 
===Optional Arguments===
 
===Optional Arguments===
Line 14: Line 15:
 
*'''y:''' the Y 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.
 
*'''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.
 +
 +
''or:''
 +
*'''water:''' the water element to change.
  
 
===Returns===
 
===Returns===

Revision as of 21:01, 13 February 2009

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

Syntax

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

Required Arguments

  • level: the new Z coordinate of the water surface. If x, y and z, or water, are specified, the area of water containing that point or corresponding to that water element 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.

or:

  • water: the water element to change.

Returns

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

Example

Click to collapse [-]
Client
-- TODO

See Also