Scripting/Squirrel/Functions/GetWeather

From Vice City Multiplayer
Revision as of 08:20, 9 March 2017 by Xmair (talk | contribs) (→‎Example)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

This function will get the weather ID of the game.

Syntax

GetWeather()

Arguments

N/A

Return value

  • int weatherid - The weather ID of the game

Example

function onPlayerCommand( iPlayer, szCommand, szArguments ) {
	switch( szCommand.tolower( ) ) {
		case "setweather":
			if( !szArguments ) ClientMessage( "Invalid syntax, correct usage: /" + szCommand + " [ID]", iPlayer, 255, 0, 0, 255 );
			else if ( !IsNum( szArguments ) ) ClientMessage( "ID must be an integer.", iPlayer, 255, 0, 0, 255 );
			else if ( GetWeather() == szArguments ) ClientMessage( "The weather ID specified is already being used.", iPlayer, 255, 0, 0, 255 );
			else {
				SetWeather( szArguments );
				ClientMessageToAll( iPlayer.Name + " has set the weather to " + szArguments + "!", 255, 255, 255, 255 );
			}
		break;
	}	
}

Notes

Call onPlayerCommand and function SetWeather was 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/GetWeather&oldid=20014"