Flecs: include/flecs/addons/alerts.h File Reference
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.0 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
Classes | Macros | Typedefs | Functions
alerts.h File Reference

Alerts module. More...

Go to the source code of this file.

## Classes
struct | EcsAlertInstance
| Component added to alert instance. More...
struct | EcsAlertsActive
| Map with active alerts for entity. More...
struct | ecs_alert_severity_filter_t
| Alert severity filter. More...
struct | ecs_alert_desc_t
| Alert descriptor, used with ecs_alert_init(). More...

## Macros
#define | ECS_ALERT_MAX_SEVERITY_FILTERS (4)
#define | ecs_alert(world, ...)
| Create a new alert.

## Typedefs
typedef struct EcsAlertInstance | EcsAlertInstance
| Component added to alert instance.
typedef struct EcsAlertsActive | EcsAlertsActive
| Map with active alerts for entity.
typedef struct ecs_alert_severity_filter_t | ecs_alert_severity_filter_t
| Alert severity filter.
typedef struct ecs_alert_desc_t | ecs_alert_desc_t
| Alert descriptor, used with ecs_alert_init().

## Functions
FLECS_API | ECS_COMPONENT_DECLARE (FlecsAlerts)
| Module id.
FLECS_API | ECS_COMPONENT_DECLARE (EcsAlert)
| Component added to alert, and used as first element of alert severity pair.
FLECS_API | ECS_COMPONENT_DECLARE (EcsAlertInstance)
| Component added to alert instance.
FLECS_API | ECS_COMPONENT_DECLARE (EcsAlertsActive)
| Component added to alert source which tracks how many active alerts there are.
FLECS_API | ECS_COMPONENT_DECLARE (EcsAlertTimeout)
| Component added to alert which tracks how long an alert has been inactive.
FLECS_API | ECS_TAG_DECLARE (EcsAlertInfo)
| Info alert severity.
FLECS_API | ECS_TAG_DECLARE (EcsAlertWarning)
| Warning alert severity.
FLECS_API | ECS_TAG_DECLARE (EcsAlertError)
| Error alert severity.
FLECS_API | ECS_TAG_DECLARE (EcsAlertCritical)
| Critical alert severity.
FLECS_API ecs_entity_t | ecs_alert_init (ecs_world_t *world, const ecs_alert_desc_t *desc)
| Create a new alert.
FLECS_API int32_t | ecs_get_alert_count (const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t alert)
| Return number of active alerts for entity.
FLECS_API ecs_entity_t | ecs_get_alert (const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t alert)
| Return alert instance for specified alert.
FLECS_API void | FlecsAlertsImport (ecs_world_t *world)
| Alert module import function.

## Detailed Description

Alerts module.

The alerts module enables applications to register alerts for when certain conditions are met. Alerts are registered as queries, and automatically become active when entities match the alert query.

Definition in file alerts.h.