Squirrel/Server/Functions/Game/GetWeatherLock

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(New page: __NOTOC__ This function returns whether the automatic weather option has been locked. == Syntax == <code>bool GetWeatherLock()</code> == Arguments == * '''none''' == Example == {{Squ...)
 
(Example)
Line 12: Line 12:
 
== Example ==
 
== Example ==
  
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
-- todo
+
function onPlayerCommand( player, command, text )
 +
{
 +
if ( command == "weatherlock" ) GetWeatherLock()
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
-- Example notes here
+
This function is used to get the current status of the weather lock in the server.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Game}}
 
{{Squirrel/Server/Functions/Game}}

Revision as of 02:46, 7 January 2010

This function returns whether the automatic weather option has been locked.

Syntax

  1. bool GetWeatherLock()

Arguments

  • none

Example

  1.  
  2. function onPlayerCommand( player, command, text )
  3. {
  4. if ( command == "weatherlock" ) GetWeatherLock()
  5. }
  6.  

Notes

This function is used to get the current status of the weather lock in the server.

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox