Flecs v3.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
ecs_event_desc_t Struct Reference

Public Attributes

ecs_entity_t event
 The event id. More...
 
const ecs_type_tids
 Component ids. More...
 
ecs_table_ttable
 The table for which to notify. More...
 
ecs_table_tother_table
 Optional 2nd table to notify. More...
 
int32_t offset
 Limit notified entities to ones starting from offset (row) in table. More...
 
int32_t count
 Limit number of notified entities to count. More...
 
ecs_entity_t entity
 Single-entity alternative to setting table / offset / count. More...
 
const void * param
 Optional context. More...
 
ecs_poly_tobservable
 Observable (usually the world) More...
 
ecs_flags32_t flags
 Event flags. More...
 

Detailed Description

Definition at line 4053 of file flecs.h.

Member Data Documentation

◆ count

int32_t ecs_event_desc_t::count

Limit number of notified entities to count.

offset+count must be less than the total number of entities in the table. If left to 0, it will be automatically determined by doing ecs_table_count(table) - offset.

Definition at line 4075 of file flecs.h.

◆ entity

ecs_entity_t ecs_event_desc_t::entity

Single-entity alternative to setting table / offset / count.

Definition at line 4078 of file flecs.h.

◆ event

ecs_entity_t ecs_event_desc_t::event

The event id.

Only triggers for the specified event will be notified

Definition at line 4055 of file flecs.h.

◆ flags

ecs_flags32_t ecs_event_desc_t::flags

Event flags.

Definition at line 4087 of file flecs.h.

◆ ids

const ecs_type_t* ecs_event_desc_t::ids

Component ids.

Only triggers with a matching component id will be notified. Observers are guaranteed to get notified once, even if they match more than one id.

Definition at line 4060 of file flecs.h.

◆ observable

ecs_poly_t* ecs_event_desc_t::observable

Observable (usually the world)

Definition at line 4084 of file flecs.h.

◆ offset

int32_t ecs_event_desc_t::offset

Limit notified entities to ones starting from offset (row) in table.

Definition at line 4070 of file flecs.h.

◆ other_table

ecs_table_t* ecs_event_desc_t::other_table

Optional 2nd table to notify.

This can be used to communicate the previous or next table, in case an entity is moved between tables.

Definition at line 4067 of file flecs.h.

◆ param

const void* ecs_event_desc_t::param

Optional context.

Assigned to iter param member

Definition at line 4081 of file flecs.h.

◆ table

ecs_table_t* ecs_event_desc_t::table

The table for which to notify.

Definition at line 4063 of file flecs.h.


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