Squirrel/Server/Functions/Game/SetIslands
From Liberty Unleashed Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
{{Squirrel/Title|SetIslands}} | {{Squirrel/Title|SetIslands}} | ||
This function sets the allowed islands when the server is in Liberty Unleashed mode. Possible values are: | This function sets the allowed islands when the server is in Liberty Unleashed mode. Possible values are: | ||
| − | * '''0''' - All islands | + | * '''0''' - All islands open. |
| − | * '''1''' - Portland | + | * '''1''' - Portland and Staunton open, Shoreside closed. |
| − | * '''2''' - Portland | + | * '''2''' - Portland closed, Staunton and Shoreside open. |
| − | + | * '''3''' - PPortland open, Staunton and Shoreside open. | |
| − | * ''' | + | |
| − | + | ||
| − | + | ||
== Syntax == | == Syntax == | ||
| Line 18: | Line 15: | ||
== Example == | == Example == | ||
| + | |||
| + | This will change the open islands when someone types '/setislands <value>'. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| Line 24: | Line 23: | ||
if ( command == "setislands" ) | if ( command == "setislands" ) | ||
{ | { | ||
| − | if ( ( text.tointeger() < | + | if ( ( text.tointeger() < 4 ) && ( text.tointeger() >= 0 ) SetIslands( text.tointeger() ) |
| − | else MessagePlayer( "Error - Allowed islands must be between 0 and | + | else MessagePlayer( "Error - Allowed islands must be between 0 and 3", player ); |
} | } | ||
| − | + | ||
| + | return 1; | ||
} | } | ||
| Line 34: | Line 34: | ||
=== Notes === | === Notes === | ||
| − | + | The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Game}} | {{Squirrel/Server/Functions/Game}} | ||
Revision as of 19:23, 25 October 2010
This function sets the allowed islands when the server is in Liberty Unleashed mode. Possible values are:
- 0 - All islands open.
- 1 - Portland and Staunton open, Shoreside closed.
- 2 - Portland closed, Staunton and Shoreside open.
- 3 - PPortland open, Staunton and Shoreside open.
Syntax
Arguments
- iIslands - The value for possible islands (check above)
Example
This will change the open islands when someone types '/setislands <value>'.
Notes
The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.
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
