c_api_world.h - Engine C API Reference

c_api_world.h
  1. #pragma once
  3. #include "c_api_types.h"
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  9. /* Defines what should happen if a linked effect becomes orphaned. Should it
  10.     be destroyed, stop spawning or be unlinked and continue to spawn. */
  11. struct WorldCApi
  12. {
  13.     UnitRef  (*spawn_unit) (WorldPtr world_pointer, uint64_t unit_name_id64, const char *optional_debug_unit_name, ConstMatrix4x4Ptr transform);
  14.     void     (*destroy_unit) (WorldPtr world_pointer, UnitRef unit_ref);
  15.     unsigned (*num_units) (ConstWorldPtr world_pointer);
  17.     UnitRef (*unit_by_name) (WorldPtr world_pointer, uint64_t unit_name);
  18.     UnitRef (*unit_by_id) (WorldPtr world_pointer, uint64_t unit_id);
  19.     UnitRef (*unit_by_index) (WorldPtr world_pointer, unsigned index);
  20.     unsigned (*num_units_by_resource) (WorldPtr world_pointer, uint64_t resource_name);
  21.     unsigned (*units_by_resource)(WorldPtr world_pointer, uint64_t resource_name, unsigned max_unit_count, UnitRef* units);
  23.     void    (*link_unit) (WorldPtr world_pointer, UnitRef child, unsigned child_node_index, UnitRef parent, unsigned parent_node_index);
  24.     void    (*unlink_unit) (WorldPtr world_pointer, UnitRef child);
  25.     void    (*update_unit) (WorldPtr world_pointer, UnitRef unit_ref);
  26.     ParticleRef (*create_particles) (WorldPtr world_pointer, uint64_t name_id64, const char *optional_debug_name, ConstMatrix4x4Ptr transform);
  27.     void    (*destroy_particles) (WorldPtr world_pointer, ParticleRef id);
  28.     void    (*stop_spawning_particles) (WorldPtr world_pointer, ParticleRef id);
  29.     int     (*are_particles_playing) (ConstWorldPtr world_pointer, ParticleRef id);
  30.     void    (*set_particles_collision_filter) (ConstWorldPtr world_pointer, uint32_t collision_filter_name);
  32.     void    (*move_particles) (WorldPtr world_pointer, ParticleRef id, ConstMatrix4x4Ptr transform);
  33.     void    (*link_particles) (WorldPtr world_pointer, ParticleRef id, UnitRef unit_ref, unsigned unit_node_index, ConstMatrix4x4Ptr local_pose, enum WorldCApi_OrphanedParticlePolicy orphaned_policy);
  35.     unsigned (*find_particles_variable) (ConstWorldPtr world_pointer, uint64_t name_id64, const char *optional_debug_name, unsigned variable_name_id32);
  36.     void     (*set_particles_variable) (WorldPtr world_pointer, ParticleRef id, unsigned variable, ConstVector3Ptr value);
  38.     LevelPtr (*load_level) (WorldPtr world_pointer, uint64_t level_name_id64, const char *optional_debug_level_name, ConstMatrix4x4Ptr transform, uint64_t optional_level_id);
  39.     void     (*destroy_level) (WorldPtr world_pointer, LevelPtr level_pointer);
  40.     unsigned (*num_levels) (ConstWorldPtr world_pointer);
  41.     LevelPtr (*level) (WorldPtr world_pointer, unsigned index);
  43.     void    (*update) (WorldPtr world_pointer, float dt);
  44.     void    (*update_animations) (WorldPtr world_pointer, float dt, CApiCallbackFunction optional_callback, CallbackData32Ptr callback_data32);
  45.     void    (*update_scene) (WorldPtr world_pointer, float dt);
  47.     float   (*delta_time) (ConstWorldPtr world_pointer);
  48.     float   (*time) (ConstWorldPtr world_pointer);
  50.     StoryTellerPtr   (*storyteller) (WorldPtr world_pointer);
  51.     VectorFieldPtr   (*vector_field) (WorldPtr world_pointer, unsigned vector_field_name_id32);
  52.     ScatterSystemPtr (*scatter_system) (WorldPtr world_pointer);
  54.     ShadingEnvironmentPtr (*create_shading_environment) (WorldPtr world_pointer, uint64_t name_id64, const char *optional_debug_name);
  55.     ShadingEnvironmentPtr (*create_default_shading_environment) (WorldPtr world_pointer);
  56.     void (*destroy_shading_environment) (WorldPtr world_pointer, ShadingEnvironmentPtr shading_environment_pointer);
  57.     void (*set_shading_environment) (WorldPtr world_pointer, ShadingEnvironmentPtr shading_environment, uint64_t name_id64, const char *optional_debug_name);
  59.     LineObjectPtr       (*create_line_object) (WorldPtr world_pointer, int disable_depth_test);
  60.     void                (*destroy_line_object) (WorldPtr world_pointer, LineObjectPtr line_object_pointer);
  61.     void                (*clear_permanent_lines) (WorldPtr world_pointer);
  63.     GuiPtr  (*create_screen_gui) (WorldPtr world_pointer, ConstVector2Ptr optional_position, ConstVector2Ptr optional_scale, int immediate, int dock_right, int dock_top);
  64.     GuiPtr  (*create_world_gui) (WorldPtr world_pointer, ConstMatrix4x4Ptr transform, float width, float height, int shadow_caster, int immediate);
  65.     void    (*destroy_gui) (WorldPtr world_pointer, GuiPtr gui_pointer);
  66.     GuiPtr  (*get_gui_by_id) (WorldPtr world_pointer, unsigned gui_id);
  68.     PhysicsWorldPtr (*physics_world) (WorldPtr world_pointer);
  70.     VideoPlayerPtr  (*create_video_player) (WorldPtr world_pointer, uint64_t resource_id64, int loop);
  71.     void            (*destroy_video_player) (WorldPtr world_pointer, VideoPlayerPtr video_player);
  73.     ConstMatrix4x4Ptr   (*debug_camera_pose) (WorldPtr world_pointer);
  75.     /* Begin Development functions */
  76.     void    (*set_flow_enabled) (WorldPtr world_pointer, int enable);
  77.     void    (*set_editor_flow_enabled) (WorldPtr world_pointer, int enable);
  79.     unsigned    (*num_particles)(WorldPtr world_pointer, unsigned* optional_effect_id, unsigned* optional_cloud_index);
  80.     void        (*advance_particles_time)(WorldPtr world_pointer, unsigned id, float time);
  82.     void        (*set_frustum_inspector_camera) (WorldPtr world_pointer, CameraPtr camera_pointer);
  84.     ReplayPtr   (*replay)(WorldPtr world_pointer);
  85.     void        (*start_playback)(ReplayPtr replay_ptr);
  86.     void        (*stop_playback)(ReplayPtr replay_ptr);
  87.     int         (*is_playing_back)(ReplayPtr replay_ptr);
  88.     int         (*num_frames)(ReplayPtr replay_ptr);
  89.     int         (*frame)(ReplayPtr replay_ptr);
  90.     void        (*set_frame)(ReplayPtr replay_ptr, unsigned frame_index);
  91.     void        (*record_debug_line)(ReplayPtr replay_ptr, ConstVector4Ptr color, ConstVector2Ptr p1, ConstVector2Ptr p2);
  92.     void        (*record_screen_debug_text)(ReplayPtr replay_ptr, ConstVector4Ptr color, ConstVector2Ptr screen_position, const char* text);
  93.     void        (*record_world_debug_text)(ReplayPtr replay_ptr, ConstVector4Ptr color, ConstVector3Ptr world_position, const char* text);
  94.     void        (*set_unit_record_mode)(ReplayPtr replay_ptr, UnitRef unit, enum ReplayRecordMode replay_record_mode);
  95.     /* End Development functions */
  96. };
  98. #ifdef __cplusplus
  99. }
  100. #endif
Please send us your comment about this page