Skip to content

Events

Events are the most direct way to send ad-hoc messages back to the rest of your game. You can also just set variables, because code can be notified on variable changes, but if you want to send back a message with multiple argument values, events have your back.

An event line might look something like this:

[event MyAwesomeEvent 23, `Boop`, false]

Event Name

The first parameter is the event name, in this case "MyAwesomeEvent".

Event names can be any sequence of alphanumeric characters or underscores; note that dashes or other symbols are not allowed (much like Labels).

Event Arguments

Optionally you can include any number of arguments after the event name, separated by commas.

Arguments can be literal values, as shown above, or they can be expressions, referencing variables and optionally doing operations on them. For example:

[event MyAwesomeEvent {NumCats}, `Boop`, {HasLaserPointer} or {HasTreats}]

See the Variables and Expressions sections for more detail.

Note: Text literals in event arguments are not localised. If you need them to be, consider using a set line which can localise text and passing the variable instead. Or, pass another type and generate localised text in code.

Receiving Events

C++ or Blueprint code can receive events either by subscribing to the OnEvent delegate hook of a dialogue, or by being a Participant in the dialogue.


See Also