LDKComponentAttachFn

Callback used when a component is attached to an entity.

typedef bool(*LDKComponentAttachFn)(LDKEntityRegistry *entity_registry, LDKComponentRegistry *component_registry, LDKEntity entity, void *component, u32 component_index, const void *initial_value, void *user);

LDKComponentDestroyFn

Callback used when component instance data is destroyed.

typedef void(*LDKComponentDestroyFn)(LDKEntityRegistry *entity_registry, LDKComponentRegistry *component_registry, LDKEntity entity, void *component, u32 component_index, void *user);

LDKComponentFlags

A descriptor that identifies a Component. Components are plain data structures that can be attached to entities. Component types needs to be registered before they are used.

typedef enum LDKComponentFlags{
  LDK_COMPONENT_FLAG_NONE=0,
  LDK_COMPONENT_FLAG_HIDE_IN_INSPECTOR=1<<0
}LDKComponentFlags;

LDKComponentDesc

typedef struct LDKComponentDesc{
  const char *name;
  u32 type;
  u32 entry_size;
  u32 initial_capacity;
  u32 flags;
  const u32 *required_components;
  u32 required_component_count;
  LDKComponentAttachFn attach;
  LDKComponentDestroyFn destroy;
  void *user;
}LDKComponentDesc;

LDKRegisteredComponent

typedef struct LDKRegisteredComponent{
  LDKComponentDesc desc;
  XArray *store;
  XArray *owners;
}LDKRegisteredComponent;

X_HASHTABLE_TYPE_NAMED

 X_HASHTABLE_TYPE_NAMED(
 u32,
 LDKRegisteredComponent,
 u32_registered_component
);

LDKComponentRegistry

typedef struct LDKComponentRegistry{
  XHashtable_u32_registered_component *table;
}LDKComponentRegistry;

ldk_component_registry_initialize

Initialize the component registry.

LDK_API bool ldk_component_registry_initialize(LDKComponentRegistry *registry);

ldk_component_registry_terminate

Shut down the component registry.

LDK_API void ldk_component_registry_terminate(LDKComponentRegistry *registry);

ldk_component_is_registered

Check whether a component type is registered.

LDK_API bool ldk_component_is_registered(
 LDKComponentRegistry *registry,
 u32 type
);

ldk_component_desc_get

Get the component desc.

LDK_API bool ldk_component_desc_get(
 LDKComponentRegistry *registry,
 u32 type,
 LDKComponentDesc *out_desc
);

ldk_component_store_get

Get the component store.

LDK_API XArray * ldk_component_store_get(
 LDKComponentRegistry *registry,
 u32 type
);

ldk_component_owners_get

Get the component owners.

LDK_API XArray * ldk_component_owners_get(
 LDKComponentRegistry *registry,
 u32 type
);

ldk_component_detach

Detach a component from an entity.

LDK_API bool ldk_component_detach(
 LDKComponentRegistry *registry,
 LDKEntityRegistry *entity_system,
 LDKEntity entity,
 u32 component_type
);

ldk_component_registry_remove_all

Removes (destroys) ALL components, including core engine components like Transform. Intended for entity destruction only.

LDK_API void ldk_component_registry_remove_all(
 LDKComponentRegistry *registry,
 LDKEntityRegistry *entity_system,
 LDKEntity entity
);

ldk_component_create

Create the component.

LDK_API void * ldk_component_create(
 LDKComponentRegistry *module,
 u32 component_type,
 u32 *component_index
);

ldk_component_get

Get the component.

LDK_API void * ldk_component_get(
 LDKComponentRegistry *module,
 u32 component_type,
 u32 component_index
);

ldk_component_destroy

Destroy the component.

LDK_API bool ldk_component_destroy(
 LDKComponentRegistry *module,
 LDKEntityRegistry *entity_module,
 u32 component_type,
 u32 component_index
);

ldk_component_register

Register the component.

LDK_API bool ldk_component_register(
 LDKComponentRegistry *registry,
 const LDKComponentDesc *desc
);

ldk_component_attach

Attach a component to an entity.

LDK_API bool ldk_component_attach(
 LDKComponentRegistry *registry,
 LDKEntityRegistry *entity_registry,
 LDKEntity entity,
 u32 component_type,
 u32 component_index,
 const void *initial_value
);

ldk_component_destroy_data

Release data associated with a component instance.

LDK_API void ldk_component_destroy_data(
 LDKComponentRegistry *registry,
 LDKEntityRegistry *entity_registry,
 LDKEntity entity,
 u32 component_type,
 u32 component_index
);

ldk_component_name_get

Get the registered name of a component type.

LDK_API const char * ldk_component_name_get(
 LDKComponentRegistry *registry,
 u32 type
);