c_api_unit.h - Engine C API Reference

c_api_unit.h
  1. #pragma once
  3. #include "c_api_types.h"
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  9. struct UnitCApi
  10. {
  11.     ConstVector3Ptr         (*local_position) (UnitRef, unsigned index);
  12.     CApiQuaternion (*local_rotation) (UnitRef, unsigned index);
  13.     ConstVector3Ptr         (*local_scale) (UnitRef, unsigned index);
  14.     ConstLocalTransformPtr  (*local_pose) (UnitRef, unsigned index);
  16.     void    (*set_local_position) (UnitRef, unsigned index, ConstVector3Ptr);
  17.     void    (*set_local_rotation) (UnitRef, unsigned index, ConstQuaternionPtr);
  18.     void    (*set_local_scale) (UnitRef, unsigned index, ConstVector3Ptr);
  19.     void    (*set_local_pose) (UnitRef, unsigned index, ConstLocalTransformPtr);
  21.     ConstVector3Ptr         (*world_position) (UnitRef, unsigned index);
  22.     ConstMatrix4x4Ptr       (*world_pose) (UnitRef, unsigned index);
  23.     // Performance-warning; Fetches the world_pose, extracts a Matrix3x3 from it and returns a copy on the stack.
  24.     CApiQuaternion (*world_rotation) (UnitRef, unsigned index);
  26.     void    (*teleport_local_position) (UnitRef, unsigned index, ConstVector3Ptr);
  27.     void    (*teleport_local_rotation) (UnitRef, unsigned index, ConstQuaternionPtr);
  28.     void    (*teleport_local_scale) (UnitRef, unsigned index, ConstVector3Ptr);
  29.     void    (*teleport_local_pose) (UnitRef, unsigned index, ConstLocalTransformPtr);
  31.     CApiVector3 (*delta_position) (UnitRef, unsigned index);
  32.     CApiQuaternion (*delta_rotation) (UnitRef, unsigned index);
  33.     struct CApiMatrix4x4 (*delta_pose) (UnitRef, unsigned index);
  35.     ActorPtr    (*create_actor) (UnitRef, unsigned index, float inherit_velocity, const char* optional_debug_actor_name);
  36.     void        (*destroy_actor) (UnitRef, unsigned index, const char* optional_debug_actor_name);
  37.     unsigned    (*num_actors) (UnitRef);
  38.     unsigned    (*find_actor) (UnitRef, unsigned actor_name_id32, const char* optional_debug_actor_name);
  39.     ActorPtr    (*actor) (UnitRef, unsigned index, const char* optional_debug_actor_name);
  41.     unsigned    (*num_movers) (UnitRef);
  42.     unsigned    (*find_mover) (UnitRef, unsigned mover_name_id32);
  43.     MoverPtr    (*set_mover) (UnitRef, unsigned index, const char *optional_debug_mover_name);
  44.     void        (*set_mover_to_none) (UnitRef);
  45.     MoverPtr    (*mover) (UnitRef);
  46.     struct MoverFitsAtResult (*mover_fits_at) (UnitRef unit_ref, unsigned index, ConstVector3Ptr position, float permitted_move_threshold, const char *optional_debug_mover_name);
  48.     void        (*trigger_flow_event) (UnitRef, unsigned event_name_id32);
  49.     void*       (*flow_variable) (UnitRef unit_ref, unsigned variable_name_id32, unsigned *out_type);
  50.     void        (*set_flow_variable) (UnitRef, unsigned variable_name_id32, void* value);
  51.     void        (*trigger_unit_spawned)(UnitRef unit_ref);
  53.     uint64_t        (*set_material) (UnitRef, unsigned slot_name_id32, uint64_t material_resource_name_id64, const char *optional_debug_material_resource_name, unsigned debug_suppress_slot_assignment_warning);
  54.     uint64_t        (*set_material_to_none) (UnitRef, unsigned slot_name_id32);
  55.     unsigned        (*query_material)(UnitRef unit_ref, ConstVector3Ptr start, ConstVector3Ptr end, unsigned context_count, unsigned context_id32s[], unsigned out_material[]);
  56.     MaterialDataPtr (*save_instance_material_data)(UnitRef unit_ref);
  57.     void            (*restore_instance_material_data)(UnitRef unit_ref, MaterialDataPtr data);
  58.     int             (*is_using_material_set)(UnitRef unit_ref);
  60.     unsigned    (*num_meshes) (UnitRef);
  61.     unsigned    (*find_mesh) (UnitRef, unsigned mesh_name_id32);
  62.     MeshPtr     (*mesh) (UnitRef, unsigned index, const char *optional_debug_mesh_name);
  64.     struct BoneNamesWrapper (*bones) (UnitRef);
  65.     CApiMatrix4x4   (*animation_wanted_root_pose) (UnitRef);
  66.     void    (*animation_set_bones_lod) (UnitRef, unsigned);
  68.     enum AnimationBoneRootMode (*animation_root_mode) (UnitRef);
  69.     enum AnimationBoneRootMode (*animation_bone_mode) (UnitRef);
  71.     void        (*set_animation_root_mode) (UnitRef, enum AnimationBoneRootMode);
  72.     void        (*set_animation_bone_mode) (UnitRef, enum AnimationBoneRootMode);
  74.     unsigned    (*animation_find_constraint_target) (UnitRef unit_ref, unsigned constraint_target_name_id32, const char *optional_debug_target_name);
  75.     unsigned    (*animation_has_constraint_target)(UnitRef unit_ref, unsigned constraint_target_name_id32);
  76.     ConstMatrix4x4Ptr (*animation_get_constraint_target) (UnitRef, unsigned index);
  77.     void        (*animation_set_constraint_target_pose) (UnitRef, unsigned index, ConstMatrix4x4Ptr);
  78.     void        (*animation_set_constraint_target_position) (UnitRef, unsigned index, ConstVector3Ptr);
  79.     void        (*animation_set_constraint_target_rotation) (UnitRef, unsigned index, ConstQuaternionPtr);
  81.     unsigned    (*crossfade_animation) (UnitRef, uint64_t animation_name_id64, const char *optional_debug_animation_name, unsigned layer, float blend_time, int should_loop, enum AnimationBlendType);
  82.     unsigned    (*is_crossfading_animation) (UnitRef);
  83.     void        (*crossfade_animation_set_time) (UnitRef, unsigned id, float time, int should_cap_to_range);
  84.     void        (*crossfade_animation_set_speed) (UnitRef, unsigned id, float speed);
  86.     void        (*disable_animation_state_machine) (UnitRef);
  87.     void        (*enable_animation_state_machine) (UnitRef);
  88.     void        (*set_animation_state_machine) (UnitRef, uint64_t machine_name_id64, const char *optional_debug_machine_name);
  89.     int         (*has_animation_state_machine) (UnitRef);
  90.     int         (*has_animation_event) (UnitRef, unsigned event_name_id32);
  92.     void        (*animation_trigger_event) (UnitRef unit_ref, unsigned event_name_id32, const char *optional_debug_event_name);
  93.     void        (*animation_trigger_event_with_parameters) (UnitRef unit_ref, unsigned event_name_id32, const char *optional_debug_event_name, struct AnimationEventParameters *parameters);
  95.     unsigned    (*animation_find_variable) (UnitRef, unsigned variable_name_id32, const char *optional_debug_variable_name);
  96.     int         (*animation_has_variable)(UnitRef unit_ref, unsigned variable_name_id32);
  97.     float       (*animation_get_variable) (UnitRef, unsigned index);
  98.     void        (*animation_set_variable) (UnitRef, unsigned index, float value);
  100.     void        (*animation_set_state) (UnitRef, struct AnimationStates*);
  101.     struct AnimationStates (*animation_get_state) (UnitRef);
  103.     void(*animation_set_seeds) (UnitRef, struct AnimationLayerSeeds*);
  104.     struct AnimationLayerSeeds(*animation_get_seeds) (UnitRef);
  106.     struct AnimationLayerInfo (*animation_layer_info) (UnitRef, unsigned index);
  107.     void        (*set_animation_merge_options) (UnitRef, float max_start_time, float max_drift, float clock_fidelity);
  109.     void        (*animation_set_moving)(UnitRef unit_ref, unsigned frames);
  110.     int         (*animation_get_curve_value)(UnitRef unit_ref, unsigned object_id32, unsigned parameter_id32, unsigned int float_index, float *out_curve_value);
  111.     void        (*set_animation_logging)(UnitRef unit_ref, int enable);
  113.     void        (*play_simple_animation)(UnitRef unit_ref, float from, float to, float speed, int loop, unsigned optional_group, const char *optional_debug_group_name);
  114.     void        (*stop_simple_animation)(UnitRef unit_ref, unsigned optional_group, const char *optional_debug_group_name);
  116.     unsigned    (*num_terrains) (UnitRef);
  117.     unsigned    (*find_terrain) (UnitRef, unsigned terrain_name_id32);
  118.     TerrainPtr  (*terrain) (UnitRef, unsigned index, const char *optional_debug_terrain_name);
  119.     void        (*terrain_update_height_field)(UnitRef unit_ref, void *data);
  121.     JointPtr    (*create_joint) (UnitRef, unsigned joint_name_id32, const char *optional_debug_joint_name);
  122.     void        (*destroy_joint) (UnitRef, unsigned joint_name_id32);
  123.     JointPtr    (*create_custom_joint) (UnitRef, unsigned joint_name_id32, ActorPtr optional_actor_1, ActorPtr optional_actor_2, ConstVector3Ptr optional_anchor_1,
  124.                                         ConstVector3Ptr optional_anchor_2, ConstVector3Ptr optional_global_anchor, ConstVector3Ptr optional_global_axis,
  125.                                         const char *optional_debug_joint_name);
  127.     // Length of key_id32_array depenends on the path for the property
  128.     void        (*set_property) (UnitRef unit_ref, float value, unsigned key_id32_array[]);
  129.     float       (*get_property) (UnitRef unit_ref, unsigned key_id32_array[]);
  131.     unsigned    (*num_scene_graph_items) (UnitRef);
  132.     unsigned    (*find_scene_graph_parent) (UnitRef, unsigned index);
  133.     void        (*scene_graph_link) (UnitRef, unsigned index, unsigned parent_index);
  134.     void        (*scene_graph_link_to_none) (UnitRef, unsigned index);
  135.     void        (*copy_scene_graph_local_from) (UnitRef destination, UnitRef source);
  137.     unsigned        (*num_lod_objects) (UnitRef);
  138.     unsigned        (*find_lod_object) (UnitRef, unsigned lod_name_id32);
  139.     LodObjectPtr    (*lod_object) (UnitRef, unsigned index, const char *optional_debug_lod_name);
  140.     unsigned        (*num_steps_lod) (LodObjectPtr lod_obj_ptr);
  141.     void            (*lod_step_range) (LodObjectPtr lod_obj_ptr, unsigned step_index, float out_range[2]);
  142.     unsigned        (*num_mesh_lod_step) (LodObjectPtr lod_obj_ptr, unsigned step_index);
  143.     const unsigned* (*lod_step_meshes) (LodObjectPtr lod_obj_ptr, unsigned step_index);
  145.     unsigned    (*num_lights) (UnitRef);
  146.     unsigned    (*find_light) (UnitRef, unsigned light_name_id32);
  147.     LightPtr    (*light) (UnitRef, unsigned index, const char *optional_debug_light_name);
  148.     void        (*set_light_material)(UnitRef unit_ref, LightPtr light_pointer, uint64_t material_name);
  150.     VehiclePtr  (*create_vehicle) (UnitRef);
  151.     void        (*destroy_vehicle) (UnitRef);
  152.     int         (*has_vehicle) (UnitRef);
  153.     VehiclePtr  (*vehicle) (UnitRef);
  155.     void        (*enable_physics) (UnitRef);
  156.     void        (*disable_physics) (UnitRef);
  157.     void        (*apply_initial_actor_velocities) (UnitRef, int should_wake_sleeping_actors);
  159.     void        (*set_unit_visibility) (UnitRef, int enabled);
  160.     void        (*set_mesh_visibility) (UnitRef unit_ref, unsigned index, unsigned visbility_context_id32, int enabled, const char *optional_debug_mesh_name, const char *optional_debug_visbility_context_name);
  161.     void        (*set_cloth_visibility) (UnitRef unit_ref, unsigned index, unsigned state, unsigned visbility_context_id32, const char *optional_debug_cloth_name, const char *optional_debug_visbility_context_name);
  162.     void        (*set_visibility_group) (UnitRef, unsigned group_name_id32, int enabled, const char *optional_debug_group_name);
  163.     int         (*has_visibility_group) (UnitRef, unsigned group_name_id32);
  165.     ClothPtr    (*create_cloth) (UnitRef unit_ref, unsigned index, const char *optional_debug_cloth_name);
  166.     void        (*destroy_cloth) (UnitRef unit_ref, unsigned index, const char *optional_debug_cloth_name);
  167.     unsigned    (*num_cloths) (UnitRef unit_ref);
  168.     unsigned    (*find_cloth) (UnitRef unit_ref, unsigned cloth_name_id32);
  169.     ClothPtr    (*cloth) (UnitRef unit_ref, unsigned index, const char *optional_debug_cloth_name);
  171.     unsigned    (*num_cameras) (UnitRef);
  172.     unsigned    (*find_camera) (UnitRef, unsigned camera_name_id32);
  173.     CameraPtr   (*camera) (UnitRef, unsigned index, const char *optional_debug_camera_name);
  175.     int         (*has_node) (UnitRef, unsigned node_name_id32);
  176.     unsigned    (*node) (UnitRef, unsigned node_name_id32, const char *optional_debug_node_name);
  178.     int             (*resource_has_node)(uint64_t unit_resource_id64, unsigned node_id32, const char *optional_debug_unit_resource_name);
  179.     unsigned        (*resource_node)(uint64_t unit_resource_id64, unsigned node_id32, const char *optional_debug_unit_resource_name, const char *optional_debug_node_name);
  180.     // Performance-warning; Fetches the local_pose, extracts a Matrix4x4 from it and returns a copy on the stack.
  181.     CApiMatrix4x4   (*resource_local_pose)(uint64_t unit_resource_id64, unsigned node_index, const char *optional_debug_unit_resource_name);
  183.     WorldPtr    (*world) (UnitRef);
  184.     LevelPtr    (*level) (UnitRef);
  185.     int         (*is_alive) (UnitRef);
  186.     uint64_t    (*id_in_level) (UnitRef);
  187.     int         (*is_of_resource_type) (UnitRef, uint64_t resource_name);
  188.     const char *(*unit_name_s)(UnitRef unit_ref);
  190.     struct OOBBWrapper  (*box) (UnitRef unit_ref, unsigned ignore_invisible_meshes);
  191.     const char *        (*debug_name)(UnitRef unit_ref);
  192.     void                (*name_hash)(UnitRef unit_ref, char out_name[8]);
  193.     int                 (*is_a)(UnitRef unit_ref, uint64_t resource_id64);
  194.     void                (*set_id_in_level)(UnitRef unit_ref, uint64_t id);
  195.     void                (*draw_tree)(UnitRef unit_ref);
  197.     unsigned    (*mesh_raycast)(UnitRef unit_ref, ConstVector3Ptr from, ConstVector3Ptr dir, float threshold, int include_hidden_meshes,
  198.                     float *out_distance, CApiVector3 *out_normal_world);
  199.     unsigned    (*mesh_pick_raycast)(UnitRef unit_ref, ConstVector3Ptr from, ConstVector3Ptr dir, float threshold, int include_hidden_meshes,
  200.                     float *out_distance, CApiVector3 *out_normal_world, unsigned *out_best_mesh_index, unsigned *out_best_triangle_index);
  201.     unsigned    (*mesh_closest_point_raycast)(UnitRef unit_ref, ConstVector3Ptr from, ConstVector3Ptr dir, float ray_length,
  202.                     CApiVector3 *out_best_point_world, float *out_best_point_distance_along_ray, float *out_best_point_distance_to_ray);
  203. };
  204. #ifdef __cplusplus
  205. }
  206. #endif
Please send us your comment about this page