COZY Documentation
  • Welcome!
    • πŸ‘‹Hello!
    • πŸ—ΊοΈRoadmap
    • πŸ†˜Support & Community
    • πŸŽ“Changelog
  • Getting Started
    • πŸ”ŒInstallation
    • πŸ› οΈSetting Up Your Project
    • 🌐Creating a New Scene
    • πŸ“¦COZY Samples
  • How it works
    • βš™οΈThe System Perspective
    • ⏱️Meridiem Time
    • 🌈Gradients & Curves
    • βš–οΈWeighted Random Chance (WRC)
    • πŸ§‘β€πŸ«Weather Selection & Forecasting
    • The Weather Sphere
      • 🌌The Sky Dome
      • ☁️The Cloud Dome
        • COZY Desktop Clouds
        • COZY Mobile Clouds
        • Soft Clouds
        • Painted Skies
        • Ghibli Desktop & Mobile Clouds
        • Single Texture Clouds
        • Luxury Clouds
      • 🌫️The Fog Dome
    • Modules
      • 🌌Atmosphere Module
      • πŸ•‘Time Module
      • 🌦️Weather Module
      • πŸƒAmbience Module
      • 🌑️Climate Module
      • ⚑Events Module
      • 🎨Interactions Module
      • ☁️Buto Module
      • 🌎MicroSplat Module
      • 🌳The Vegetation Engine (TVE) Module
      • πŸͺžReflections Module
      • πŸŒ™Satellite Module
      • πŸ—ƒοΈSave & Load Module
      • πŸŒ„Transit Module
      • πŸ’¨Wind Module
      • πŸ•‘System Time Module
      • πŸ›Debug Module
      • ☁️Plume Module
      • πŸŒ‡Blocks Module
      • πŸŒ‘Eclipse Module
      • πŸ“†Habits Module
      • 🎼ReSound Module
      • πŸ”—Link Module
    • Profiles
      • Ambience Profile
      • Atmosphere Profile
      • Forecast Profile
      • Perennial Profile
      • Satellite Profile
      • Material Profile
      • Weather Profile
      • FX Profiles
        • Audio FX
        • Climate FX
        • Cloud FX
        • Event FX
        • Filter FX
        • Multi FX
        • Particle FX
        • Precipitation FX
        • Thunder FX
        • Visual FX
        • Wind FX
      • Climate Profile
    • Biomes
    • Settings
  • Extending COZY
    • Stopping Indoor FX
    • Developing the Render Queue
    • Utilities
  • Integrations
    • Crest Water 4 (URP Only)
    • Crest Water 5
    • Stylized Water 2
    • KWS Water System
    • Generic Shader Graph
    • The Vegetation Engine
    • MicroSplat
  • Appendix
    • Frequently Asked Questions (FAQs)
    • Improving Performance With COZY 3
Powered by GitBook
On this page
  • Overview
  • Key Features
  • Edit the default wind
  • Control the wind FX
  • Get the current wind
  • Usage Examples
  • Get the current wind via C#
  • Make the wind stronger or weaker

Was this helpful?

  1. How it works
  2. Modules

Wind Module

PreviousTransit ModuleNextSystem Time Module

Last updated 1 year ago

Was this helpful?

Overview

Manage wind, wind FX and poll the current calculated values for the wind.

Compatibility Information

❌ Does not have equivalent COZY Biome Module

βœ… Works well with the

Key Features

Edit the default wind

Edit the wind amount, speed and change speed in the selection tab.

Control the wind FX

This module stores all of the wind FX that are used on the weather sphere and calculates the current wind based on that information.

Get the current wind

Easily see the current wind in your world and use it for calculations.

Usage Examples

Get the current wind via C#

The Wind Module has 4 different properties that you can poll using a C# script.

CozyWeather weatherSphere = CozyWeather.instance;

//Gives the current wind power.
weatherSphere.windModule.windAmount;
//Gives the current wind direction.
weatherSphere.windModule.WindDirection;
//Gives the current rate at which the wind will change power. Also determines the pulse frequency of the main windzone.
weatherSphere.windModule.windSpeed;
//Gives the current rate at which the wind will change direction.
weatherSphere.windModule.windChangeSpeed;

Make the wind stronger or weaker

This is very simple! In the Global Settings tab, simple adjust the Wind Multiplier slider to change the wind strength

πŸ’¨
Weather Module
Page cover image