Squirrel/Server/Functions/Game/SetIslands

Revision as of 12:12, 26 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 - Portland open, Staunton and Shoreside open.

Syntax

bool SetIslands( int iIslands )

Arguments

• iIslands - The value for possible islands (check above)

Example

This will change the open islands when someone types '/setislands <value>'.

 
function onPlayerCommand( player, command, text )
{
	if ( command == "setislands" ) 
	{
		if ( ( text.tointeger() < 4 )  && ( text.tointeger() >= 0 ) SetIslands( text.tointeger() )
		else MessagePlayer( "Error - Allowed islands must be between 0 and 3", player );
	}
 
	return 1;	
}
 
 

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