Flecs v4.0
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
ecs_type_hooks_t Struct Reference

Public Attributes

ecs_xtor_t ctor
 ctor
 
ecs_xtor_t dtor
 dtor
 
ecs_copy_t copy
 copy assignment
 
ecs_move_t move
 move assignment
 
ecs_copy_t copy_ctor
 Ctor + copy.
 
ecs_move_t move_ctor
 Ctor + move.
 
ecs_move_t ctor_move_dtor
 Ctor + move + dtor (or move_ctor + dtor).
 
ecs_move_t move_dtor
 Move + dtor.
 
ecs_flags32_t flags
 Hook flags.
 
ecs_iter_action_t on_add
 Callback that is invoked when an instance of a component is added.
 
ecs_iter_action_t on_set
 Callback that is invoked when an instance of the component is set.
 
ecs_iter_action_t on_remove
 Callback that is invoked when an instance of the component is removed.
 
voidctx
 User defined context.
 
voidbinding_ctx
 Language binding context.
 
voidlifecycle_ctx
 Component lifecycle context (see meta add-on)
 
ecs_ctx_free_t ctx_free
 Callback to free ctx.
 
ecs_ctx_free_t binding_ctx_free
 Callback to free binding_ctx.
 
ecs_ctx_free_t lifecycle_ctx_free
 Callback to free lifecycle_ctx.
 

Detailed Description

Definition at line 897 of file flecs.h.

Member Data Documentation

◆ binding_ctx

void* ecs_type_hooks_t::binding_ctx

Language binding context.

Definition at line 942 of file flecs.h.

◆ binding_ctx_free

ecs_ctx_free_t ecs_type_hooks_t::binding_ctx_free

Callback to free binding_ctx.

Definition at line 946 of file flecs.h.

◆ copy

ecs_copy_t ecs_type_hooks_t::copy

copy assignment

Definition at line 900 of file flecs.h.

◆ copy_ctor

ecs_copy_t ecs_type_hooks_t::copy_ctor

Ctor + copy.

Definition at line 904 of file flecs.h.

◆ ctor

ecs_xtor_t ecs_type_hooks_t::ctor

ctor

Definition at line 898 of file flecs.h.

◆ ctor_move_dtor

ecs_move_t ecs_type_hooks_t::ctor_move_dtor

Ctor + move + dtor (or move_ctor + dtor).

This combination is typically used when a component is moved from one location to a new location, like when it is moved to a new table. If not set explicitly it will be derived from other callbacks.

Definition at line 913 of file flecs.h.

◆ ctx

void* ecs_type_hooks_t::ctx

User defined context.

Definition at line 941 of file flecs.h.

◆ ctx_free

ecs_ctx_free_t ecs_type_hooks_t::ctx_free

Callback to free ctx.

Definition at line 945 of file flecs.h.

◆ dtor

ecs_xtor_t ecs_type_hooks_t::dtor

dtor

Definition at line 899 of file flecs.h.

◆ flags

ecs_flags32_t ecs_type_hooks_t::flags

Hook flags.

Indicates which hooks are set for the type, and which hooks are illegal. When an ILLEGAL flag is set when calling ecs_set_hooks() a hook callback will be set that panics when called.

Definition at line 925 of file flecs.h.

◆ lifecycle_ctx

void* ecs_type_hooks_t::lifecycle_ctx

Component lifecycle context (see meta add-on)

Definition at line 943 of file flecs.h.

◆ lifecycle_ctx_free

ecs_ctx_free_t ecs_type_hooks_t::lifecycle_ctx_free

Callback to free lifecycle_ctx.

Definition at line 947 of file flecs.h.

◆ move

ecs_move_t ecs_type_hooks_t::move

move assignment

Definition at line 901 of file flecs.h.

◆ move_ctor

ecs_move_t ecs_type_hooks_t::move_ctor

Ctor + move.

Definition at line 907 of file flecs.h.

◆ move_dtor

ecs_move_t ecs_type_hooks_t::move_dtor

Move + dtor.

This combination is typically used when a component is moved from one location to an existing location, like what happens during a remove. If not set explicitly it will be derived from other callbacks.

Definition at line 919 of file flecs.h.

◆ on_add

ecs_iter_action_t ecs_type_hooks_t::on_add

Callback that is invoked when an instance of a component is added.

This callback is invoked before triggers are invoked.

Definition at line 929 of file flecs.h.

◆ on_remove

ecs_iter_action_t ecs_type_hooks_t::on_remove

Callback that is invoked when an instance of the component is removed.

This callback is invoked after the triggers are invoked, and before the destructor is invoked.

Definition at line 939 of file flecs.h.

◆ on_set

ecs_iter_action_t ecs_type_hooks_t::on_set

Callback that is invoked when an instance of the component is set.

This callback is invoked before triggers are invoked, and enable the component to respond to changes on itself before others can.

Definition at line 934 of file flecs.h.


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