ResetWaterLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (fix typo)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{New feature/item|3.0120|1.2||
Only available in MTA:SA 1.2 and onwards.
}}
This function resets the water of the GTA world back to its default level. [[water|Water elements]] are not affected.
This function resets the water of the GTA world back to its default level. [[water|Water elements]] are not affected.


Line 10: Line 7:
bool resetWaterLevel ()
bool resetWaterLevel ()
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[Water]].resetLevel}}


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

Latest revision as of 14:30, 7 August 2016

This function resets the water of the GTA world back to its default level. Water elements are not affected.

Syntax

bool resetWaterLevel ()


OOP Syntax Help! I don't understand this!

Method: Water.resetLevel(...)


Returns

Returns true if water level was reset correctly, false otherwise.

Example

This example adds a command resetwaterlevel with which a player can reset the water level.

function changeWaterLevelBackToNormal ()
    resetWaterLevel ()
end
addCommandHandler ( "resetwaterlevel", changeWaterLevelBackToNormal )

Requirements

Minimum server version 1.2
Minimum client version 1.2

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.2" client="1.2" />

See Also