Rain

You can use the Rain component to create rain effects, puddles, and ripples on the terrain. You can add multiple Rain components to your entities in a level, but the level uses only one of the Rain components. The last Rain component to activate takes priority and Lumberyard renders that component.

To enable the Rain component, you must enable the Rain gem. For more information, see Rain 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 Rain On or Off
• Editing Rain Effects
• Rain Component Properties
• EBus Request Bus Interface
  • Request Bus Example Script

Turning Rain On or Off

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

To toggle rain 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 Rain Effects

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

To edit rain effects

1. Disable AI/Physics.

2. Make changes to the Rain component properties.

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

Rain Component Properties

The Rain 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 Rain component attached. The EBus is available at game run 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 rain simulation immediately. This can cause performance implications if you want to change multiple parameters. To avoid this, you can set multiple parameters at once with GetRainOptions and SetRainOptions.

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

Request Bus Example Script

function example:OnActivate()
    RainComponentRequestBus.Event.SetAmount(self.entityId, 5.0)
    RainComponentRequestBus.Event.Toggle(self.entityId)
end