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
  • Profiles
  • ReSound DJ
  • ReSound Setlist
  • ReSound Track
  • API Reference
  • Play Track
  • Stop Track
  • Skip
  • Pause
  • Play
  • Shuffle
  • Play From Beginning
  • Freeze for Time
  • Fade to Volume
  • Fade Out & Fade In

Was this helpful?

  1. How it works
  2. Modules

ReSound Module

Overview

The ReSound Module provides a clean and intuitive interface for music that interacts with the COZY ecosystem. Let your creativity flow with cleverly designed features. Easily tailor your soundtrack to your player's experience.

  • Play somber music during a midday rain shower

  • Switch to desert music when entering your desert biome

  • Play songs with soaring strings as your players look up to see a meteor shower overhead

  • Transition to tranquil music as the sun sets

  • Wake your players with happy music as the sun rises in the morning

Key Features

  • Extensive API functions for playhead management.

  • Play localized music based on biome, weather, temperature, time, and more.

  • Swap out setlists for a "streamer mode" that is DMCA proof

Profiles

ReSound DJ

Holds the global settings for ReSound. Place all of the available tracks here along with the settings that you want to use for transitions.

ReSound Setlist

References a local set of songs to be played by a ReSound instance (weather sphere or biome)

ReSound Track

API Reference

In order to use the ReSound Module in your C# scripts, first setup a module reference using this snippet:

ReSoundModule reSoundModule = CozyWeather.instance.GetModule<ReSoundModule>()

Play Track

Plays a specific ReSound track.

reSoundModule.PlayTrack(yourTrack);

Stop Track

Stops a specific ReSound track.

reSoundModule.StopTrack(yourTrack);

Skip

Skips to the next track.

reSoundModule.Skip();

Pause

Pauses the current simulation.

reSoundModule.Pause();

Play

Unpauses your ReSound module

reSoundModule.Play();

Shuffle

Plays and selects a random track

reSoundModule.Shuffle();

Play From Beginning

Plays the initial track. Good for restarting a zone's music after a cutscene.

reSoundModule.PlayFromBeginning();

Freeze for Time

Pauses and then plays after a determined amount of time.

StartCoroutine(reSoundModule.FreezeForTime(freezeTime));

Fade to Volume

Fades the master volume to a target over time.

StartCoroutine(reSoundModule.FadeToVolume(fadeTime, targetVolume));

Fade Out & Fade In

Fades the master volume to 0, waits for a determined amount of time, and then fades the volume back. Useful for jingles, and gameplay noises.

StartCoroutine(reSoundModule.FadeOutFadeIn(fadeTime, waitTime));
PreviousHabits ModuleNextLink Module

Last updated 1 year ago

Was this helpful?

Define an actual track to be played by ReSound. Can be linked with a single audio clip or a playlist of audio clips. Uses and likelihood to determine how often and when tracks can be played.

Chance Effectors
🎼
Page cover image