entity.h

   1 #ifndef ENTITY_H
   2 #define ENTITY_H
   3
   4 #include "model.h"
   5
   6 typedef struct ent_spawn ent_spawn;
   7 typedef struct ent_light ent_light;
   8 typedef struct ent_gate ent_gate;
   9 typedef struct ent_route_node ent_route_node;
  10 typedef struct ent_path_index ent_path_index;
  11 typedef struct ent_checkpoint ent_checkpoint;
  12 typedef struct ent_route ent_route;
  13 typedef struct ent_water ent_water;
  14 typedef struct ent_audio_clip ent_audio_clip;
  15 typedef struct volume_particles volume_particles;
  16 typedef struct volume_trigger volume_trigger;
  17 typedef struct ent_volume ent_volume;
  18 typedef struct ent_audio ent_audio;
  19 typedef struct ent_marker ent_marker;
  20 typedef struct ent_traffic ent_traffic;
  21 typedef struct ent_font ent_font;
  22 typedef struct ent_font_variant ent_font_variant;
  23 typedef struct ent_glyph ent_glyph;
  24 typedef struct ent_skateshop ent_skateshop;
  25 typedef struct ent_camera ent_camera;
  26 typedef struct ent_swspreview ent_swspreview;
  27 typedef struct ent_worldinfo ent_worldinfo;
  28 typedef struct ent_ccmd ent_ccmd;
  29 typedef struct ent_objective ent_objective;
  30 typedef struct ent_challenge ent_challenge;
  31 typedef struct ent_relay ent_relay;
  32 typedef struct ent_cubemap ent_cubemap;
  33 typedef struct ent_miniworld ent_miniworld;
  34 typedef struct ent_prop ent_prop;
  35
  36 enum entity_alias{
  37    k_ent_none        = 0,
  38    k_ent_gate        = 1,
  39    k_ent_spawn       = 2,
  40    k_ent_route_node  = 3,
  41    k_ent_route       = 4,
  42    k_ent_water       = 5,
  43    k_ent_volume      = 6,
  44    k_ent_audio       = 7,
  45    k_ent_marker      = 8,
  46    k_ent_font        = 9,
  47    k_ent_font_variant= 10,
  48    k_ent_traffic     = 11,
  49    k_ent_skateshop   = 12,
  50    k_ent_camera      = 13,
  51    k_ent_swspreview  = 14,
  52    k_ent_menuitem    = 15,
  53    k_ent_worldinfo   = 16,
  54    k_ent_ccmd        = 17,
  55    k_ent_objective   = 18,
  56    k_ent_challenge   = 19,
  57    k_ent_relay       = 20,
  58    k_ent_cubemap     = 21,
  59    k_ent_miniworld   = 22
  60 };
  61
  62 static u32 mdl_entity_id_type( u32 entity_id ){
  63    return (entity_id & 0x0fff0000) >> 16;
  64 }
  65
  66 static u32 mdl_entity_id_id( u32 entity_id ){
  67    return entity_id & 0x0000ffff;
  68 }
  69
  70 static u32 mdl_entity_id( u32 type, u32 index ){
  71    return (type & 0xfffff)<<16 | (index & 0xfffff);
  72 }
  73
  74 enum entity_function{
  75    k_ent_function_trigger,
  76    k_ent_function_particle_spawn,
  77    k_ent_function_trigger_leave
  78 };
  79
  80 struct ent_spawn{
  81    mdl_transform transform;
  82    u32 pstr_name;
  83 };
  84
  85 enum light_type{
  86    k_light_type_point = 0,
  87    k_light_type_spot = 1
  88 };
  89
  90 struct ent_light{
  91    mdl_transform transform;
  92    u32 daytime,
  93        type;
  94
  95    v4f colour;
  96    float angle,
  97          range;
  98
  99    m4x3f inverse_world;
 100    v2f angle_sin_cos;
 101 };
 102
 103 /* v101 */
 104 #if 0
 105 enum gate_type{
 106    k_gate_type_unlinked = 0,
 107    k_gate_type_teleport = 1,
 108    k_gate_type_nonlocal_unlinked = 2,
 109    k_gate_type_nonlocel = 3
 110 };
 111 #endif
 112
 113 /* v102+ */
 114 enum ent_gate_flag{
 115    k_ent_gate_linked      = 0x1, /* this is a working portal */
 116    k_ent_gate_nonlocal_DELETED = 0x2, /* use the key string to link this portal.
 117                                        NOTE: if set, it adds the flip flag. */
 118    k_ent_gate_flip        = 0x4, /* flip direction 180* for exiting portal */
 119    k_ent_gate_custom_mesh = 0x8, /* use a custom submesh instead of default */
 120    k_ent_gate_locked      = 0x10,/* has to be unlocked to be useful */
 121 };
 122
 123 struct ent_gate{
 124    u32 flags,
 125        target,
 126        key;
 127
 128    v3f dimensions,
 129        co[2];
 130
 131    v4f q[2];
 132
 133    /* runtime */
 134    m4x3f to_world, transport;
 135
 136    union{
 137       u32 timing_version;
 138
 139       struct{
 140          u8 ref_count;
 141       };
 142    };
 143
 144    double timing_time;
 145    u16 routes[4];       /* routes that pass through this gate */
 146    u8 route_count;
 147
 148    /* v102+ */
 149    u32 submesh_start, submesh_count;
 150 };
 151
 152 struct ent_route_node{
 153    v3f co;
 154    u8 ref_count, ref_total;
 155 };
 156
 157 struct ent_path_index{
 158    u16 index;
 159 };
 160
 161 struct ent_checkpoint{
 162    u16 gate_index,
 163        path_start,
 164        path_count;
 165 };
 166
 167 struct ent_route{
 168    union{
 169       mdl_transform transform;
 170       u32 official_track_id;
 171    }
 172    anon;
 173
 174    u32 pstr_name;
 175    u16 checkpoints_start,
 176        checkpoints_count;
 177
 178    v4f colour;
 179
 180    /* runtime */
 181    u16 active_checkpoint,
 182        valid_checkpoints;
 183
 184    f32 factive;
 185    m4x3f board_transform;
 186    mdl_submesh sm;
 187    f64 timing_base;
 188
 189    u32 id_camera; /* v103+ */
 190 };
 191
 192 struct ent_water{
 193    mdl_transform transform;
 194    float max_dist;
 195    u32 reserved0, reserved1;
 196 };
 197
 198 struct ent_audio_clip{
 199    union{
 200       mdl_file file;
 201       audio_clip clip;
 202    }_;
 203
 204    float probability;
 205 };
 206
 207 struct volume_particles{
 208    u32 blank, blank2;
 209 };
 210
 211 struct volume_trigger{
 212    u32 event, event_leave;
 213 };
 214
 215 enum ent_volume_flag {
 216    k_ent_volume_flag_particles = 0x1,
 217    k_ent_volume_flag_disabled  = 0x2
 218 };
 219
 220 struct ent_volume{
 221    mdl_transform transform;
 222    m4x3f to_world, to_local;
 223    u32 flags;
 224
 225    u32 target;
 226    union{
 227       volume_trigger trigger;
 228       volume_particles particles;
 229    };
 230 };
 231
 232 struct ent_audio{
 233    mdl_transform transform;
 234    u32 flags,
 235        clip_start,
 236        clip_count;
 237    float volume, crossfade;
 238    u32 behaviour,
 239        group,
 240        probability_curve,
 241        max_channels;
 242 };
 243
 244 struct ent_marker{
 245    mdl_transform transform;
 246    u32 pstr_alias;
 247 };
 248
 249 enum skateshop_type{
 250    k_skateshop_type_boardshop,
 251    k_skateshop_type_charshop,
 252    k_skateshop_type_worldshop,
 253 };
 254
 255 struct ent_skateshop{
 256    mdl_transform transform;
 257    u32 type, id_camera;
 258
 259    union{
 260       struct{
 261          u32 id_display,
 262              id_info,
 263              id_rack;
 264       }
 265       boards;
 266
 267       struct{
 268          u32 id_display,
 269              id_info;
 270       }
 271       character;
 272
 273       struct{
 274          u32 id_display,
 275              id_info;
 276       }
 277       worlds;
 278    };
 279 };
 280
 281 struct ent_swspreview{
 282    u32 id_camera, id_display, id_display1;
 283 };
 284
 285 struct ent_traffic{
 286    mdl_transform transform;
 287    u32 submesh_start,
 288        submesh_count,
 289        start_node,
 290        node_count;
 291    float speed,
 292          t;
 293    u32 index;     /* into the path */
 294 };
 295
 296 struct ent_camera{
 297    mdl_transform transform;
 298    float fov;
 299 };
 300
 301 enum ent_menuitem_type{
 302    k_ent_menuitem_type_visual       = 0,
 303    k_ent_menuitem_type_event_button = 1,
 304    k_ent_menuitem_type_page_button  = 2,
 305    k_ent_menuitem_type_toggle       = 3,
 306    k_ent_menuitem_type_slider       = 4,
 307    k_ent_menuitem_type_page         = 5,
 308    k_ent_menuitem_type_binding      = 6,
 309    k_ent_menuitem_type_visual_nocol = 7,
 310    k_ent_menuitem_type_disabled     = 90
 311 };
 312
 313 enum ent_menuitem_stack_behaviour{
 314    k_ent_menuitem_stack_append  = 0,
 315    k_ent_menuitem_stack_replace = 1
 316 };
 317
 318 typedef struct ent_menuitem ent_menuitem;
 319 struct ent_menuitem{
 320    u32 type, groups,
 321        id_links[4];  /* ent_menuitem */
 322    f32 factive, fvisible;
 323
 324    mdl_transform transform;
 325    u32 submesh_start, submesh_count;
 326
 327    union{ u64 _u64;  /* force storage for 64bit pointers */
 328           i32 *pi32;
 329           f32 *pf32;
 330           void *pvoid;
 331    };
 332
 333    union{
 334       struct{
 335          u32 pstr_name;
 336       }
 337       visual;
 338
 339       struct{
 340          u32 id_min,    /* ent_marker */
 341              id_max,    /* . */
 342              id_handle, /* ent_menuitem */
 343              pstr_data;
 344       }
 345       slider;
 346
 347       struct{
 348          u32 pstr,
 349              stack_behaviour;
 350       }
 351       button;
 352
 353       struct{
 354          u32 id_check, /* ent_menuitem */
 355              pstr_data;
 356          v3f offset; /* relative to parent */
 357       }
 358       checkmark;
 359
 360       struct{
 361          u32 pstr_name,
 362              id_entrypoint,  /* ent_menuitem */
 363              id_viewpoint;   /* ent_camera */
 364       }
 365       page;
 366
 367       struct{
 368          u32 pstr_bind,
 369              font_variant;
 370       }
 371       binding;
 372    };
 373 };
 374
 375 struct ent_worldinfo{
 376    u32 pstr_name, pstr_author, pstr_desc;
 377    f32 timezone;
 378    u32 pstr_skybox;
 379 };
 380
 381 static ent_marker *ent_find_marker( mdl_context *mdl,
 382                                        mdl_array_ptr *arr, const char *alias )
 383 {
 384    for( u32 i=0; i<mdl_arrcount(arr); i++ ){
 385       ent_marker *marker = mdl_arritm( arr, i );
 386
 387       if( !strcmp( mdl_pstr( mdl, marker->pstr_alias ), alias ) ){
 388          return marker;
 389       }
 390    }
 391
 392    return NULL;
 393 }
 394
 395 enum channel_behaviour{
 396    k_channel_behaviour_unlimited = 0,
 397    k_channel_behaviour_discard_if_full = 1,
 398    k_channel_behaviour_crossfade_if_full = 2
 399 };
 400
 401 enum probability_curve{
 402    k_probability_curve_constant = 0,
 403    k_probability_curve_wildlife_day = 1,
 404    k_probability_curve_wildlife_night = 2
 405 };
 406
 407 struct ent_font{
 408    u32 alias,
 409        variant_start,
 410        variant_count,
 411        glyph_start,
 412        glyph_count,
 413        glyph_utf32_base;
 414 };
 415
 416 struct ent_font_variant{
 417    u32 name,
 418        material_id;
 419 };
 420
 421 struct ent_glyph{
 422    v2f size;
 423    u32 indice_start,
 424        indice_count;
 425 };
 426
 427 struct ent_ccmd{
 428    u32 pstr_command;
 429 };
 430
 431 enum ent_objective_filter{
 432    k_ent_objective_filter_none            = 0x00000000,
 433    k_ent_objective_filter_trick_shuvit    = 0x00000001,
 434    k_ent_objective_filter_trick_kickflip  = 0x00000002,
 435    k_ent_objective_filter_trick_treflip   = 0x00000004,
 436    k_ent_objective_filter_trick_any       =
 437       k_ent_objective_filter_trick_shuvit|
 438       k_ent_objective_filter_trick_treflip|
 439       k_ent_objective_filter_trick_kickflip,
 440    k_ent_objective_filter_flip_back       = 0x00000008,
 441    k_ent_objective_filter_flip_front      = 0x00000010,
 442    k_ent_objective_filter_flip_any        =
 443       k_ent_objective_filter_flip_back|
 444       k_ent_objective_filter_flip_front,
 445    k_ent_objective_filter_grind_truck_any = 0x00000020,
 446    k_ent_objective_filter_grind_board_any = 0x00000040,
 447    k_ent_objective_filter_grind_any       =
 448       k_ent_objective_filter_grind_truck_any|
 449       k_ent_objective_filter_grind_board_any,
 450    k_ent_objective_filter_footplant       = 0x00000080,
 451    k_ent_objective_filter_passthrough     = 0x00000100
 452 };
 453
 454 enum ent_objective_flag {
 455    k_ent_objective_hidden = 0x1,
 456    k_ent_objective_passed = 0x2
 457 };
 458
 459 struct ent_objective{
 460    mdl_transform transform;
 461    u32 submesh_start,
 462        submesh_count,
 463        flags,
 464        id_next,
 465        filter,filter2,
 466        id_win,
 467        win_event;
 468    f32 time_limit;
 469 };
 470
 471 enum ent_challenge_flag {
 472    k_ent_challenge_timelimit = 0x1
 473 };
 474
 475 struct ent_challenge{
 476    mdl_transform transform;
 477    u32 pstr_alias,
 478        flags,
 479        target,
 480        target_event,
 481        reset,
 482        reset_event,
 483        first,
 484        camera,
 485        status;
 486 };
 487
 488 struct ent_relay {
 489    u32 targets[4][2];
 490 };
 491
 492 struct ent_cubemap {
 493    v3f co;
 494    u32 resolution, live, texture_id,
 495        framebuffer_id, renderbuffer_id, placeholder[2];
 496 };
 497
 498 typedef struct ent_call ent_call;
 499 struct ent_call{
 500    u32 id, function;
 501    void *data;
 502 };
 503
 504 struct ent_miniworld {
 505    mdl_transform transform;
 506    u32 pstr_world;
 507
 508    i32 purpose_DELTED;
 509    u32 proxy;
 510 };
 511
 512 struct ent_prop {
 513    mdl_transform transform;
 514    u32 submesh_start, submesh_count, flags;
 515 };
 516
 517 #include "world.h"
 518 static void entity_call( world_instance *world, ent_call *call );
 519
 520 #endif /* ENTITY_H */