IEvent Struct Reference

Base event payload struct. More...

#include <EventTypes.h>

Public Attributes
bool	Cancelled
	Set to true by a listener to indicate the event has been handled and should not propagate further.

Detailed Description

Base event payload struct.

All event-specific payload structs must embed this as their first member (see DEFINE_EVENT). The Cancelled flag can be set by any listener to signal that subsequent handling should be skipped; EventSystem itself does not enforce this — the caller uses the CALL_CANCELLABLE_EVENT macro family to check the flag.

Member Data Documentation

Cancelled

bool IEvent::Cancelled

Set to true by a listener to indicate the event has been handled and should not propagate further.

---

The documentation for this struct was generated from the following file:

• include/ship/events/EventTypes.h