c_api_entity.h - Engine C API Reference

c_api_entity.h
  1. #pragma once
  3. #include "c_api_types.h"
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  9. /* Manages the lifetime of an entity. */
  10. struct EntityManagerApi
  11. {
  12.     EntityRef (*create)(const void *owner);
  13.     void (*destroy)(EntityRef entity);
  14.     int (*is_alive)(EntityRef entity);
  15.     EntityRef (*spawn)(WorldPtr world, uint64_t entity_name_id64, const char *optional_debug_entity_name, ConstMatrix4x4Ptr transform);
  16. };
  18. /* Opaque struct representing the component api extension. */
  19. struct ComponentExtensionApi;
  21. /* Component property api. */
  22. typedef struct ComponentPropertyApi {
  24.     /* Set component propery value. */
  25.     void (*set_property)(ComponentPtr component, Instance i, EntityPropertyKey key, struct EntityPropertyValue value);
  27.     /* Get component property value. */
  28.     struct EntityPropertyValue (*get_property)(ComponentPtr component, Instance i, EntityPropertyKey key, struct AllocatorObject *temp_allocator);
  30. } ComponentPropertyApi;
  32. /* Component Api. */
  33. typedef struct ComponentApi
  34. {
  35.     /* Gets type name of the entity component. */
  36.     uint32_t (*type_name)();
  38.     /* Gets the component manager for the specified world. */
  39.     ComponentPtr (*component)(void *owner);
  41.     /* Creates a new component instance. */
  42.     Instance (*create)(ComponentPtr component, EntityRef entity, InstanceId instance_id);
  44.     /* Destroy component instance. */
  45.     void (*destroy)(ComponentPtr component, Instance i);
  47.     /* Destroy all instances of the entity. */
  48.     void (*destroy_all)(ComponentPtr component, EntityRef entity);
  50.     /* Gets the component instance from the specified component id. */
  51.     Instance (*lookup_instance)(ComponentPtr component, EntityRef entity, InstanceId id);
  53.     /* Gets the component instance id from the specified component instance. */
  54.     struct EntityInstanceId (*lookup_instance_id)(ComponentPtr component, Instance i);
  56.     /* Spawn component. */
  57.     void (*spawn)(ComponentPtr component, const EntityRef *entities, unsigned num_intances, const unsigned *entity_indicies, const unsigned *instance_ids, const char *data);
  59.     /* Set entity parent. */
  60.     void (*set_parent)(ComponentPtr component, const EntityRef *entities, unsigned num_entities, const unsigned *parent_index);
  62.     /* Called when the entity as been fully constructed and spawned. */
  63.     void (*spawned)(ComponentPtr component, const EntityRef *entities, unsigned num_entities);
  65.     /* Gets the first component instance for the entity. */
  66.     Instance (*first_instance)(ComponentPtr component, EntityRef entity);
  68.     /* Gets the next component instance. */
  69.     Instance (*next_instance)(ComponentPtr component, Instance i);
  71.     /* Gets the component property api. */
  72.     ComponentPropertyApi *(*get_property_api)();
  74.     /*
  75.         Retrieves a pointer to the component type specific API.
  76.         To use this cast the ComponentExtensionApi pointer to to the relevant definition represented in it's header file.
  77.     */
  78.     struct ComponentExtensionApi *(*get_extension_api)();
  80. } ComponentApi;
  82. typedef ComponentApi *ComponentApiPtr;
  84. struct EntityCApi
  85. {
  86.     struct EntityManagerApi* Manager;
  88.     /*
  89.         Retrieves a pointer to the Component API registered with the specified name.
  90.         To use the member functions of the specified Component API cast the ComponentApiPtr to the relevant definition represented in it's header file."
  91.     */
  92.     ComponentApiPtr (*component_api)(uint32_t name_id32);
  94.     /*  Registers a pointer to a component api with the specified name, the caller is responsible for keeping it allocated. */
  95.     void (*register_component_api)(uint32_t name_id32, ComponentApiPtr component_api);
  97.     /*  Returns true (1) if a component api with the specified name has already been registered.    */
  98.     int (*has_component_api)(uint32_t name_id32);
  100.     /*  Unregisters a component struct with the specified name. */
  101.     void (*unregister_component_api)(uint32_t name_id32);
  103.     /* Registers the entity component to the specified world. */
  104.     void (*register_entity_component)(WorldPtr world_pointer, ComponentPtr component, struct ComponentApi *component_api);
  106.     /* Unregisters the entity component from the specified world. */
  107.     void (*unregister_entity_component)(WorldPtr world_pointer, ComponentPtr component);
  108. };
  110. #ifdef __cplusplus
  111. }
  112. #endif
Please send us your comment about this page