alerts.h File Reference

Alerts module. More...

Go to the source code of this file.

Classes
struct	EcsAlertInstance
	Alert information. More...
struct	EcsAlertsActive
	Map with active alerts for entity. More...
struct	ecs_alert_severity_filter_t
struct	ecs_alert_desc_t

Macros
#define	ECS_ALERT_MAX_SEVERITY_FILTERS   (4)
#define	ecs_alert(world, ...)    ecs_alert_init(world, &(ecs_alert_desc_t)__VA_ARGS__)

Typedefs
typedef struct EcsAlertInstance	EcsAlertInstance
	Alert information.
typedef struct EcsAlertsActive	EcsAlertsActive
	Map with active alerts for entity.
typedef struct ecs_alert_severity_filter_t	ecs_alert_severity_filter_t
typedef struct ecs_alert_desc_t	ecs_alert_desc_t

Functions
FLECS_API	ECS_COMPONENT_DECLARE (FlecsAlerts)
FLECS_API	ECS_COMPONENT_DECLARE (EcsAlert)
	Tag added to alert, and used as first element of alert severity pair.
FLECS_API	ECS_COMPONENT_DECLARE (EcsAlertInstance)
FLECS_API	ECS_COMPONENT_DECLARE (EcsAlertsActive)
FLECS_API	ECS_COMPONENT_DECLARE (EcsAlertTimeout)
FLECS_API	ECS_TAG_DECLARE (EcsAlertInfo)
FLECS_API	ECS_TAG_DECLARE (EcsAlertWarning)
FLECS_API	ECS_TAG_DECLARE (EcsAlertError)
FLECS_API	ECS_TAG_DECLARE (EcsAlertCritical)
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)

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.