ResetWaterLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added oop syntax)
(Fix oop syntax)
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


{{OOP||[[water]]:resetLevel|resetLevel}}
{{OOP||[[water]]:resetLevel|resetLevel|setWaterLevel}}


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

Revision as of 17:54, 6 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(...)
Variable: .resetLevel
Counterpart: setWaterLevel


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