Lumberyard
User Guide (Version 1.21)

Using Script Events in Script Canvas

Script Canvas scans for and detects script event assets, so after you define a script event, you can use it in Script Canvas.

Script Events in the Node Palette

Script event assets appear by default in the Script Events category in the Script Canvas editor Node Palette.


                    The Script Events category in the Script Canvas
                            Node Palette.

Note

To change the name of the category, open the script event's asset definition in the Asset Editor and edit the Category property.

Sending Events

You can send an event by adding a Send method_name node to a Script Canvas graph.

To send an event

  1. Drag and drop the method that you want to send onto the Script Canvas graph.

  2. In the context menu, choose Send method_name.

    
                            Choose Send
                                method_name in the context menu.

    A method send node is added to the graph.

    
                            A send node added to a Script Canvas graph.
  3. Connect this node to the appropriate logic and data inputs. When the Script Canvas graph runs, it sends the event to the entities or systems to which the node is connected.

Handling Events

You can handle an event by adding a Receive method_name node to a Script Canvas graph.

To handle an event

  1. Drag and drop a script event method onto the canvas.

  2. In the context menu, choose Receive method_name.

    
                            Choose Receive
                                method_name in the context menu.

    An event handler method node is added to the graph.

    
                            A receive node added to a Script Canvas
                                    graph.
  3. Connect your event handling logic to the Out pin of the node.

  4. Connect the data pin as needed.