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
  • Global Controls
  • Local Controls
  • Usage Examples
  • Setup Climate to Work Independent of the Time Module
  • Get the Current Temperature in Celsius

Was this helpful?

  1. How it works
  2. Modules

Climate Module

PreviousAmbience ModuleNextEvents Module

Last updated 1 year ago

Was this helpful?

Overview

The Climate Module manages the temperature, humidity, snow, and wetness of your ecosystem allowing you to propagate these values to other modules in your system.

Compatibility Information

βœ… Has equivalent COZY Biome Module

βœ… Requires the or to change the temperature and humidity over the year

βœ… Requires the , , or for snow and rain accumulation

Key Features

Global Controls

  • Control the temperature over the course of the year.

  • Control the humidity over the course of the year.

  • Control the temperature over the course of the day.

  • Control the humidity over the course of the day.

Local Controls

  • Control snow and wetness accumulation (requires the or the or the to appear visually).

  • Designate temperature and humidity filters to offset your climate.

  • Get the current temperature and humidity.

Usage Examples

Setup Climate to Work Independent of the Time Module

In the Selection Tab set your control method to native. You can now set the temperature and humidity directly within the module.

Get the Current Temperature in Celsius

COZY uses the Fahrenheit scale for backend calculations by default. This is due to the fact that the 0-100 degree scale for Fahrenheit works as a more useful percentage when creating weather based FX when compared with Celsius. This aside, if you want to localize your game to a region other than the US, you will likely want to convert the current temperature to Celsius when you are displaying it for in-game UI.

Here is a code example for how to do this:

// Convert current temperature
currentTemperatureCelcius = (CozyWeather.instance.climateModule.currentTemperature - 32) * 5/9;
Time Module
System Time Module
Material Module
MicroSplat Module
TVE Module
Material Module
MicroSplat Module
TVE Module
🌑️
Page cover image