# Weather Switcher
{% hint style="success" %}
**COPY/PASTE PARAMETERS**
New in GM 0.11! Right click on a behaviour or component to copy. Then open an object, add the same behaviour or component, and right click it to paste identical parameter settings.
{% endhint %}
Alter ambience and apparent time of day by controlling light intensity, colours, the moon, stars and sun.
{% hint style="info" %}
[build-singleplayer-and-multiplayer-logic](https://docs.sandbox.game/en/creator/game-maker/docs/build-singleplayer-and-multiplayer-logic "mention") - about **\[SP]** or **\[MP]** behaviours or components
{% endhint %}
##  Weather Switcher \[MP]
Changes the ambience of the environment for ALL players simultaneously:
* colour of sky and environmental light
* position of the sun and moon (time of day)
* density of clouds
* brightness of stars
## Common Uses
* Instant change of weather/time settings using any Message
* Gradual change of weather/time settings over a specified time period by sending a special Message, **WeatherFade**, to this object
* Cycles of change from day/night when combined with other logic such as [**Timed Events**](https://docs.sandbox.game/en/creator/game-maker/docs/behaviours/basic-logic/timed-events)
## Parameters
| Options | Details |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  |
Wait For Message - Determines whether the weather settings should be active at the start of your game or upon receiving a message.
Message to switch - Defines which message(s) will activate the Weather Switcher.
|
|  | ***Preset Name*** - Allows you to choose preset weather settings from a drop down menu. To create your own unique weather preset, choose "Custom". |
|  | **Sky Top/Middle/Bottom** - Allows you to choose the colours of the sky to create your own unique look. |
|  |
Light Colour - Allows you to choose the colour of the light in your experience. Changing this to a different colour can drastically change the look of your game.
Light Intensity - Determines the intensity of the lighting. Higher values makes the experience brighter.
Moon Colour - Allows you to change the colour of the moon.
Moon Size - Determine the size of the moon in the sky.
|
|  | **Stars Intensity** - Determines the intensity of the stars. Higher values will result in more and brighter stars. |
|  |
Shadow Colour - Changes the colour of shadows.
Shadow Intensity - Determines how light or dark the shadows are. Higher values result in darker shadows.
Time - Set the time of the day. Changing this setting will determine whether there will be a moon or a sun in the sky, and also determine the position of them.
Value 0.50 is equal to noon. Values 0 and 1 are equal to midnight.
|
|  | **Sky Influence** - Determines how much the colours of the sky affect the hue of the overall landscape. |
|  |
Cloud Density - Determines how many clouds are in the sky.
Cloud Shadow/Light/Sky Colour - Determines the colours of the clouds. You can try different settings for different effects.
Preview - Allows you to preview the settings you have chosen.
Restore - Restores the preview weather to default weather. Your settings remain.
|
If the Weather Switcher has triggers influenced by player interaction, then the actions of ALL players can trigger the Behaviour.
## APPLYING THE BEHAVIOUR
Because this Behaviour is Multiplayer, make sure to select ‘Synchronized’ in the Behaviour Panel when adding it to an actor.
{% hint style="info" %}
It’s recommended to apply this Behaviour to a Logic Asset. This makes them easier to identify and reduces the face count in an experience, which improves performance.
{% endhint %}
{% hint style="warning" %}
This Behaviour doesn’t work with the Toggle component.
{% endhint %}
## PROPERTIES
### WAIT FOR MESSAGE
If Wait for Message is set to **FALSE**, then the Behaviour will be active as soon as the experience loads.
If Wait for Message is set to **TRUE**, then the Behaviour will be inactive until triggered, and **Message to Switch** will become available as a field.
#### Message to Switch
To set an activation message, either create a new one by clicking the field, typing the desired message and clicking enter, or selecting an existing message from the drop-down list.
### PRESETS
The Weather Switcher Behaviour will open set to a Preset by default and can be changed to a range of themes from Desert, Neutral, Night, Noon, Sunrise, to Overcast.
There is also the option to create a **Custom** Weather Switcher. When this is selected, a range of options to customise the **colour**, **light**, **sun position**, **moon position**, and **star intensity** will become available.
### CUSTOM WEATHER SWITCHER
Presets **must be set to** **CUSTOM** for these variables to appear in the Properties Panel.
{% tabs %}
{% tab title="Sky" %}
### SKY
The Sky Parameter has variables that affect the colour of different areas in the Sky Box.
The Skybox is a cube-shaped object that surrounds a Land in Game Maker and is used to simulate an outdoor environment.
#### Sky Top
This parameter sets the colour for the uppermost section of the skybox, starting at the horizon line and moving up to cover the whole area directly above the experience.
#### Sky Middle
The Sky Middle colour settings affect the horizon line of the skybox and blend between Sky Top and Sky Bottom.
{% hint style="info" %}
Sun and Moon colour settings will also influence the look of this region of the skybox.
{% endhint %}
#### Sky Bottom
This parameter sets the colour for the lowermost section of the skybox, starting at the horizon line and moving down to cover the whole area directly below the Experience.
{% endtab %}
{% tab title="Light" %}
### LIGHT
#### Light Colour
This Parameter sets the hue and saturation of the main light in the experience.
{% hint style="info" %}
The Light Paramtere is the light used to generate shadows in an experience.
{% endhint %}
Setting the Light Color can drastically affect the playability of the experience as well as the mood and atmosphere of an experience.
For example, using a warm, yellow light can create a sense of comfort, while using a cold, blue light can create a sense of dread.
To change the Light Colour, click on the colour bar and make a selection from the pop-up window using the colour picker, sliders, or a Hex code.
#### Light Intensity
light intensity refers to the brightness of the light in an experience. Using a high-intensity light can create a sense of daylight or bright sunshine while using a low-intensity light can create a sense of twilight or a dimly lit room.
{% hint style="info" %}
Light Colour and Light Intensity are non-directional and apply to the overall lighting state of the scene. It is separate from the colour and intensity of the Sun and Moon.
{% endhint %}
{% endtab %}
{% tab title="Fog" %}
### FOG
Fog is a visual effect that simulates the scattering of light in the atmosphere, creating a hazy or misty effect.
**Density** applies more or less fog, and **Power** changes how it will be distributed over a distance.
#### Fog Density
Fog density refers to the amount of fog present in a game's environment.
A higher density of fog will create a thicker and more visible haze, while a lower density will create a thinner and less visible haze.
LEFT: Fog Density 1.00. RIGHT: Fog Density 3.00
#### Fog Power
Fog Power represents the curve in fog intensity over distance.
It can be set to a value between 1.00 - 8.00 and refers to how visible or intense the fog effect is in an experience.
LEFT: Fog Power 1.00 RIGHT: Fog Power 3.00
{% hint style="info" %}
It may be counter-intuitive, but less power lets you see more fog. This is because the more power it has, the farther away the fog starts farther, but it increases more rapidly.
{% endhint %}
A Fog Density of 2.00, with a Fog Power of 1.00, will have a thick fog but a short fall-off, which makes it harder to see into the Fog.
A Fog Density of 2.00, but with a Fog Power of 3.00, will have a greater curve in Intensity, resulting in a longer gradient of fall-off, which makes it easier to see further into the Fog.
{% endtab %}
{% tab title="Sun" %}
### SUN
#### Sun Colour
This parameter sets the colour and intensity of the Sun in the skybox.
Click the colour bar in the Properties Panel to access the colour selector pop-up and use the sliders, colour picker, or hex code to select the desired result.
The Sun Colour pop-up window is unique in that the **Colour Intensity** is also selected in this window. You can access it below the colour picker and use the slider to set the variable as needed.
{% hint style="info" %}
This setting also changes the colour of the horizon line in the experience and the look of the Sun.
{% endhint %}
#### Sun Size
Sets the Size of the Sun to a value between 0.00 and 8.00, with **0.00** being non-existence and **8.00** being large.
LEFT: Sun Size 2.00. RIGHT: Sun Size 8.00.
{% endtab %}
{% tab title="Moon" %}
### MOON
#### Moon Colour
This parameter sets the colour and intensity of the Moon in the skybox.
Click the colour bar in the Properties Panel to access the colour selector pop-up and use the sliders, colour picker, or hex code to select the desired result.
The Moon Colour pop-up window is unique in that the **Colour Intensity** is also selected in this window. You can access it below the colour picker and use the slider to set the variable as needed.
#### Moon Size
Sets the Size of the Sun to a value between **0.00** and **8.00**, with 0.00 being non-existence and 8.00 being large.
LEFT: Moon Size at 8.00. RIGHT: Moon Size at 2.00
{% endtab %}
{% tab title="Stars" %}
### STARS
Star Intensity refers to the brightness or luminosity of stars in an experience.
Star intensity can be adjusted to mimic different times of day and can be set with a value between 0.00 and 10.00, where 0.00 displays faint stars and 10.00 displays bright stars.
LEFT: Star Intensity at 10. RIGHT: Star Intensity 0.00.
{% endtab %}
{% endtabs %}
{% tabs %}
{% tab title="Shadows" %}
### SHADOWS
#### Shadow Colour
This variable defines the colour of shadows cast by objects in an experience when light is blocked by the object.
Clicking on the colour bar in the properties panel will open a pop-up where the values can be set to match the desired look of the game.
The shadow colour can be set using the available sliders, or if a colour pallet has already been defined for an experience, a Hex code can be pasted into the available field.
{% hint style="info" %}
Setting Shadow Colour to white will result in no shadows being cast.
{% endhint %}
The chosen colour will also affect the colour of objects. The impact of the colour will change depending on how dark or light the surface is.
The impact of Shadow Colour on different coloured Blocks.
{% hint style="info" %}
Shadows can be used to create a sense of realism, depth and atmosphere, for example, darker shadows could be used to accentuate a horror experience.
{% endhint %}
#### Shadow Intensity
Shadow intensity refers to the darkness or strength of the shadows generated by Blocks and Objects in the experience.
The value of Shadow Intensity can be set between 0.00 to 1.00, with 0 representing no shadows and 1 representing deep shadows.
{% hint style="info" %}
For a standard shadow setting, try using Dark Grey (HEX Code #A9A9A9) as a Shadow Colour with a Shadow Intensity of 0.6.
{% endhint %}
{% endtab %}
{% tab title="Time" %}
### TIME
Time controls the position of the Sun and the Moon in your experience and can be set using the sliders or field between 0.00 - 1.00.
The Sun and Moon appear in the Skybox depending on the value set in Time.
This changes the location of the Sun and Moon in the skybox as well as the location of the environmental light source.
Setting the Time of an experience will have an overall effect on the intensity of light, and the direction shadows are cast.
The value set in Time changes the position of the enviromental light, which changes the direction of shadows.
Use the table below as a guide for setting the time of day and the position of the Sun and Moon.
Time of day in 24 hour time correlating to Time values in the Weather Switcher.
{% hint style="info" %}
While only one Time can be set on a single Behaviour, it's possible to use multiple Weather Switcher Behaviours to trigger different states during an experience.
{% endhint %}
{% endtab %}
{% tab title="Sky Influence" %}
#### Sky Influence
This parameter controls how much the colour of the sky affects assets.
{% endtab %}
{% tab title="SSS Intensity" %}
#### SSS Intensity
SSS or Sub Surface Scattering is the parameter that defines how light bounces around and exits clouds. This appears as a halo of light when the sun or moon is directly behind them.
The parameter can be set to a value between 0.00 and 10.00, with 0 being no Sub Surface Scattering.
Sub-Surface Scattering (SSS) refers to the way light enters beneath the surface of an object, bounces around inside the object, and then exits the object.
When you hold your hand up to the sun, and your skin takes on a reddish, almost translucent glow, that's sub-surface scattering at work - light enters the skin, bounces around under the surface, and then exits.
{% hint style="info" %}
In nature, this process won’t occur in solid objects, as light bounces off due to object density. It is, however, common in some organic or transparent objects.
{% endhint %}
{% endtab %}
{% tab title="Clouds" %}
### CLOUDS
#### Cloud Density
Cloud density refers to the thickness or amount of clouds in the experience and can be set with a value ranging from 0 to 1, with 0 representing no clouds and 1 representing full coverage.
A lower cloud density value will result in fewer clouds, which can create a clear sky, good for a sunny day.
A higher cloud density value results in more clouds, which can help to create a darker ambience and overcast look.
LEFT: Cloud Density with a value of 0.05. RIGHT: Cloud Density with a value of 1.00
#### Cloud Shadow Colour
Cloud shadow colour refers to the colour of the underside of the clouds in an experience.
Clicking on the colour bar in the Properties Panel will open a pop-up where the colour picker, sliders, and HEX code can be used to set the required values.
Adjusting the Cloud Shadow Colour can help create a more realistic look by matching the shadows to the ambient lighting in the scene. This can also be used to affect the overall mood and atmosphere of the experience.
{% hint style="info" %}
The **Shadow Colour** and **Shadow Intensity** settings don’t affect Cloud Shadow Colour. However, it is affected by **Cloud Light Colour** and **Cloud Sky Colour**.
{% endhint %}
#### Cloud Light Colour
This parameter defines the colour of the cloud surface facing the Sun or Moon.
LEFT: Cloud Light Colour set to white. RIGHT: Cloud Light Colour set to pink.
{% hint style="info" %}
Try using a blue or purple cloud shadow to create a colder-looking environment or an orange or yellow cloud shadow to create a warmer-looking environment.
{% endhint %}
#### Cloud Sky Colour
This parameter sets the colour on the top surface of clouds.
Select the colour by clicking on the colour bar in the properties panel on the right of the screen, then using the colour picker or sliders.
{% hint style="info" %}
Always make sure to press 'APPLY' before closing the colour picker window.
{% endhint %}
{% endtab %}
{% endtabs %}
#### SSS Colour
This parameter sets the colour of Sub Surface Scattering light in clouds.
This appears as a halo effect but will only be visible when Sub Surface Scattering Intensity has been set to a value higher than 0.00.
### PREVIEW
Clicking *PREVIEW* will generate a live view of the current Weather Switcher in the Edit Mode of the Game Maker.
Each time an adjustment is made to the Weather Switcher, the *PREVIEW* button will need to be clicked to update the scene.
### RESTORE
Click *RESTORE* will toggle the scene to the Default Ambience setting of the scene.
{% hint style="info" %}
The Restore button doesn’t erase custom settings on a Weather Switcher. Clicking Preview again will update the scene with the selected Weather Switchers parameters.
{% endhint %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.sandbox.game/en/creator/game-maker/docs/behaviours/visual/weather-switcher.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
