Events

Documentation is a work in progress

Documentation is an ongoing effort and some parts are more complete than others, with some missing entirely. Thanks for your patience, its being worked on!

See the Node Editor - Crash Course tutorial for an extensive introduction to the node editor.

The Event module base type allows the creation of node modules that listen to specfic events and run when they are emitted.

Event reference

You can find a listing of available events in the reference.

They are created like any other node module, through the Create module menu and selecting Event.

In the event module itself you can get access to the event emission object via the Event node.

There currently are no typed event emission nodes, so you will need to use the Get and Set nodes to get and set properties on the event object.

You can find the various event payloads in the reference.

Once your event module is saved, you enable it by adding its node to the scene loop of your scene.

Once added to the scene loop you must also specify the event_name.

Practical Example

The following example demonstrates how to use events node modules.

We will create a new event node module called Hook Generate Choices that will be used to add a custom instruction to the director agent's generate choices prompt.

First find the Create module menu and select Event.

Create the module and name it Hook Generate Choices.

In the node graph add these nodes:

• Event
• Get
• Dynamic Instruction
• List Append

Set them up

Get

Property	Value
attribute	dynamic_instructions

Dynamic Instruction

Property	Value
header	Make it fun
content	I want at least one humorous choice!

Then connect them:

• <Event>.event <Get>.object
• <Get>.value <List Append>.list
• <Dynamic Instruction>.dynamic_instruction <List Append>.item

Save!

Save the module.

In order to activate the event node module, we need to add it to the scene loop.

So load the scene loop and add the Hook Generate Choices node.

Set the event_name to agent.director.generate_choices.inject_instructions. (Again see the reference for the full list of events.)