Scripting/Squirrel/Functions/GetWaterLevel: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will get the water level of the game. == Syntax == <pre>GetWaterLevel()</pre> == Arguments == '''N/A''' == Return value == * ''int'' '''waterlevel''' - The...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 14: Line 14:


== Example ==
== Example ==
 
The following example messages current water level to everyone when someone types the command.<source lang=squirrel>
{{Scripting/Needs_Example}}
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "waterlvl" ) Message( GetWaterLevel().tostring() );
}
</source>


=== Notes ===
=== Notes ===
 
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Server_Settings}}
{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Latest revision as of 19:16, 30 January 2017

This function will get the water level of the game.

Syntax

GetWaterLevel()

Arguments

N/A

Return value

  • int waterlevel - The water level of the game (default is 6)

Example

The following example messages current water level to everyone when someone types the command.

function onPlayerCommand( player, cmd, text );
{
 if ( cmd == "waterlvl" ) Message( GetWaterLevel().tostring() );
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

Retrieved from "http://wiki.vc-mp.org/index.php?title=Scripting/Squirrel/Functions/GetWaterLevel&oldid=19790"