Function cmb_event_pattern_cancel

Function Documentation

uint64_t cmb_event_pattern_cancel(cmb_event_func *action, const void *subject, const void *object)

Cancel all matching events, returns the number of events that were canceled, possibly zero.

Use e.g., for cancelling all events related to some subject or object if that thing no longer is alive in the simulation.

Parameters:
  • action – Pointer to the event function to find, or CMB_ANY_ACTION

  • subject – Pointer to the subject to find, or CMB_ANY_SUBJECT

  • object – Pointer to the object to find, or CMB_ANY_OBJECT

Returns:

The number of events that matched and were canceled, possibly zero.