Table of Contents

Class WeatherScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Weather.psc.

public static class WeatherScript
Inheritance
WeatherScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

FindWeather(int)

Finds a weather from the current region/climate whose classification matches the given one. 0 - Pleasant 1 - Cloudy 2 - Rainy 3 - Snow

public static Task<Weather?> FindWeather(int auiType)

Parameters

auiType int

Returns

Task<Weather?>

Remarks

SkyrimForge Note: Only the weathers of the current climate are searched, so a climate that declares none of the requested classification returns null.

ForceActive(PapyrusScript<Weather>, bool)

Forces the active weather on the sky to be this weather.

[Obsolete("Uses the Papyrus virtual machine. Prefer TaskQueueInterface.QueueForceWeather(Weather, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ForceActive(this PapyrusScript<Weather> self, bool abOverride = false)

Parameters

self PapyrusScript<Weather>
abOverride bool

Returns

Task

GetClassification(PapyrusScript<Weather>)

Gets this weather's classification -1 - No classification 0 - Pleasant 1 - Cloudy 2 - Rainy 3 - Snow

public static Task<int> GetClassification(this PapyrusScript<Weather> self)

Parameters

self PapyrusScript<Weather>

Returns

Task<int>

GetCurrentWeather()

Gets the sky's current weather

public static Task<Weather?> GetCurrentWeather()

Returns

Task<Weather?>

GetCurrentWeatherTransition()

Gets the transition percentage of the current weather

public static Task<float> GetCurrentWeatherTransition()

Returns

Task<float>

GetFogDistance(PapyrusScript<Weather>, bool, int)

0 - Near 1 - Far 2 - Power 3 - Max

public static Task<float> GetFogDistance(this PapyrusScript<Weather> self, bool day, int type)

Parameters

self PapyrusScript<Weather>
day bool
type int

Returns

Task<float>

GetOutgoingWeather()

Gets the sky's outgoing weather

public static Task<Weather?> GetOutgoingWeather()

Returns

Task<Weather?>

GetSkyMode()

Gets the sky's current mode 0 - No sky (SM_NONE) 1 - Interior (SM_INTERIOR) 2 - Skydome only (SM_SKYDOME_ONLY) 3 - Full sky (SM_FULL)

public static Task<int> GetSkyMode()

Returns

Task<int>

GetSunDamage(PapyrusScript<Weather>)

Returns the sun damage percentage

public static Task<float> GetSunDamage(this PapyrusScript<Weather> self)

Parameters

self PapyrusScript<Weather>

Returns

Task<float>

GetSunGlare(PapyrusScript<Weather>)

Returns the sun glare percentage

public static Task<float> GetSunGlare(this PapyrusScript<Weather> self)

Parameters

self PapyrusScript<Weather>

Returns

Task<float>

GetWindDirection(PapyrusScript<Weather>)

Returns the wind direction in degrees (0-360)

public static Task<float> GetWindDirection(this PapyrusScript<Weather> self)

Parameters

self PapyrusScript<Weather>

Returns

Task<float>

GetWindDirectionRange(PapyrusScript<Weather>)

Returns the wind direction range in degrees (0-180)

public static Task<float> GetWindDirectionRange(this PapyrusScript<Weather> self)

Parameters

self PapyrusScript<Weather>

Returns

Task<float>

ReleaseOverride()

Tells the sky to release its overriding weather.

public static Task ReleaseOverride()

Returns

Task

SetActive(PapyrusScript<Weather>, bool, bool)

Sets the active weather on the sky to be this weather.

[Obsolete("Uses the Papyrus virtual machine. Prefer Sky.SetWeather(Weather, bool, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetActive(this PapyrusScript<Weather> self, bool abOverride = false, bool abAccelerate = false)

Parameters

self PapyrusScript<Weather>
abOverride bool
abAccelerate bool

Returns

Task