Background for Starfield

The Weather Script

    The Weather script is a part of Starfield’s Papyrus scripting ecosystem. It is included with the base game.

    For this script, the Papyrus index knows about:

    • 10 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Structs

    The Papyrus Index is still under construction. Structs have not been implemented yet.

      Properties

      No properties found.

        Events

          No events found.

        Functions

        • voidfunctionEnableAmbientParticles(boolabEnable=true)NativeGlobal

          Enables or disables ambient particle effects coming from the weather.

        • WeatherfunctionFindWeather(KeywordaKeyword)NativeGlobal

          Finds a weather of the given type for the currently occupied region (if applicable) or climate.

        • voidfunctionForceActive(boolabOverride=false)Native

          Forces the active weather on the sky to be this weather. Weather will become fully transitioned immediately. To have the weather transition in normally, use Weather.SetActive(...) instead.

        • Keyword[]functionGetClassification()Native

          Gets this weather's classification, as specified in the editor.

        • WeatherfunctionGetCurrentWeather()NativeGlobal

          Gets the current weather.

        • floatfunctionGetCurrentWeatherTransition()NativeGlobal

          Returns a value from 0.0 to 1.0 describing how far in the current weather has transitioned. If no transition is occurring, this function returns 1.0 and Weather.GetOutgoingWeather() returns none. If this function returns any other value, Weather.GetOutgoingWeather() returns the weather which is transitioning out and Weather.GetCurrentWeather() returns the weather which is transitioning in.

        • WeatherfunctionGetOutgoingWeather()NativeGlobal

          Gets the weather which is currently transitioning out.

        • intfunctionGetSkyMode()NativeGlobal

          Gets the mode under which the sky is currently operating.

        • voidfunctionReleaseOverride()NativeGlobal

          Tells the sky to release its overriding weather.

        • voidfunctionSetActive(boolabOverride=false, boolabAccelerate=false)Native

          Sets the active weather on the sky to be this weather. Weather will transition in normally, according to its data. To force the weather to become fully transitioned immediately, use Weather.ForceActive(...) instead.

        Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.