Docs/Visual Scripting

COZY 4 Integration API

Visual Scripting

Browse the exact COZY 4 instructions, conditions, triggers, and properties available to Game Creator 2 visual scripting.

Visual Scripting

The entries below are copied from the package definitions. Use the child pages to browse them by type.

Instructions

Add Calendar Event (InstructionAddCozyCalendarEvent)

  • Title: Add Calendar Event
  • Description: Adds a Meridiem Event asset to the COZY calendar so it starts and ends at its scheduled times.
  • Category: COZY 4/Calendar/Add Calendar Event
  • Parameters:
  • Calendar Event - The Meridiem Event asset to add
  • Keywords: COZY, Meridiem, Event, Calendar, Schedule, Holiday, Static
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionAddCozyCalendarEvent.cs

Clear Forced Block Profile (InstructionClearCozyForcedBlockProfile)

  • Title: Clear Forced Block Profile
  • Description: Stops forcing a Blocks Profile and goes back to the Blocks Collection.
  • Category: COZY 4/Blocks/Clear Forced Block Profile
  • Parameters: None specified
  • Keywords: COZY, Blocks, Force, Clear, Reset, Test, Atmosphere
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Instructions/InstructionClearCozyForcedBlockProfile.cs

Force Block Profile (InstructionForceCozyBlockProfile)

  • Title: Force Block Profile
  • Description: Shows one Blocks Profile no matter the time of day, for example during a cutscene. Use Clear Forced Block Profile to go back to the Blocks Collection. Uses the Test Block setting on the Blocks module.
  • Category: COZY 4/Blocks/Force Block Profile
  • Parameters:
  • Profile - The Blocks Profile to show
  • Keywords: COZY, Blocks, Force, Override, Test, Atmosphere, Cutscene
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Instructions/InstructionForceCozyBlockProfile.cs

Play ReSound Track (InstructionPlayCozyReSoundTrack)

  • Title: Play ReSound Track
  • Description: Plays a ReSound track over the music COZY picks, for example for a boss fight or a cutscene. The normal soundtrack comes back when the track is stopped with Stop ReSound Track.
  • Category: COZY 4/ReSound/Play Track
  • Parameters:
  • Track - The ReSound Track to play
  • Id - A name for this request, used to stop it again. Playing again with the same Id replaces it
  • Priority - When several tracks are requested, the highest priority plays
  • Start Transition - How the track starts
  • End Transition - How the normal soundtrack comes back
  • Keywords: COZY, ReSound, Music, Soundtrack, Track, Override, Audio
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Instructions/InstructionPlayCozyReSoundTrack.cs

Queue Weather (InstructionQueueCozyWeather)

  • Title: Queue Weather
  • Description: Adds weather to the end of the COZY forecast.
  • Category: COZY 4/Weather/Queue Weather
  • Parameters:
  • Weather - The Weather Profile to add
  • Use Profile Duration - Let the Weather Profile decide how long it lasts
  • Duration - How long the queued weather lasts in in-game time
  • Keywords: COZY, Weather, Forecast, Queue
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionQueueCozyWeather.cs

Remove Calendar Event (InstructionRemoveCozyCalendarEvent)

  • Title: Remove Calendar Event
  • Description: Removes a Meridiem Event asset from the COZY calendar. A running event ends first.
  • Category: COZY 4/Calendar/Remove Calendar Event
  • Parameters:
  • Calendar Event - The Meridiem Event asset to remove
  • Keywords: COZY, Meridiem, Event, Calendar, Schedule, Holiday, Static
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionRemoveCozyCalendarEvent.cs

Set Ambience (InstructionSetCozyAmbience)

  • Title: Set Ambience
  • Description: Changes the current COZY ambience.
  • Category: COZY 4/Ambience/Set Ambience
  • Parameters:
  • Ambience - The Ambience Profile to use.
  • Transition - Blend from the current ambience to the new one.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyAmbience.cs

Set Ambience Profile Variable (InstructionSetCozyAmbienceProfileVariable)

  • Title: Set Ambience Profile Variable
  • Description: Stores a Ambience Profile in a Game Creator variable, or hands it to COZY.
  • Category: COZY 4/Ambience/Set Ambience Profile Variable
  • Parameters:
  • Set - Where to store the Ambience Profile
  • Ambience Profile - The Ambience Profile to store
  • Keywords: COZY, Ambience, Profile, Variable, Store
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyAmbienceProfileVariable.cs

Set Ambience Transition Time (InstructionSetCozyAmbienceTransitionTime)

  • Title: Set Ambience Transition Time
  • Description: Sets how long COZY takes to blend between ambience profiles.
  • Category: COZY 4/Ambience/Set Transition Time
  • Parameters:
  • Seconds - The blend time in seconds.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyAmbienceTransitionTime.cs

Set Atmosphere (InstructionSetCozyAtmosphere)

  • Title: Set Atmosphere
  • Description: Sets the COZY atmosphere profile for sky, fog, clouds, and lighting.
  • Category: COZY 4/Atmosphere/Set Atmosphere
  • Parameters:
  • Atmosphere - The Atmosphere Profile to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyAtmosphere.cs

Set Atmosphere Profile Variable (InstructionSetCozyAtmosphereProfileVariable)

  • Title: Set Atmosphere Profile Variable
  • Description: Stores a Atmosphere Profile in a Game Creator variable, or hands it to COZY.
  • Category: COZY 4/Atmosphere/Set Atmosphere Profile Variable
  • Parameters:
  • Set - Where to store the Atmosphere Profile
  • Atmosphere Profile - The Atmosphere Profile to store
  • Keywords: COZY, Atmosphere, Profile, Variable, Store
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyAtmosphereProfileVariable.cs

Set COZY Biome Weight (InstructionSetCozyBiomeWeight)

  • Title: Set COZY Biome Weight
  • Description: Sets how strongly a COZY biome affects the weather system.
  • Category: COZY 4/Biome/Set Weight
  • Parameters:
  • Biome - The GameObject with the COZY Biome component.
  • Weight - The target blend weight from 0 to 1.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyBiomeWeight.cs

Set Blocks Collection (InstructionSetCozyBlocksCollection)

  • Title: Set Blocks Collection
  • Description: Sets the Blocks Collection that picks the atmosphere overrides for each time of day.
  • Category: COZY 4/Blocks/Set Blocks Collection
  • Parameters:
  • Collection - The Blocks Collection to use
  • Keywords: COZY, Blocks, Collection, Atmosphere, Schedule, Profile
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Instructions/InstructionSetCozyBlocksCollection.cs

Set Climate Control (InstructionSetCozyClimateControl)

  • Title: Set Climate Control
  • Description: Chooses whether COZY climate follows its profile or manual values.
  • Category: COZY 4/Climate/Set Control
  • Parameters:
  • Control - The climate control mode to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyClimateControl.cs

Set Climate Profile (InstructionSetCozyClimateProfile)

  • Title: Set Climate Profile
  • Description: Sets the Climate Profile used by COZY.
  • Category: COZY 4/Climate/Set Climate Profile
  • Parameters:
  • Climate - The Climate Profile to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyClimateProfile.cs

Set Climate Profile Variable (InstructionSetCozyClimateProfileVariable)

  • Title: Set Climate Profile Variable
  • Description: Stores a Climate Profile in a Game Creator variable, or hands it to COZY.
  • Category: COZY 4/Climate/Set Climate Profile Variable
  • Parameters:
  • Set - Where to store the Climate Profile
  • Climate Profile - The Climate Profile to store
  • Keywords: COZY, Climate, Profile, Variable, Store
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyClimateProfileVariable.cs

Set COZY Climate Value (InstructionSetCozyClimateValue)

  • Title: Set COZY Climate Value
  • Description: Sets a COZY climate or ground cover value.
  • Category: COZY 4/Climate/Set Value
  • Parameters:
  • Value - The climate value to change.
  • Number - The new value. Temperature and pressure use the units selected in COZY Preferences. Climate values are recalculated from the Climate Profile unless Climate Control is set to Native.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyClimateValue.cs

Set COZY Date (InstructionSetCozyDate)

  • Title: Set COZY Date
  • Description: Sets the current COZY date. Days and months follow the calendar in COZY Preferences.
  • Category: COZY 4/Time/Set Date
  • Parameters:
  • Date - The new day, month and year
  • Keywords: COZY, Date, Calendar, Day, Month, Year
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyDate.cs

Set Eclipse Profile (InstructionSetCozyEclipseProfile)

  • Title: Set Eclipse Profile
  • Description: Sets the Eclipse Profile used by the COZY Eclipse module.
  • Category: COZY 4/Eclipse/Set Eclipse Profile
  • Parameters:
  • Profile - The Eclipse Profile to use
  • Keywords: COZY, Eclipse, Sun, Moon, Profile
  • Source: Cozy Weather 4 Integration/Integrations/Eclipse/Instructions/InstructionSetCozyEclipseProfile.cs

Set Eclipse Ratio (InstructionSetCozyEclipseRatio)

  • Title: Set Eclipse Ratio
  • Description: Smoothly changes how much of the sun is covered. Switches the Eclipse module to Manual style.
  • Category: COZY 4/Eclipse/Set Eclipse Ratio
  • Parameters:
  • Ratio - How much of the sun is covered, from 0 to 1
  • Duration - How many seconds the change takes
  • Easing - The change rate over the transition
  • Wait to Complete - Whether to wait until the change is finished
  • Keywords: COZY, Eclipse, Sun, Moon, Ratio, Tween
  • Source: Cozy Weather 4 Integration/Integrations/Eclipse/Instructions/InstructionSetCozyEclipseRatio.cs

Set Eclipse Style (InstructionSetCozyEclipseStyle)

  • Title: Set Eclipse Style
  • Description: Chooses whether COZY calculates the eclipse from the sun and moon positions (Automatic) or uses the ratio you set (Manual).
  • Category: COZY 4/Eclipse/Set Eclipse Style
  • Parameters:
  • Style - Automatic or Manual
  • Keywords: COZY, Eclipse, Sun, Moon, Automatic, Manual
  • Source: Cozy Weather 4 Integration/Integrations/Eclipse/Instructions/InstructionSetCozyEclipseStyle.cs

Set Forecast Profile (InstructionSetCozyForecastProfile)

  • Title: Set Forecast Profile
  • Description: Sets the Forecast Profile used to plan COZY weather.
  • Category: COZY 4/Weather/Set Forecast Profile
  • Parameters:
  • Forecast - The Forecast Profile to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyForecastProfile.cs

Set Forecast Profile Variable (InstructionSetCozyForecastProfileVariable)

  • Title: Set Forecast Profile Variable
  • Description: Stores a Forecast Profile in a Game Creator variable, or hands it to COZY.
  • Category: COZY 4/Weather/Set Forecast Profile Variable
  • Parameters:
  • Set - Where to store the Forecast Profile
  • Forecast Profile - The Forecast Profile to store
  • Keywords: COZY, Forecast, Profile, Variable, Store
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyForecastProfileVariable.cs

Set Horizon Profile (InstructionSetCozyHorizonProfile)

  • Title: Set Horizon Profile
  • Description: Sets the Horizon Profile used for the stylized background layers.
  • Category: COZY 4/Horizon/Set Horizon Profile
  • Parameters:
  • Profile - The Horizon Profile to use
  • Keywords: COZY, Horizon, Background, Skybox, Layers, Profile
  • Source: Cozy Weather 4 Integration/Integrations/Horizon/Instructions/InstructionSetCozyHorizonProfile.cs

Set ReSound Playing (InstructionSetCozyReSoundPlaying)

  • Title: Set ReSound Playing
  • Description: Turns the COZY ReSound soundtrack on or off.
  • Category: COZY 4/ReSound/Set Playing
  • Parameters:
  • Playing - Whether ReSound plays music
  • Keywords: COZY, ReSound, Music, Soundtrack, Mute, Play, Pause
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Instructions/InstructionSetCozyReSoundPlaying.cs

Set ReSound Volume (InstructionSetCozyReSoundVolume)

  • Title: Set ReSound Volume
  • Description: Smoothly changes the master volume of the COZY ReSound soundtrack.
  • Category: COZY 4/ReSound/Set Volume
  • Parameters:
  • Volume - The new volume, from 0 to 1
  • Duration - How many seconds the change takes
  • Easing - The change rate over the transition
  • Wait to Complete - Whether to wait until the change is finished
  • Keywords: COZY, ReSound, Music, Soundtrack, Volume, Fade, Audio
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Instructions/InstructionSetCozyReSoundVolume.cs

Set COZY Time (InstructionSetCozyTime)

  • Title: Set COZY Time
  • Description: Instantly sets the COZY time of day. The date does not change.
  • Category: COZY 4/Time/Set Time
  • Parameters:
  • Time - The new time of day, using a 24 hour clock
  • Keywords: COZY, Time, Clock, Hour, Minute
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyTime.cs

Set COZY Time Curve (InstructionSetCozyTimeCurve)

  • Title: Set COZY Time Curve
  • Description: Sets how the sun moves through the COZY sky.
  • Category: COZY 4/Time/Set Time Curve
  • Parameters:
  • Curve - The time curve style to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyTimeCurve.cs

Set Weather (InstructionSetCozyWeather)

  • Title: Set Weather
  • Description: Changes the current COZY weather.
  • Category: COZY 4/Weather/Set Weather
  • Parameters:
  • Weather - The Weather Profile to use.
  • Transition - Blend from the current weather to the new one.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyWeather.cs

Set Weather Change Mode (InstructionSetCozyWeatherChangeMode)

  • Title: Set Weather Change Mode
  • Description: Chooses when COZY should change weather.
  • Category: COZY 4/Weather/Set Change Mode
  • Parameters:
  • Mode - The weather change mode to use.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyWeatherChangeMode.cs

Set Weather Profile Variable (InstructionSetCozyWeatherProfileVariable)

  • Title: Set Weather Profile Variable
  • Description: Stores a Weather Profile in a Game Creator variable, or hands it to COZY.
  • Category: COZY 4/Weather/Set Weather Profile Variable
  • Parameters:
  • Set - Where to store the Weather Profile
  • Weather Profile - The Weather Profile to store
  • Keywords: COZY, Weather, Profile, Variable, Store
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyWeatherProfileVariable.cs

Set Weather Transition Time (InstructionSetCozyWeatherTransitionTime)

  • Title: Set Weather Transition Time
  • Description: Sets how long COZY takes to blend between weather profiles.
  • Category: COZY 4/Weather/Set Transition Time
  • Parameters:
  • Seconds - The blend time in seconds.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyWeatherTransitionTime.cs

Set COZY Wind Value (InstructionSetCozyWindValue)

  • Title: Set COZY Wind Value
  • Description: Sets a wind value in COZY.
  • Category: COZY 4/Wind/Set Value
  • Parameters:
  • Value - The wind value to change.
  • Number - The new value.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSetCozyWindValue.cs

Skip COZY Time (InstructionSkipCozyTime)

  • Title: Skip COZY Time
  • Description: Instantly moves COZY forward by an amount of in-game time. Weather and ambience timers and the calendar move along with the clock.
  • Category: COZY 4/Time/Skip Time
  • Parameters:
  • Duration - How much in-game time to skip
  • Keywords: COZY, Time, Skip, Sleep, Wait, Fast Forward
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionSkipCozyTime.cs

Stop ReSound Track (InstructionStopCozyReSoundTrack)

  • Title: Stop ReSound Track
  • Description: Stops a track started with Play ReSound Track so the normal COZY soundtrack comes back.
  • Category: COZY 4/ReSound/Stop Track
  • Parameters:
  • Stop All - Stop every track started with Play ReSound Track
  • Id - The name used when the track was played
  • Keywords: COZY, ReSound, Music, Soundtrack, Track, Override, Audio, Stop
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Instructions/InstructionStopCozyReSoundTrack.cs

Transition COZY Time (InstructionTransitionCozyTime)

  • Title: Transition COZY Time
  • Description: Smoothly moves COZY forward to a time of day. Time always moves forward, so a time earlier than the current one is reached on the next day. Weather and ambience timers and the calendar move along with the clock.
  • Category: COZY 4/Time/Transition Time
  • Parameters:
  • Time - The time of day to move forward to
  • Duration - How many real seconds the transition takes. Zero changes the time instantly
  • Easing - How the clock speeds up and slows down during the transition
  • Wait to Complete - Whether the next instruction waits until the transition is finished
  • Keywords: COZY, Time, Skip, Sleep, Night, Day, Tween, Fast Forward
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionTransitionCozyTime.cs

Wait For COZY Time (InstructionWaitForCozyTime)

  • Title: Wait For COZY Time
  • Description: Waits until an amount of in-game COZY time has passed. Skipped time counts too.
  • Category: COZY 4/Time/Wait For Time
  • Parameters:
  • Duration - How much in-game time to wait for
  • Keywords: COZY, Time, Wait, Delay, Hours, Minutes, Days
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionWaitForCozyTime.cs

Wait Until COZY Time (InstructionWaitUntilCozyTime)

  • Title: Wait Until COZY Time
  • Description: Waits until the COZY clock next reaches a time of day.
  • Category: COZY 4/Time/Wait Until Time
  • Parameters:
  • Time - The time of day to wait for
  • Keywords: COZY, Time, Wait, Until, Clock, Midnight, Morning
  • Source: Cozy Weather 4 Integration/Runtime/Instructions/InstructionWaitUntilCozyTime.cs

Conditions

Is COZY Ambience (ConditionCozyAmbience)

  • Title: Is COZY Ambience
  • Description: Checks whether an Ambience Profile is active now.
  • Category: COZY 4/Ambience/Is Ambience
  • Parameters:
  • Ambience - The Ambience Profile to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyAmbience.cs

Is COZY Atmosphere (ConditionCozyAtmosphere)

  • Title: Is COZY Atmosphere
  • Description: Checks whether an Atmosphere Profile is active now.
  • Category: COZY 4/Atmosphere/Is Atmosphere
  • Parameters:
  • Atmosphere - The Atmosphere Profile to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyAtmosphere.cs

Is In COZY Biome (ConditionCozyBiome)

  • Title: Is In COZY Biome
  • Description: Checks whether the COZY track point is blending into a biome.
  • Category: COZY 4/Biome/Is Inside
  • Parameters:
  • Biome - The GameObject with the COZY Biome component.
  • Minimum Weight - The smallest biome blend weight that counts as inside.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyBiome.cs

Is COZY Block Profile (ConditionCozyBlockProfile)

  • Title: Is COZY Block Profile
  • Description: Checks whether a Blocks Profile is the one being shown, either from the Blocks Collection or forced.
  • Category: COZY 4/Blocks/Is Block Profile
  • Parameters:
  • Profile - The Blocks Profile to check
  • Keywords: COZY, Blocks, Profile, Atmosphere, Time Of Day
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Conditions/ConditionCozyBlockProfile.cs

Is COZY Blocks Collection (ConditionCozyBlocksCollection)

  • Title: Is COZY Blocks Collection
  • Description: Checks whether a Blocks Collection is in use.
  • Category: COZY 4/Blocks/Is Blocks Collection
  • Parameters:
  • Collection - The Blocks Collection to check
  • Keywords: COZY, Blocks, Collection, Atmosphere, Schedule
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Conditions/ConditionCozyBlocksCollection.cs

Is COZY Calendar Event Running (ConditionCozyCalendarEvent)

  • Title: Is COZY Calendar Event Running
  • Description: Checks whether a COZY Meridiem Event (a calendar event asset) is happening right now.
  • Category: COZY 4/Calendar/Is Calendar Event Running
  • Parameters:
  • Calendar Event - The Meridiem Event asset to check
  • Keywords: COZY, Meridiem, Event, Calendar, Schedule, Holiday, Static, Running
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyCalendarEvent.cs

Is COZY Climate Profile (ConditionCozyClimateProfile)

  • Title: Is COZY Climate Profile
  • Description: Checks whether a Climate Profile is active now.
  • Category: COZY 4/Climate/Is Climate Profile
  • Parameters:
  • Climate - The Climate Profile to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyClimateProfile.cs

Is COZY Forecast Profile (ConditionCozyForecastProfile)

  • Title: Is COZY Forecast Profile
  • Description: Checks whether a Forecast Profile is active now.
  • Category: COZY 4/Weather/Is Forecast Profile
  • Parameters:
  • Forecast - The Forecast Profile to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyForecastProfile.cs

Is COZY Horizon Profile (ConditionCozyHorizonProfile)

  • Title: Is COZY Horizon Profile
  • Description: Checks whether a Horizon Profile is in use.
  • Category: COZY 4/Horizon/Is Horizon Profile
  • Parameters:
  • Profile - The Horizon Profile to check
  • Keywords: COZY, Horizon, Background, Profile
  • Source: Cozy Weather 4 Integration/Integrations/Horizon/Conditions/ConditionCozyHorizonProfile.cs

Is ReSound Track Playing (ConditionCozyReSoundTrack)

  • Title: Is ReSound Track Playing
  • Description: Checks whether a ReSound track is the one playing right now, including tracks started with Play ReSound Track.
  • Category: COZY 4/ReSound/Is Track Playing
  • Parameters:
  • Track - The ReSound Track to check
  • Keywords: COZY, ReSound, Music, Soundtrack, Track, Playing
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Conditions/ConditionCozyReSoundTrack.cs

Compare COZY Temperature (ConditionCozyTemperature)

  • Title: Compare COZY Temperature
  • Description: Checks the current COZY temperature in a chosen unit.
  • Category: COZY 4/Climate/Compare Temperature
  • Parameters:
  • Comparison - How to compare the temperature.
  • Temperature - The temperature to compare with.
  • Unit - The unit used for the temperature value.
  • Whole Degree - Treat the chosen value as a whole-degree range.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyTemperature.cs

Is COZY Time Between (ConditionCozyTimeBetween)

  • Title: Is COZY Time Between
  • Description: Checks whether the COZY clock is between two times of day. Ranges that pass midnight, such as 22:00 to 06:00, are supported.
  • Category: COZY 4/Time/Is Time Between
  • Parameters:
  • From - The start of the range, included
  • To - The end of the range, excluded
  • Keywords: COZY, Time, Clock, Between, Range, Night, Day, Open, Hours
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyTimeBetween.cs

Is COZY Time Block (ConditionCozyTimeBlock)

  • Title: Is COZY Time Block
  • Description: Checks whether COZY is in a named part of the day.
  • Category: COZY 4/Time/Is Time Block
  • Parameters:
  • Block - The part of the day to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyTimeBlock.cs

Compare COZY Value (ConditionCozyValue)

  • Title: Compare COZY Value
  • Description: Compares a climate, ground cover, or wind value from COZY.
  • Category: COZY 4/Climate/Compare Value
  • Parameters:
  • Source - The type of value to compare.
  • Value - The selected COZY value.
  • Comparison - How to compare the values.
  • Compare To - The number to compare with.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyValue.cs

Is COZY Weather (ConditionCozyWeather)

  • Title: Is COZY Weather
  • Description: Checks whether a Weather Profile is active now.
  • Category: COZY 4/Weather/Is Weather
  • Parameters:
  • Weather - The Weather Profile to check.
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Conditions/ConditionCozyWeather.cs

Triggers

On COZY Ambience (EventOnCozyAmbience)

  • Title: On COZY Ambience
  • Description: Triggers when COZY changes to a new ambience, either any ambience or one chosen Ambience Profile.
  • Category: COZY 4/Ambience/On Ambience
  • Parameters:
  • Ambience - Trigger on any ambience change, or only when a specific Ambience Profile starts
  • Keywords: COZY, Ambience, Change
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyAmbience.cs

On COZY Atmosphere (EventOnCozyAtmosphere)

  • Title: On COZY Atmosphere
  • Description: Triggers when COZY switches to a new AtmosphereProfile, either any profile or one chosen profile.
  • Category: COZY 4/Atmosphere/On Atmosphere
  • Parameters:
  • Atmosphere - Trigger on any atmosphere change, or only when a specific AtmosphereProfile is used
  • Keywords: COZY, Atmosphere, Profile, Change
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyAtmosphere.cs

On Enter COZY Biome (EventOnCozyBiomeEnter)

  • Title: On Enter COZY Biome
  • Description: Triggers when the COZY track point starts blending into a biome.
  • Category: COZY 4/Biome/On Enter
  • Parameters:
  • Biome - The GameObject with the COZY Biome component
  • Keywords: COZY, Biome, Region, Zone, Enter
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyBiomeEnter.cs

On Exit COZY Biome (EventOnCozyBiomeExit)

  • Title: On Exit COZY Biome
  • Description: Triggers when the COZY track point stops blending into a biome.
  • Category: COZY 4/Biome/On Exit
  • Parameters:
  • Biome - The GameObject with the COZY Biome component
  • Keywords: COZY, Biome, Region, Zone, Exit
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyBiomeExit.cs

On COZY Block Profile (EventOnCozyBlockProfile)

  • Title: On COZY Block Profile
  • Description: Triggers when the Blocks Profile being shown changes, either any profile or one chosen profile.
  • Category: COZY 4/Blocks/On Block Profile
  • Parameters:
  • Profile - Trigger for any new Blocks Profile, or only when a specific one starts
  • Keywords: COZY, Blocks, Profile, Atmosphere, Time Of Day, Change
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Events/EventOnCozyBlockProfile.cs

On COZY Calendar Event (EventOnCozyCalendarEvent)

  • Title: On COZY Calendar Event
  • Description: Triggers when a COZY Meridiem Event (a calendar event asset) starts or ends. The event is added to the COZY calendar automatically if it is not there yet.
  • Category: COZY 4/Calendar/On Calendar Event
  • Parameters:
  • Calendar Event - The Meridiem Event asset to watch
  • When - Trigger when the event starts or when it ends
  • Keywords: COZY, Meridiem, Event, Calendar, Schedule, Holiday, Static, Start, End
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyCalendarEvent.cs

On COZY Climate Profile (EventOnCozyClimateProfile)

  • Title: On COZY Climate Profile
  • Description: Triggers when COZY switches to a new ClimateProfile, either any profile or one chosen profile.
  • Category: COZY 4/Climate/On Climate Profile
  • Parameters:
  • Climate - Trigger on any climate change, or only when a specific ClimateProfile is used
  • Keywords: COZY, Climate, Profile, Change
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyClimateProfile.cs

On COZY Clock (EventOnCozyClock)

  • Title: On COZY Clock
  • Description: Triggers every time the chosen COZY clock unit changes, for example on every new hour.
  • Category: COZY 4/Time/On Clock
  • Parameters:
  • Unit - The COZY clock unit to watch
  • Keywords: COZY, Time, Clock, Minute, Hour, Day, Year, Tick
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyClock.cs

On COZY Date and Time (EventOnCozyDateAndTime)

  • Title: On COZY Date and Time
  • Description: Triggers when COZY reaches a time of day on a chosen date.
  • Category: COZY 4/Time/On Date and Time
  • Parameters:
  • Date - The day, month and year to watch
  • Check Year - Only trigger in the chosen year. When off, triggers on this date every year
  • Time - The time of day to watch, using a 24 hour clock
  • Keywords: COZY, Date, Calendar, Time, Day, Month, Year, Birthday, Holiday
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyDateAndTime.cs

On COZY Forecast Profile (EventOnCozyForecastProfile)

  • Title: On COZY Forecast Profile
  • Description: Triggers when COZY switches to a new ForecastProfile, either any profile or one chosen profile.
  • Category: COZY 4/Weather/On Forecast Profile
  • Parameters:
  • Forecast - Trigger on any forecast change, or only when a specific ForecastProfile is used
  • Keywords: COZY, Forecast, Profile, Change
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyForecastProfile.cs

On ReSound Track (EventOnCozyReSoundTrack)

  • Title: On ReSound Track
  • Description: Triggers when ReSound starts a new track, either any track or one chosen track.
  • Category: COZY 4/ReSound/On Track
  • Parameters:
  • Track - Trigger for any new track, or only when a specific ReSound Track starts
  • Keywords: COZY, ReSound, Music, Soundtrack, Track, Change
  • Source: Cozy Weather 4 Integration/Integrations/ReSound/Events/EventOnCozyReSoundTrack.cs

On COZY Season (EventOnCozySeason)

  • Title: On COZY Season
  • Description: Triggers when COZY changes season, either into any season or one chosen season.
  • Category: COZY 4/Climate/On Season
  • Parameters:
  • Season - Trigger on any season change, or only when a specific season starts
  • Keywords: COZY, Season, Spring, Summer, Fall, Autumn, Winter
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozySeason.cs

On COZY Temperature (EventOnCozyTemperature)

  • Title: On COZY Temperature
  • Description: Triggers when the COZY temperature rises above or falls below a chosen value.
  • Category: COZY 4/Climate/On Temperature
  • Parameters:
  • Direction - Trigger when the temperature rises above the value, falls below it, or crosses it either way
  • Temperature - The temperature to watch
  • Unit - The unit used for the temperature value
  • Keywords: COZY, Temperature, Hot, Cold, Freeze, Heat, Climate
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyTemperature.cs

On COZY Time (EventOnCozyTime)

  • Title: On COZY Time
  • Description: Triggers when the COZY clock reaches a time of day. Also triggers when the time is skipped or transitioned past it, but not when the clock is set backwards.
  • Category: COZY 4/Time/On Time
  • Parameters:
  • Time - The time of day to watch, using a 24 hour clock
  • Keywords: COZY, Time, Clock, Hour, Minute, Schedule
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyTime.cs

On COZY Time Block (EventOnCozyTimeBlock)

  • Title: On COZY Time Block
  • Description: Triggers when COZY moves into a new part of the day, such as dawn, day or night.
  • Category: COZY 4/Time/On Time Block
  • Parameters:
  • Time Block - Trigger for any part of the day, or only when a specific one starts
  • Keywords: COZY, Time, Dawn, Morning, Day, Afternoon, Evening, Twilight, Night, Sunrise, Sunset
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyTimeBlock.cs

On COZY Time Changed (EventOnCozyTimeChanged)

  • Title: On COZY Time Changed
  • Description: Triggers whenever the COZY clock shows a new minute, hour or day. Unlike the interval event this also triggers when the time is set, skipped, moved backwards or loaded from a save game, which makes it ideal for keeping clocks and calendars in the UI up to date.
  • Category: COZY 4/Time/On Time Changed
  • Parameters:
  • Unit - Trigger when the minute, the hour or the day shown changes
  • Trigger On Start - Also trigger once when the event starts listening
  • Keywords: COZY, Time, Clock, Changed, UI, Display, Update
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyTimeChanged.cs

On COZY Time Interval (EventOnCozyTimeInterval)

  • Title: On COZY Time Interval
  • Description: Triggers every time a chosen amount of in-game COZY time has passed. Skipped time counts too.
  • Category: COZY 4/Time/On Time Interval
  • Parameters:
  • Interval - How much in-game time passes between triggers
  • Trigger On Start - Also trigger once when the event starts listening
  • Keywords: COZY, Time, Interval, Every, Repeat, Tick
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyTimeInterval.cs

On COZY Weather (EventOnCozyWeather)

  • Title: On COZY Weather
  • Description: Triggers when COZY changes to a new weather, either any weather or one chosen Weather Profile.
  • Category: COZY 4/Weather/On Weather
  • Parameters:
  • Weather - Trigger on any weather change, or only when a specific Weather Profile starts
  • Keywords: COZY, Weather, Rain, Snow, Storm, Change
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyWeather.cs

On COZY Weather Event FX (EventOnCozyWeatherEventFX)

  • Title: On COZY Weather Event FX
  • Description: Triggers when a COZY Event FX starts or ends. Event FX are added to Weather Profiles to run custom logic while that weather plays.
  • Category: COZY 4/Weather/On Weather Event FX
  • Parameters:
  • Event FX - The Event FX asset to watch
  • When - Trigger when the effect starts or when it ends
  • Keywords: COZY, Weather, Event, FX, Effect, Start, End
  • Source: Cozy Weather 4 Integration/Runtime/Events/EventOnCozyWeatherEventFX.cs

Properties

Get properties

Ambience Profile (GetAmbienceProfileAsset)
  • Title: Ambience Profile
  • Description: A Ambience Profile asset.
  • Category: Ambience Profile
  • Type: Ambience Profile
  • Parameters:
  • Profile - The Ambience Profile asset
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileAsset.cs
Current Ambience Profile (GetAmbienceProfileCurrent)
  • Title: Current Ambience Profile
  • Description: The Ambience Profile COZY is using right now.
  • Category: Current Ambience Profile
  • Type: Ambience Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileCurrent.cs
Global List Variable (GetAmbienceProfileGlobalList)
  • Title: Global List Variable
  • Description: A Ambience Profile stored in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to read the Ambience Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileGlobalList.cs
Global Name Variable (GetAmbienceProfileGlobalName)
  • Title: Global Name Variable
  • Description: A Ambience Profile stored in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to read the Ambience Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileGlobalName.cs
Local List Variable (GetAmbienceProfileLocalList)
  • Title: Local List Variable
  • Description: A Ambience Profile stored in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to read the Ambience Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileLocalList.cs
Local Name Variable (GetAmbienceProfileLocalName)
  • Title: Local Name Variable
  • Description: A Ambience Profile stored in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to read the Ambience Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileLocalName.cs
None (GetAmbienceProfileNone)
  • Title: None
  • Description: No Ambience Profile.
  • Category: None
  • Type: Ambience Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAmbienceProfileNone.cs
Atmosphere Profile (GetAtmosphereProfileAsset)
  • Title: Atmosphere Profile
  • Description: A Atmosphere Profile asset.
  • Category: Atmosphere Profile
  • Type: Atmosphere Profile
  • Parameters:
  • Profile - The Atmosphere Profile asset
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileAsset.cs
Current Atmosphere Profile (GetAtmosphereProfileCurrent)
  • Title: Current Atmosphere Profile
  • Description: The Atmosphere Profile COZY is using right now.
  • Category: Current Atmosphere Profile
  • Type: Atmosphere Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileCurrent.cs
Global List Variable (GetAtmosphereProfileGlobalList)
  • Title: Global List Variable
  • Description: A Atmosphere Profile stored in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to read the Atmosphere Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileGlobalList.cs
Global Name Variable (GetAtmosphereProfileGlobalName)
  • Title: Global Name Variable
  • Description: A Atmosphere Profile stored in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to read the Atmosphere Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileGlobalName.cs
Local List Variable (GetAtmosphereProfileLocalList)
  • Title: Local List Variable
  • Description: A Atmosphere Profile stored in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to read the Atmosphere Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileLocalList.cs
Local Name Variable (GetAtmosphereProfileLocalName)
  • Title: Local Name Variable
  • Description: A Atmosphere Profile stored in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to read the Atmosphere Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileLocalName.cs
None (GetAtmosphereProfileNone)
  • Title: None
  • Description: No Atmosphere Profile.
  • Category: None
  • Type: Atmosphere Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetAtmosphereProfileNone.cs
COZY Time Paused (GetBoolCozyTimePaused)
  • Title: COZY Time Paused
  • Description: Whether COZY time is paused.
  • Category: COZY 4/Time
  • Type: Bool
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetBoolCozyTimePaused.cs
Climate Profile (GetClimateProfileAsset)
  • Title: Climate Profile
  • Description: A Climate Profile asset.
  • Category: Climate Profile
  • Type: Climate Profile
  • Parameters:
  • Profile - The Climate Profile asset
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileAsset.cs
Current Climate Profile (GetClimateProfileCurrent)
  • Title: Current Climate Profile
  • Description: The Climate Profile COZY is using right now.
  • Category: Current Climate Profile
  • Type: Climate Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileCurrent.cs
Global List Variable (GetClimateProfileGlobalList)
  • Title: Global List Variable
  • Description: A Climate Profile stored in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to read the Climate Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileGlobalList.cs
Global Name Variable (GetClimateProfileGlobalName)
  • Title: Global Name Variable
  • Description: A Climate Profile stored in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to read the Climate Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileGlobalName.cs
Local List Variable (GetClimateProfileLocalList)
  • Title: Local List Variable
  • Description: A Climate Profile stored in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to read the Climate Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileLocalList.cs
Local Name Variable (GetClimateProfileLocalName)
  • Title: Local Name Variable
  • Description: A Climate Profile stored in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to read the Climate Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileLocalName.cs
None (GetClimateProfileNone)
  • Title: None
  • Description: No Climate Profile.
  • Category: None
  • Type: Climate Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetClimateProfileNone.cs
COZY Biome Weight (GetDecimalCozyBiomeWeight)
  • Title: COZY Biome Weight
  • Description: The current blend weight of a COZY biome.
  • Category: COZY 4/Biome
  • Type: Decimal
  • Parameters:
  • Biome - The GameObject with the COZY Biome component
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetDecimalCozyBiomeWeight.cs
COZY Climate Value (GetDecimalCozyClimate)
  • Title: COZY Climate Value
  • Description: A climate or ground cover value from COZY.
  • Category: COZY 4/Climate
  • Type: Decimal
  • Parameters:
  • Value - The climate value to read: Temperature, Humidity, Pressure, UV Index, Air Quality, Snow On Ground, Rain On Ground, Snow Accumulation Speed, Rain Accumulation Speed, Convective Rain Chance or Stratiform Rain Chance
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetDecimalCozyClimate.cs
COZY Eclipse Ratio (GetDecimalCozyEclipseRatio)
  • Title: COZY Eclipse Ratio
  • Description: How much of the sun is currently covered, from 0 to 1.
  • Category: COZY 4/Eclipse/Eclipse Ratio
  • Type: Decimal
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Integrations/Eclipse/Properties/Get/GetDecimalCozyEclipseRatio.cs
COZY Time Value (GetDecimalCozyTime)
  • Title: COZY Time Value
  • Description: A time or calendar value from COZY.
  • Category: COZY 4/Time
  • Type: Decimal
  • Parameters:
  • Value - The value to read: Hour, Minute, Day, Month, Year, Day Of Year, Time Speed, Weather Time Remaining Hours or Ambience Time Remaining Hours
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetDecimalCozyTime.cs
COZY Wind Value (GetDecimalCozyWind)
  • Title: COZY Wind Value
  • Description: A wind value from COZY.
  • Category: COZY 4/Wind
  • Type: Decimal
  • Parameters:
  • Value - The wind value to read: Heading, Heading Variance, Strength, Speed, Speed Variance, Speed Change Rate, Heading Change Rate, Gusting Power or Gusting Frequency
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetDecimalCozyWind.cs
Forecast Profile (GetForecastProfileAsset)
  • Title: Forecast Profile
  • Description: A Forecast Profile asset.
  • Category: Forecast Profile
  • Type: Forecast Profile
  • Parameters:
  • Profile - The Forecast Profile asset
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileAsset.cs
Current Forecast Profile (GetForecastProfileCurrent)
  • Title: Current Forecast Profile
  • Description: The Forecast Profile COZY is using right now.
  • Category: Current Forecast Profile
  • Type: Forecast Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileCurrent.cs
Global List Variable (GetForecastProfileGlobalList)
  • Title: Global List Variable
  • Description: A Forecast Profile stored in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to read the Forecast Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileGlobalList.cs
Global Name Variable (GetForecastProfileGlobalName)
  • Title: Global Name Variable
  • Description: A Forecast Profile stored in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to read the Forecast Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileGlobalName.cs
Local List Variable (GetForecastProfileLocalList)
  • Title: Local List Variable
  • Description: A Forecast Profile stored in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to read the Forecast Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileLocalList.cs
Local Name Variable (GetForecastProfileLocalName)
  • Title: Local Name Variable
  • Description: A Forecast Profile stored in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to read the Forecast Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileLocalName.cs
None (GetForecastProfileNone)
  • Title: None
  • Description: No Forecast Profile.
  • Category: None
  • Type: Forecast Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetForecastProfileNone.cs
COZY Weather (GetGameObjectCozyWeather)
  • Title: COZY Weather
  • Description: The active COZY Weather GameObject.
  • Category: COZY 4/System
  • Type: Game Object
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetGameObjectCozyWeather.cs
COZY Blocks Name (GetStringCozyBlocks)
  • Title: COZY Blocks Name
  • Description: The name of the Blocks Profile being shown, or of the Blocks Collection in use.
  • Category: COZY 4/Blocks/Blocks Name
  • Type: String
  • Parameters:
  • Value - Read the Current Block Profile or the Blocks Collection
  • Keywords: COZY, Blocks, Profile, Collection, Name, Text
  • Source: Cozy Weather 4 Integration/Integrations/Blocks/Properties/Get/GetStringCozyBlocks.cs
COZY Profile Name (GetStringCozyProfile)
  • Title: COZY Profile Name
  • Description: The name of the current weather, ambience, season, or month.
  • Category: COZY 4/System
  • Type: String
  • Parameters:
  • Value - The name to read: Weather, Ambience, Atmosphere, Season or Month
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetStringCozyProfile.cs
COZY Time Text (GetStringCozyTime)
  • Title: COZY Time Text
  • Description: The current COZY time or date as text, for example 19:30, 7:30 PM or Saturday 7 November, Year 2026.
  • Category: COZY 4/Time Text
  • Type: String
  • Parameters:
  • Format - How the text is written: 24 hour clock, 12 hour clock, AM or PM, Date, Date and Time, Weekday, Day of Month, Month Name, Year or Long Date
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetStringCozyTime.cs
Weather Profile (GetWeatherProfileAsset)
  • Title: Weather Profile
  • Description: A Weather Profile asset.
  • Category: Weather Profile
  • Type: Weather Profile
  • Parameters:
  • Profile - The Weather Profile asset
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileAsset.cs
Current Weather Profile (GetWeatherProfileCurrent)
  • Title: Current Weather Profile
  • Description: The Weather Profile COZY is using right now.
  • Category: Current Weather Profile
  • Type: Weather Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileCurrent.cs
Global List Variable (GetWeatherProfileGlobalList)
  • Title: Global List Variable
  • Description: A Weather Profile stored in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to read the Weather Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileGlobalList.cs
Global Name Variable (GetWeatherProfileGlobalName)
  • Title: Global Name Variable
  • Description: A Weather Profile stored in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to read the Weather Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileGlobalName.cs
Local List Variable (GetWeatherProfileLocalList)
  • Title: Local List Variable
  • Description: A Weather Profile stored in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to read the Weather Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileLocalList.cs
Local Name Variable (GetWeatherProfileLocalName)
  • Title: Local Name Variable
  • Description: A Weather Profile stored in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to read the Weather Profile from
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileLocalName.cs
None (GetWeatherProfileNone)
  • Title: None
  • Description: No Weather Profile.
  • Category: None
  • Type: Weather Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Get/GetWeatherProfileNone.cs

Set properties

Current Ambience Profile (SetAmbienceProfileCurrent)
  • Title: Current Ambience Profile
  • Description: Makes COZY use this Ambience Profile right now.
  • Category: Current Ambience Profile
  • Type: Ambience Profile
  • Parameters:
  • Transition - Blend from the current ambience to the new one
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileCurrent.cs
Global List Variable (SetAmbienceProfileGlobalList)
  • Title: Global List Variable
  • Description: Stores a Ambience Profile in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to store the Ambience Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileGlobalList.cs
Global Name Variable (SetAmbienceProfileGlobalName)
  • Title: Global Name Variable
  • Description: Stores a Ambience Profile in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to store the Ambience Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileGlobalName.cs
Local List Variable (SetAmbienceProfileLocalList)
  • Title: Local List Variable
  • Description: Stores a Ambience Profile in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to store the Ambience Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileLocalList.cs
Local Name Variable (SetAmbienceProfileLocalName)
  • Title: Local Name Variable
  • Description: Stores a Ambience Profile in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Ambience Profile
  • Parameters:
  • Variable - The variable to store the Ambience Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileLocalName.cs
None (SetAmbienceProfileNone)
  • Title: None
  • Description: Does not store the Ambience Profile anywhere.
  • Category: None
  • Type: Ambience Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAmbienceProfileNone.cs
Current Atmosphere Profile (SetAtmosphereProfileCurrent)
  • Title: Current Atmosphere Profile
  • Description: Makes COZY use this Atmosphere Profile right now.
  • Category: Current Atmosphere Profile
  • Type: Atmosphere Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileCurrent.cs
Global List Variable (SetAtmosphereProfileGlobalList)
  • Title: Global List Variable
  • Description: Stores a Atmosphere Profile in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to store the Atmosphere Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileGlobalList.cs
Global Name Variable (SetAtmosphereProfileGlobalName)
  • Title: Global Name Variable
  • Description: Stores a Atmosphere Profile in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to store the Atmosphere Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileGlobalName.cs
Local List Variable (SetAtmosphereProfileLocalList)
  • Title: Local List Variable
  • Description: Stores a Atmosphere Profile in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to store the Atmosphere Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileLocalList.cs
Local Name Variable (SetAtmosphereProfileLocalName)
  • Title: Local Name Variable
  • Description: Stores a Atmosphere Profile in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Atmosphere Profile
  • Parameters:
  • Variable - The variable to store the Atmosphere Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileLocalName.cs
None (SetAtmosphereProfileNone)
  • Title: None
  • Description: Does not store the Atmosphere Profile anywhere.
  • Category: None
  • Type: Atmosphere Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetAtmosphereProfileNone.cs
Set COZY Time Paused (SetBoolCozyTimePaused)
  • Title: Set COZY Time Paused
  • Description: Pauses or resumes COZY time.
  • Category: COZY 4/Time
  • Type: Bool
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetBoolCozyTimePaused.cs
Current Climate Profile (SetClimateProfileCurrent)
  • Title: Current Climate Profile
  • Description: Makes COZY use this Climate Profile right now.
  • Category: Current Climate Profile
  • Type: Climate Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileCurrent.cs
Global List Variable (SetClimateProfileGlobalList)
  • Title: Global List Variable
  • Description: Stores a Climate Profile in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to store the Climate Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileGlobalList.cs
Global Name Variable (SetClimateProfileGlobalName)
  • Title: Global Name Variable
  • Description: Stores a Climate Profile in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to store the Climate Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileGlobalName.cs
Local List Variable (SetClimateProfileLocalList)
  • Title: Local List Variable
  • Description: Stores a Climate Profile in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to store the Climate Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileLocalList.cs
Local Name Variable (SetClimateProfileLocalName)
  • Title: Local Name Variable
  • Description: Stores a Climate Profile in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Climate Profile
  • Parameters:
  • Variable - The variable to store the Climate Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileLocalName.cs
None (SetClimateProfileNone)
  • Title: None
  • Description: Does not store the Climate Profile anywhere.
  • Category: None
  • Type: Climate Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetClimateProfileNone.cs
Current Forecast Profile (SetForecastProfileCurrent)
  • Title: Current Forecast Profile
  • Description: Makes COZY use this Forecast Profile right now.
  • Category: Current Forecast Profile
  • Type: Forecast Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileCurrent.cs
Global List Variable (SetForecastProfileGlobalList)
  • Title: Global List Variable
  • Description: Stores a Forecast Profile in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to store the Forecast Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileGlobalList.cs
Global Name Variable (SetForecastProfileGlobalName)
  • Title: Global Name Variable
  • Description: Stores a Forecast Profile in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to store the Forecast Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileGlobalName.cs
Local List Variable (SetForecastProfileLocalList)
  • Title: Local List Variable
  • Description: Stores a Forecast Profile in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to store the Forecast Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileLocalList.cs
Local Name Variable (SetForecastProfileLocalName)
  • Title: Local Name Variable
  • Description: Stores a Forecast Profile in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Forecast Profile
  • Parameters:
  • Variable - The variable to store the Forecast Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileLocalName.cs
None (SetForecastProfileNone)
  • Title: None
  • Description: Does not store the Forecast Profile anywhere.
  • Category: None
  • Type: Forecast Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetForecastProfileNone.cs
Set COZY Climate Value (SetNumberCozyClimate)
  • Title: Set COZY Climate Value
  • Description: Sets a COZY climate or ground cover value.
  • Category: COZY 4/Climate
  • Type: Number
  • Parameters:
  • Value - The climate value to change: Temperature, Humidity, Pressure, UV Index, Air Quality, Snow On Ground, Rain On Ground, Snow Accumulation Speed or Rain Accumulation Speed
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetNumberCozyClimate.cs
Set COZY Time Value (SetNumberCozyTime)
  • Title: Set COZY Time Value
  • Description: Sets the COZY hour, minute, or time speed.
  • Category: COZY 4/Time
  • Type: Number
  • Parameters:
  • Value - The value to change: Hour, Minute or Time Speed
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetNumberCozyTime.cs
Set COZY Wind Value (SetNumberCozyWind)
  • Title: Set COZY Wind Value
  • Description: Sets a wind value in COZY.
  • Category: COZY 4/Wind
  • Type: Number
  • Parameters:
  • Value - The wind value to change: Heading, Heading Variance, Strength, Speed, Speed Variance, Speed Change Rate, Heading Change Rate, Gusting Power or Gusting Frequency
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetNumberCozyWind.cs
Current Weather Profile (SetWeatherProfileCurrent)
  • Title: Current Weather Profile
  • Description: Makes COZY use this Weather Profile right now.
  • Category: Current Weather Profile
  • Type: Weather Profile
  • Parameters:
  • Transition - Blend from the current weather to the new one
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileCurrent.cs
Global List Variable (SetWeatherProfileGlobalList)
  • Title: Global List Variable
  • Description: Stores a Weather Profile in a global list variable.
  • Category: Variables/Global List Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to store the Weather Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileGlobalList.cs
Global Name Variable (SetWeatherProfileGlobalName)
  • Title: Global Name Variable
  • Description: Stores a Weather Profile in a global name variable.
  • Category: Variables/Global Name Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to store the Weather Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileGlobalName.cs
Local List Variable (SetWeatherProfileLocalList)
  • Title: Local List Variable
  • Description: Stores a Weather Profile in a local list variable.
  • Category: Variables/Local List Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to store the Weather Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileLocalList.cs
Local Name Variable (SetWeatherProfileLocalName)
  • Title: Local Name Variable
  • Description: Stores a Weather Profile in a local name variable.
  • Category: Variables/Local Name Variable
  • Type: Weather Profile
  • Parameters:
  • Variable - The variable to store the Weather Profile in
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileLocalName.cs
None (SetWeatherProfileNone)
  • Title: None
  • Description: Does not store the Weather Profile anywhere.
  • Category: None
  • Type: Weather Profile
  • Parameters: None specified
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileNone.cs
Queue Weather (SetWeatherProfileQueue)
  • Title: Queue Weather
  • Description: Adds a Weather Profile to the end of the forecast.
  • Category: Queue Weather
  • Type: Weather Profile
  • Parameters:
  • Hours - How many hours the queued weather lasts. Leave hours and minutes at zero to use the profile duration
  • Minutes - Extra minutes for the queued weather
  • Keywords: None specified
  • Source: Cozy Weather 4 Integration/Runtime/Properties/Set/SetWeatherProfileQueue.cs