Enabling and Disabling Effect Groups - Lumberyard User Guide

Enabling and Disabling Effect Groups

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

You can enable and disable effect groups with the Script Canvas editor or Lua scripting.

To enable or disable effect groups with Script Canvas

  1. In Lumberyard Editor, open your level.

  2. In the menu bar, choose Tools, Script Canvas.

  3. In the Script Canvas editor, choose File, New Script.

  4. Right-click the canvas, search and then select the following nodes:

  5. For your script, do the following:

    1. Select the Out pin for On Graph Start and drag to connect it to the In pin for the Enable/Disable Effect Group node.

    2. For the Group Name parameter, enter the file path for the group (for example, Libs\PostEffectGroups\MyEffectGroup.xml).

                            Use the Enable Effect Group node in the
                                    Script Canvas editor.
  6. Save the script and attach it to an entity with the Script Canvas component.

  7. Close the Script Canvas editor.


You can manually enable or disable an effect group in Lumberyard Editor by running the Lua functions in the Console window. To indicate a Lua command, prepend each command with the # character.