qcsrc/common/items/item.qh

   1 #pragma once
   2
   3 #ifdef GAMEQC
   4 #include <common/models/all.qh>
   5 #include <common/sounds/all.qh>
   6 #include <common/sounds/all.inc>
   7 #include <common/stats.qh>
   8 #endif
   9
  10 #ifdef SVQC
  11 #include <server/items/spawning.qh>
  12 #endif
  13
  14 #ifdef GAMEQC
  15 const int IT_UNLIMITED_AMMO                     =  BIT(0); // when this bit is set, using a weapon does not reduce ammo. Checkpoints can give this powerup.
  16 const int IT_UNLIMITED_SUPERWEAPONS             =  BIT(1); // when this bit is set, superweapons don't expire. Checkpoints can give this powerup.
  17
  18 const int IT_JETPACK                            =  BIT(2); // actual item
  19 const int IT_USING_JETPACK                      =  BIT(3); // confirmation that button is pressed
  20 const int IT_FUEL_REGEN                         =  BIT(4); // fuel regeneration trigger
  21
  22 const int IT_RESOURCE                           =  BIT(5); // bitflag to mark this item as a resource (unused)
  23
  24 const int IT_KEY1                                               = BIT(6);
  25 const int IT_KEY2                                               = BIT(7);
  26
  27 const int IT_BUFF                                               = BIT(8); // unused bit for buff items
  28
  29 // special colorblend meaning in engine
  30 // legacy bitflags for powerups
  31 const int IT_INVISIBILITY                               = BIT(9);
  32 const int IT_INVINCIBLE                                 = BIT(10);
  33 const int IT_SUPERWEAPON                                = BIT(11); // suit
  34 const int IT_STRENGTH                                   = BIT(12);
  35 const int IT_SPEED                                              = BIT(13);
  36
  37 // item masks
  38 const int IT_PICKUPMASK                 = IT_UNLIMITED_AMMO | IT_UNLIMITED_SUPERWEAPONS | IT_JETPACK | IT_FUEL_REGEN; // strength and invincible are handled separately
  39
  40 // item networking
  41 const int ISF_LOCATION          = BIT(1);
  42 const int ISF_MODEL             = BIT(2);
  43 const int ISF_STATUS            = BIT(3);
  44 const int ISF_COLORMAP          = BIT(4);
  45 const int ISF_DROP              = BIT(5);
  46 const int ISF_ANGLES            = BIT(6);
  47 const int ISF_SIZE              = BIT(7);
  48
  49 REGISTER_NET_LINKED(ENT_CLIENT_ITEM)
  50
  51 // item status
  52 .int ItemStatus;
  53 const int ITS_STAYWEP           = BIT(0);
  54 const int ITS_ANIMATE1          = BIT(1);
  55 const int ITS_ANIMATE2          = BIT(2);
  56 const int ITS_AVAILABLE         = BIT(3);
  57 const int ITS_ALLOWFB           = BIT(4);
  58 const int ITS_ALLOWSI           = BIT(5);
  59 const int ITS_GLOW              = BIT(6);
  60 const int ITS_EXPIRING          = BIT(7);
  61
  62 // enough to notice it's about to despawn and circle jump to grab it
  63 const float IT_DESPAWNFX_TIME = 1.5;
  64
  65 // 2hz probably enough to correct a desync caused by serious lag
  66 const float IT_UPDATE_INTERVAL = 0.5;
  67
  68 .float fade_start;
  69 .float fade_end;
  70
  71 .string mdl;
  72 #endif
  73
  74 #ifdef SVQC
  75 .float strength_finished; // NOTE: this field is used only by map entities, it does not directly apply the strength stat
  76 .float invincible_finished; // ditto
  77 .float buffs_finished; // ditts
  78
  79 #define SPAWNFUNC_BODY(item) \
  80         if (item && Item_IsDefinitionAllowed(item)) \
  81                 StartItem(this, item); \
  82         else \
  83         { \
  84                 startitem_failed = true; \
  85                 delete(this); \
  86         }
  87
  88 #define SPAWNFUNC_ITEM(name, item) \
  89         spawnfunc(name) \
  90         { \
  91                 SPAWNFUNC_BODY(item) \
  92         }
  93
  94 #define SPAWNFUNC_ITEM_COND(name, cond, item1, item2) \
  95         SPAWNFUNC_ITEM(name, (cond ? item1 : item2))
  96
  97 #else
  98
  99 #define SPAWNFUNC_ITEM(name, item)
 100
 101 #endif
 102
 103 enum
 104 {
 105         ITEM_FLAG_NORMAL = BIT(0), ///< Item is usable during normal gameplay.
 106         ITEM_FLAG_MUTATORBLOCKED = BIT(1),
 107         ITEM_FLAG_RESOURCE = BIT(2) ///< Item is is a resource, not a held item.
 108 };
 109
 110 #define ITEM_HANDLE(signal, ...) __Item_Send_##signal(__VA_ARGS__)
 111 CLASS(GameItem, Object)
 112     ATTRIB(GameItem, m_id, int, 0);
 113     /** the canonical spawnfunc name */
 114     ATTRIB(GameItem, m_canonical_spawnfunc, string);
 115     METHOD(GameItem, m_spawnfunc_hookreplace, GameItem(GameItem this, entity e)) { return this; }
 116     ATTRIB(GameItem, m_name, string);
 117     ATTRIB(GameItem, m_icon, string);
 118     ATTRIB(GameItem, m_color, vector, '1 1 1');
 119     ATTRIB(GameItem, m_waypoint, string);
 120     ATTRIB(GameItem, m_waypointblink, int, 1);
 121 #ifdef GAMEQC
 122     ATTRIB(GameItem, m_glow, bool, false);
 123     ATTRIB(GameItem, m_respawnsound, Sound, SND_ITEMRESPAWN);
 124 #endif
 125     METHOD(GameItem, display, void(GameItem this, void(string name, string icon) returns))
 126     {
 127         TC(GameItem, this);
 128         returns(this.m_name, this.m_icon ? sprintf("/gfx/hud/%s/%s", cvar_string("menu_skin"), this.m_icon) : string_null);
 129     }
 130     METHOD(GameItem, show, void(GameItem this))
 131     {
 132         TC(GameItem, this);
 133         LOG_INFO("A game item");
 134     }
 135     void ITEM_HANDLE(Show, GameItem this) { this.show(this); }
 136 ENDCLASS(GameItem)