Difference between revisions of "ForceWeather"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1)))
Line 1: Line 1:
'''Syntax:'''
+
{{Function
  ForceWeather ''WeatherID'' ''WeatherOverrideFlag (optional)''
+
  |CSWikiPage = ForceWeather
'''Example:'''
+
|origin = GECK1
  ForceWeather MegatonCloudy01
+
|summary = Forces the weather to immediately switch to the specified weather. If OverrideWeatherFlag is 1, the weather will not change again until [[ReleaseWeatherOverride]] is called. Otherwise, the weather will change back in the normal fashion according to the weather system.
 +
|name = ForceWeather
 +
|alias = FW
 +
|returnType = void
 +
|arguments =
 +
  {{FunctionArgument
 +
  |Name = WeatherID
 +
  |Type = ref
 +
  }}{{FunctionArgument
 +
  |Name = WeatherOverrideFlag
 +
  |Type = int (optional)
 +
  |Value = 0, 1
 +
  |Optional = y
 +
  }}
 +
|example = ForceWeather MegatonCloudy01
 
  ForceWeather MegatonFalloutDecay 1
 
  ForceWeather MegatonFalloutDecay 1
 
  fw SuburbanCloudy
 
  fw SuburbanCloudy
 
+
}}
Forces the weather to immediately switch to the specified weather. If OverrideWeatherFlag is 1, the weather will not change again until [[ReleaseWeatherOverride]] is called. Otherwise, the weather will change back in the normal fashion according to the weather system.
+
  
 
==See Also==
 
==See Also==

Revision as of 08:45, 15 January 2011

Link to TES4 Construction Set Wiki: ForceWeather.

A function included in the GECK version 1.1.0.36.

Description

Forces the weather to immediately switch to the specified weather. If OverrideWeatherFlag is 1, the weather will not change again until ReleaseWeatherOverride is called. Otherwise, the weather will change back in the normal fashion according to the weather system.

Syntax

ForceWeather WeatherID:ref WeatherOverrideFlag:int (optional){0, 1} 

Or:

FW WeatherID:ref WeatherOverrideFlag:int (optional){0, 1}

Example

ForceWeather MegatonCloudy01
ForceWeather MegatonFalloutDecay 1
fw SuburbanCloudy

See Also

Personal tools