Lumberyard
User Guide (Version 1.15)

Snow Gem

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn more about legacy features, see the Amazon Lumberyard Legacy Reference.

The Snow Gem creates realistic snow effects in your levels, including snowflake and surface effects, such as snow buildup. To enable the Snow Gem in your project, see Using Gems to Add Modular Features and Assets.

Note

Place only a single Snow entity in your scene.

Placing Snow

You can place your snow and customize it to your level by modifying properties for brightness, gravity, size and quantity of snow flakes, how much snow and frost builds on a surface, and more.

To add snow to your level

  1. In the Rollup Bar, click Entity.

  2. Under Browser, expand Environment.

  3. Drag the Snow entity into your scene.

Configuring Snow

You can configure the snow's properties under Entity Params and Entity Properties.

Snow Entity Properties

Properties Description
Enabled Enables snow effect
Radius Sets the area on which snow falls
SnowFall
Brightness Sets the brightness of the snow effect
GravityScale Sets the gravity strength, which determines the rate at which snow falls
SnowFlakeCount Sets the quantity of snowflakes
SnowFlakeSize Sets size of individual snowflakes
TurbulenceFreq Sets the frequency of the turbulence affecting the snow
TurbulenceStrength Sets the strength of the turbulence affecting the snow
WindScale Determines the impact of wind on the falling snow
Surface
FrostAmount Sets the amount of frost on a surface
SnowAmount Sets the amount of snow on a surface
SurfaceFreezing Sets the degree to which surfaces appear frozen

Using Console Variables for Snow

You can use the following console variables console variables for the snow entity.

Snow Entity Console Variables

Variable Description
r_Snow Enables snow rendering
r_SnowDisplacement Enables displacement for snow accumulation
r_SnowFlakeClusters Number of snow flake clusters
r_SnowHalfRes When enabled, renders snow at half resolution to conserve fill rate

Using the Snow Sample

The Snow Sample uses the Snow and Clouds gems to demonstrate how to use the Snow entity as an environment special effects in a level. The Snow entity shows how snow falls and provides properties that you can set to randomly change the snow fall over time, creating a more dynamic weather experience.