Snow

You can use the Snow component to create snowfall effects and create patches of snow and ice on the terrain. You can add multiple Snow components to your entities in a level, but the level uses only one Snow component. The last Snow component to activate takes priority and Lumberyard renders that component.

To enable the Snow component, you must enable the Snow gem. For more information, see Snow Gem.

Note
If your level has a Snow and Rain component, the component that activates last takes priority; you cannot enable both Snow and Rain components at the same time.

Contents

• Turning Snow On or Off
• Editing Snow Effects
• Snow Component Properties
• EBus Request Bus Interface
  • Example Snow Component Request Bus

Turning Snow On or Off

You can toggle snow on or off in Lumberyard Editor by enabling or disabling AI/Physics, or by running or stopping the game.

To toggle snow effects on or off in Lumberyard Editor

• Do one of the following:
  • On the bottom right of the viewport, click AI/Physics.
  • Choose Game, Enable Physics/AI.
  • Press Ctrl+P.
  • Press Ctrl+G to enter gameplay mode. Press Esc to stop the game.

Editing Snow Effects

You can edit snow effects only when the AI/Physics toggle is disabled.

To edit snow effects

1. Disable AI/Physics.

2. Make changes to the Snow component properties.

3. Enable AI/Physics. After you reenable AI/Physics, your changes appear in the viewport.

Snow Component Properties

The Snow component has the following properties:

EBus Request Bus Interface

Use the following request functions with the EBus interface to communicate with other components of your game. You can use this EBus to communicate to an entity with a Snow component attached. The EB us is available at game time and editing, and can be accessed from C++, Lua, and the Script Canvas editor.

When set, the individual setters on this bus update the snow simulation immediately; this can cause some performance implications if you want to change multiple parameters. To avoid this, you can set multiple parameters at once with GetSnowOptions and SetSnowOptions.

For more information, see Working with the Event Bus (EBus) system.

Example Snow Component Request Bus

function example:OnActivate()
    SnowComponentRequestBus.Event.SetFrostAmount(self.entityId, 10)
    SnowComponentRequestBus.Event.Toggle(self.entityId) 
end