Squirrel/Server/Functions/Game/GetIslands
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
Line 1: | Line 1: | ||
− | + | {{Squirrel/Title|GetIslands}} | |
This function returns the current value for game islands when the server is in Liberty Unleashed mode. Possible values are: | This function returns the current value for game islands when the server is in Liberty Unleashed mode. Possible values are: | ||
* '''0''' - All islands closed | * '''0''' - All islands closed |
Latest revision as of 10:44, 11 October 2010
This function returns the current value for game islands when the server is in Liberty Unleashed mode. Possible values are:
- 0 - All islands closed
- 1 - Portland Island open, Staunton Island and Shoreside Vale closed
- 2 - Portland Island and Shoreside Vale closed, Staunton Island open
- 3 - Portland Island and Staunton Island closed, Shoreside Vale open
- 4 - Portland Island and Staunton Island open, Shoreside Vale closed
- 5 - Portland Island closed, Staunton Island and Shoreside Vale open
- 6 - All islands open
[edit] Syntax
int GetIslands()
[edit] Arguments
- none
[edit] Example
function onPlayerCommand( player, command, text ) { if ( command == "islands" ) MessagePlayer( "Current Island setting: " + GetIslands(), player ); }
[edit] Notes
This function is used to return what islands are currently being used by the server.
[edit] Related Functions
- CloseGarage
- CloseSSVBridge
- EnableTrains
- GetBoundariesLower
- GetBoundariesUpper
- GetFriendlyFire
- GetGamespeed
- GetGravity
- GetHour
- GetIslands
- GetMinute
- GetSSVBridgeLock
- GetSSVBridgeUpdateTime
- GetSurfaceTraction
- GetTimeLock
- GetWeather
- GetWeatherLock
- IsSSVBridgeUp
- OpenGarage
- OpenSSVBridge
- SetBoundaries
- SetFriendlyFire
- SetGamespeed
- SetGravity
- SetIslands
- SetSSVBridgeLock
- SetSSVBridgeUpdateTime
- SetSurfaceTraction
- SetTime
- SetTimeLock
- SetWeather
- SetWeatherLock