qcsrc/common/weapons/all.qh

   1 #ifndef WEAPONS_ALL_H
   2 #define WEAPONS_ALL_H
   3
   4 #ifndef MENUQC
   5 #include "calculations.qh"
   6 #endif
   7
   8 #include "../util.qh"
   9 #ifdef SVQC
  10 #include "../../server/bot/aim.qh"
  11 #endif
  12 const int MAX_SHOT_DISTANCE = 32768;
  13
  14 // weapon pickup ratings for bot logic
  15 const int BOT_PICKUP_RATING_LOW  =  2500;
  16 const int BOT_PICKUP_RATING_MID  =  5000;
  17 const int BOT_PICKUP_RATING_HIGH = 10000;
  18
  19 // weapon flags
  20 const int WEP_TYPE_OTHER          =  0x00; // not for damaging people
  21 const int WEP_TYPE_SPLASH         =  0x01; // splash damage
  22 const int WEP_TYPE_HITSCAN        =  0x02; // hitscan
  23 const int WEP_TYPEMASK            =  0x0F;
  24 const int WEP_FLAG_CANCLIMB       =  0x10; // can be used for movement
  25 const int WEP_FLAG_NORMAL         =  0x20; // in "most weapons" set
  26 const int WEP_FLAG_HIDDEN         =  0x40; // hides from menu
  27 const int WEP_FLAG_RELOADABLE     =  0x80; // can has reload
  28 const int WEP_FLAG_SUPERWEAPON    = 0x100; // powerup timer
  29 const int WEP_FLAG_MUTATORBLOCKED = 0x200; // hides from impulse 99 etc. (mutators are allowed to clear this flag)
  30
  31 // weapon requests
  32 const int WR_SETUP          =  1; // (SERVER) setup weapon data
  33 const int WR_THINK          =  2; // (SERVER) logic to run every frame
  34 const int WR_CHECKAMMO1     =  3; // (SERVER) checks ammo for weapon primary
  35 const int WR_CHECKAMMO2     =  4; // (SERVER) checks ammo for weapon second
  36 const int WR_AIM            =  5; // (SERVER) runs bot aiming code for this weapon
  37 const int WR_INIT           =  6; // (BOTH)   precaches models/sounds used by this weapon, also sets up weapon properties
  38 const int WR_SUICIDEMESSAGE =  7; // (SERVER) notification number for suicide message (may inspect w_deathtype for details)
  39 const int WR_KILLMESSAGE    =  8; // (SERVER) notification number for kill message (may inspect w_deathtype for details)
  40 const int WR_RELOAD         =  9; // (SERVER) handles reloading for weapon
  41 const int WR_RESETPLAYER    = 10; // (SERVER) clears fields that the weapon may use
  42 const int WR_IMPACTEFFECT   = 11; // (CLIENT) impact effect for weapon explosion
  43 const int WR_PLAYERDEATH    = 12; // (SERVER) called whenever a player dies
  44 const int WR_GONETHINK      = 13; // (SERVER) logic to run when weapon is lost
  45 const int WR_CONFIG         = 14; // (ALL)    dump weapon cvars to config in data directory (see: sv_cmd dumpweapons)
  46 const int WR_ZOOMRETICLE    = 15; // (CLIENT) weapon specific zoom reticle
  47 const int WR_DROP           = 16; // (SERVER) the weapon is dropped
  48 const int WR_PICKUP         = 17; // (SERVER) a weapon is picked up
  49
  50 // variables:
  51 string weaponorder_byid;
  52
  53 // weapon sets
  54 typedef vector WepSet;
  55 WepSet WepSet_FromWeapon(int a);
  56 #ifdef SVQC
  57 void WepSet_AddStat();
  58 void WepSet_AddStat_InMap();
  59 void WriteWepSet(float dest, WepSet w);
  60 #endif
  61 #ifdef CSQC
  62 WepSet WepSet_GetFromStat();
  63 WepSet WepSet_GetFromStat_InMap();
  64 WepSet ReadWepSet();
  65 #endif
  66
  67 // weapon name macros
  68 const int WEP_FIRST = 1;
  69 #define WEP_MAXCOUNT 24 // Increase as needed. Can be up to three times as much.
  70 int WEP_COUNT;
  71 #define WEP_LAST (WEP_FIRST + WEP_COUNT - 1)
  72 WepSet WEPSET_ALL;
  73 WepSet WEPSET_SUPERWEAPONS;
  74
  75 // functions:
  76 entity get_weaponinfo(int id);
  77 string W_FixWeaponOrder(string order, float complete);
  78 string W_UndeprecateName(string s);
  79 string W_NameWeaponOrder(string order);
  80 string W_NumberWeaponOrder(string order);
  81 string W_FixWeaponOrder_BuildImpulseList(string o);
  82 string W_FixWeaponOrder_AllowIncomplete(string order);
  83 string W_FixWeaponOrder_ForceComplete(string order);
  84 void W_RandomWeapons(entity e, float n);
  85
  86 string GetAmmoPicture(.int ammotype);
  87
  88 #ifdef CSQC
  89 .int GetAmmoFieldFromNum(int i);
  90 int GetAmmoStat(.int ammotype);
  91 #endif
  92
  93 // ammo types
  94 .int ammo_shells;
  95 .int ammo_nails;
  96 .int ammo_rockets;
  97 .int ammo_cells;
  98 .int ammo_plasma;
  99 .int ammo_fuel;
 100 .int ammo_none;
 101
 102 // other useful macros
 103 #define WEP_ACTION(wpn,wrequest) (get_weaponinfo(wpn)).weapon_func(wrequest)
 104 #define WEP_AMMO(wpn) (WEP_##wpn.ammo_field) // only used inside weapon files/with direct name, don't duplicate prefix
 105 #define WEP_NAME(wpn) ((get_weaponinfo(wpn)).message)
 106
 107
 108 // ======================
 109 //  Configuration Macros
 110 // ======================
 111
 112 // create cvars for weapon settings
 113 #define WEP_ADD_CVAR_NONE(wepname,name) [[last]] float autocvar_g_balance_##wepname##_##name;
 114
 115 #define WEP_ADD_CVAR_PRI(wepname,name) WEP_ADD_CVAR_NONE(wepname, primary_##name)
 116 #define WEP_ADD_CVAR_SEC(wepname,name) WEP_ADD_CVAR_NONE(wepname, secondary_##name)
 117 #define WEP_ADD_CVAR_BOTH(wepname,name) \
 118         WEP_ADD_CVAR_PRI(wepname, name) \
 119         WEP_ADD_CVAR_SEC(wepname, name)
 120
 121 #define WEP_ADD_CVAR(wepid,wepname,mode,name) WEP_ADD_CVAR_##mode(wepname, name)
 122
 123 // create properties for weapon settings
 124 #define WEP_ADD_PROP(wepid,wepname,type,prop,name) \
 125         .type prop; \
 126         [[last]] type autocvar_g_balance_##wepname##_##name;
 127
 128 // read cvars from weapon settings
 129 #define WEP_CVAR(wepname,name) autocvar_g_balance_##wepname##_##name
 130 #define WEP_CVAR_PRI(wepname,name) WEP_CVAR(wepname, primary_##name)
 131 #define WEP_CVAR_SEC(wepname,name) WEP_CVAR(wepname, secondary_##name)
 132 #define WEP_CVAR_BOTH(wepname,isprimary,name) ((isprimary) ? WEP_CVAR_PRI(wepname, name) : WEP_CVAR_SEC(wepname, name))
 133
 134 // set initialization values for weapon settings
 135 #define WEP_SKIP_CVAR(unuseda,unusedb,unusedc,unusedd) /* skip cvars */
 136 #define WEP_SET_PROP(wepid,wepname,type,prop,name) WEP_##wepid.prop = autocvar_g_balance_##wepname##_##name;
 137
 138
 139 // =====================
 140 //  Weapon Registration
 141 // =====================
 142
 143 bool w_null(int) { return false; }
 144
 145 /** fields which are explicitly/manually set are marked with "M", fields set automatically are marked with "A" */
 146 CLASS(Weapon, Object)
 147         ATTRIB(Weapon, m_id, int, 0)
 148     /**
 149      * M: WEP_id    : WEP_...
 150      * you can recognize dummies when this == 0
 151      */
 152     ATTRIB(Weapon, weapon, int, 0);
 153     /** A: WEPSET_id : WEPSET_... */
 154     ATTRIB(Weapon, weapons, WepSet, '0 0 0');
 155     /** M: function  : w_... */
 156     ATTRIB(Weapon, weapon_func, bool(int), w_null);
 157     /** M: ammotype  : main ammo field */
 158     ATTRIB(Weapon, ammo_field, .int, ammo_none);
 159     /** M: impulse   : weapon impulse */
 160     ATTRIB(Weapon, impulse, int, -1);
 161     /** M: flags     : WEPSPAWNFLAG_... combined */
 162     ATTRIB(Weapon, spawnflags, int, 0);
 163     /** M: rating    : bot weapon priority */
 164     ATTRIB(Weapon, bot_pickupbasevalue, float, 0);
 165     /** M: color     : waypointsprite color */
 166     ATTRIB(Weapon, wpcolor, vector, '0 0 0');
 167     /** A: wpn-id    : wpn- sprite name */
 168     ATTRIB(Weapon, wpmodel, string, "");
 169     /** M: modelname : name of model (without g_ v_ or h_ prefixes) */
 170     ATTRIB(Weapon, mdl, string, "");
 171     /** A: modelname : full path to g_ model */
 172     ATTRIB(Weapon, model, string, "");
 173     /** M: simplemdl : simpleitems weapon model/image */
 174     ATTRIB(Weapon, w_simplemdl, string, "foobar");
 175     /** M: crosshair : per-weapon crosshair: "CrosshairImage Size" */
 176     ATTRIB(Weapon, w_crosshair, string, "gfx/crosshair1");
 177     /** A: crosshair : per-weapon crosshair size (argument two of "crosshair" field) */
 178     ATTRIB(Weapon, w_crosshair_size, float, 1);
 179     /** M: wepimg    : "weaponfoobar" side view image file of weapon. WEAPONTODO: Move out of skin files, move to common files */
 180     ATTRIB(Weapon, model2, string, "");
 181     /** M: refname   : reference name name */
 182     ATTRIB(Weapon, netname, string, "");
 183     /** M: wepname   : human readable name */
 184     ATTRIB(Weapon, message, string, "AOL CD Thrower");
 185
 186         METHOD(Weapon, display, void(entity this, void(string name, string icon) returns)) {
 187                 returns(this.message, this.model2 ? sprintf("/gfx/hud/%s/%s", cvar_string("menu_skin"), this.model2) : string_null);
 188         }
 189
 190         CONSTRUCTOR(Weapon,
 191                 bool(int) function,
 192                 .int ammotype,
 193                 int i,
 194                 int weapontype,
 195                 float pickupbasevalue,
 196                 vector clr,
 197                 string modelname,
 198                 string simplemdl,
 199                 string crosshair,
 200                 string wepimg,
 201                 string refname,
 202                 string wepname
 203         ) {
 204                 CONSTRUCT(Weapon);
 205                 this.weapon_func = function;
 206                 this.ammo_field = ammotype;
 207                 this.impulse = i;
 208                 this.spawnflags = weapontype;
 209                 this.bot_pickupbasevalue = pickupbasevalue;
 210                 this.wpcolor = clr;
 211                 this.mdl = modelname;
 212                 this.model = strzone(strcat("models/weapons/g_", modelname, ".md3"));
 213                 this.w_simplemdl = strzone(simplemdl); // simpleitems weapon model/image
 214                 this.w_crosshair = strzone(car(crosshair));
 215                 string s = cdr(crosshair);
 216                 this.w_crosshair_size = ((s != "") ? stof(s) : 1); // so that we can scale the crosshair from code (for compat)
 217                 this.model2 = strzone(wepimg);
 218                 this.netname = refname;
 219                 this.message = wepname;
 220         }
 221         void register_weapon(entity this, int id, WepSet bit)
 222         {
 223                 this.classname = "weapon_info";
 224                 this.weapon = id;
 225                 this.weapons = bit;
 226                 this.wpmodel = strzone(strcat("wpn-", ftos(id)));
 227                 #ifdef CSQC
 228                 this.weapon_func(WR_INIT);
 229                 #endif
 230         }
 231 ENDCLASS(Weapon)
 232
 233 void RegisterWeapons();
 234 REGISTER_REGISTRY(RegisterWeapons)
 235 entity weapon_info[WEP_MAXCOUNT], weapon_info_first, weapon_info_last;
 236 entity dummy_weapon_info;
 237
 238 #define _REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 239         WepSet WEPSET_##id; \
 240         REGISTER(RegisterWeapons, WEP, weapon_info, WEP_COUNT, id, m_id, \
 241                 NEW(Weapon, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 242         ) { \
 243                 this.m_id++; \
 244                 WEPSET_ALL |= (WEPSET_##id = WepSet_FromWeapon(this.m_id)); \
 245                 if ((flags) & WEP_FLAG_SUPERWEAPON) WEPSET_SUPERWEAPONS |= WEPSET_##id; \
 246                 register_weapon(this, this.m_id, WEPSET_##id); \
 247         }
 248
 249 #ifndef MENUQC
 250         #define REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 251         bool function(int); \
 252         _REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname)
 253 #else
 254         #define REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 255                 _REGISTER_WEAPON(id, w_null,   ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname)
 256 #endif
 257
 258 #include "all.inc"
 259
 260 #undef WEP_ADD_CVAR_MO_PRI
 261 #undef WEP_ADD_CVAR_MO_SEC
 262 #undef WEP_ADD_CVAR_MO_BOTH
 263 #undef WEP_ADD_CVAR_MO_NONE
 264 #undef WEP_ADD_CVAR
 265 #undef WEP_ADD_PROP
 266 void register_weapons_done();
 267 ACCUMULATE_FUNCTION(RegisterWeapons, register_weapons_done);
 268 #endif