SetWaterLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 6: Line 6:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setWaterLevel ( [float x, float y, float z,] float level )
<syntaxhighlight lang="lua">bool setWaterLevel ( [float x, float y, float z,] float level )
bool setWaterLevel ( [element water], float level )</syntaxhighlight>
bool setWaterLevel ( [water theWater], float level )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
Line 17: Line 17:


''or:''
''or:''
*'''water:''' the water element to change.
*'''theWater:''' the water element to change.


===Returns===
===Returns===

Revision as of 23:44, 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 ( [water theWater], 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:

  • theWater: 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

This example code will slowly drain away all rivers and seas. 

local level = 0

function drainSomeWater()
    level = level - 0.01
    setWaterLevel ( level )
end
setTimer ( drainSomeWater, 100, 15000 )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetWaterLevel?oldid=18389"