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 string W_Sound(string w_snd);
  94 string W_Model(string w_mdl);
  95
  96 // ammo types
  97 .int ammo_shells;
  98 .int ammo_nails;
  99 .int ammo_rockets;
 100 .int ammo_cells;
 101 .int ammo_plasma;
 102 .int ammo_fuel;
 103 .int ammo_none;
 104
 105 // other useful macros
 106 #define WEP_ACTION(wpn,wrequest) (get_weaponinfo(wpn)).weapon_func(wrequest)
 107 #define WEP_AMMO(wpn) (WEP_##wpn.ammo_field) // only used inside weapon files/with direct name, don't duplicate prefix
 108 #define WEP_NAME(wpn) ((get_weaponinfo(wpn)).message)
 109
 110
 111 // ======================
 112 //  Configuration Macros
 113 // ======================
 114
 115 // create cvars for weapon settings
 116 #define WEP_ADD_CVAR_NONE(wepname,name) [[last]] float autocvar_g_balance_##wepname##_##name;
 117
 118 #define WEP_ADD_CVAR_PRI(wepname,name) WEP_ADD_CVAR_NONE(wepname, primary_##name)
 119 #define WEP_ADD_CVAR_SEC(wepname,name) WEP_ADD_CVAR_NONE(wepname, secondary_##name)
 120 #define WEP_ADD_CVAR_BOTH(wepname,name) \
 121         WEP_ADD_CVAR_PRI(wepname, name) \
 122         WEP_ADD_CVAR_SEC(wepname, name)
 123
 124 #define WEP_ADD_CVAR(wepid,wepname,mode,name) WEP_ADD_CVAR_##mode(wepname, name)
 125
 126 // create properties for weapon settings
 127 #define WEP_ADD_PROP(wepid,wepname,type,prop,name) \
 128         .type prop; \
 129         [[last]] type autocvar_g_balance_##wepname##_##name;
 130
 131 // read cvars from weapon settings
 132 #define WEP_CVAR(wepname,name) autocvar_g_balance_##wepname##_##name
 133 #define WEP_CVAR_PRI(wepname,name) WEP_CVAR(wepname, primary_##name)
 134 #define WEP_CVAR_SEC(wepname,name) WEP_CVAR(wepname, secondary_##name)
 135 #define WEP_CVAR_BOTH(wepname,isprimary,name) ((isprimary) ? WEP_CVAR_PRI(wepname, name) : WEP_CVAR_SEC(wepname, name))
 136
 137 // set initialization values for weapon settings
 138 #define WEP_SKIP_CVAR(unuseda,unusedb,unusedc,unusedd) /* skip cvars */
 139 #define WEP_SET_PROP(wepid,wepname,type,prop,name) WEP_##wepid.prop = autocvar_g_balance_##wepname##_##name;
 140
 141
 142 // =====================
 143 //  Weapon Registration
 144 // =====================
 145
 146 bool w_null(int) { return false; }
 147
 148 /** fields which are explicitly/manually set are marked with "M", fields set automatically are marked with "A" */
 149 CLASS(Weapon, Object)
 150         ATTRIB(Weapon, m_id, int, 0)
 151     /**
 152      * M: WEP_id    : WEP_...
 153      * you can recognize dummies when this == 0
 154      */
 155     ATTRIB(Weapon, weapon, int, 0);
 156     /** A: WEPSET_id : WEPSET_... */
 157     ATTRIB(Weapon, weapons, WepSet, '0 0 0');
 158     /** M: function  : w_... */
 159     ATTRIB(Weapon, weapon_func, bool(int), w_null);
 160     /** M: ammotype  : main ammo field */
 161     ATTRIB(Weapon, ammo_field, .int, ammo_none);
 162     /** M: impulse   : weapon impulse */
 163     ATTRIB(Weapon, impulse, int, -1);
 164     /** M: flags     : WEPSPAWNFLAG_... combined */
 165     ATTRIB(Weapon, spawnflags, int, 0);
 166     /** M: rating    : bot weapon priority */
 167     ATTRIB(Weapon, bot_pickupbasevalue, float, 0);
 168     /** M: color     : waypointsprite color */
 169     ATTRIB(Weapon, wpcolor, vector, '0 0 0');
 170     /** A: wpn-id    : wpn- sprite name */
 171     ATTRIB(Weapon, wpmodel, string, "");
 172     /** M: modelname : name of model (without g_ v_ or h_ prefixes) */
 173     ATTRIB(Weapon, mdl, string, "");
 174     /** A: modelname : full path to g_ model */
 175     ATTRIB(Weapon, model, string, "");
 176     /** M: simplemdl : simpleitems weapon model/image */
 177     ATTRIB(Weapon, w_simplemdl, string, "foobar");
 178     /** M: crosshair : per-weapon crosshair: "CrosshairImage Size" */
 179     ATTRIB(Weapon, w_crosshair, string, "gfx/crosshair1");
 180     /** A: crosshair : per-weapon crosshair size (argument two of "crosshair" field) */
 181     ATTRIB(Weapon, w_crosshair_size, float, 1);
 182     /** M: wepimg    : "weaponfoobar" side view image file of weapon. WEAPONTODO: Move out of skin files, move to common files */
 183     ATTRIB(Weapon, model2, string, "");
 184     /** M: refname   : reference name name */
 185     ATTRIB(Weapon, netname, string, "");
 186     /** M: wepname   : human readable name */
 187     ATTRIB(Weapon, message, string, "AOL CD Thrower");
 188
 189         METHOD(Weapon, display, void(entity this, void(string name, string icon) returns)) {
 190                 returns(this.message, this.model2 ? sprintf("/gfx/hud/%s/%s", cvar_string("menu_skin"), this.model2) : string_null);
 191         }
 192
 193         CONSTRUCTOR(Weapon,
 194                 bool(int) function,
 195                 .int ammotype,
 196                 int i,
 197                 int weapontype,
 198                 float pickupbasevalue,
 199                 vector clr,
 200                 string modelname,
 201                 string simplemdl,
 202                 string crosshair,
 203                 string wepimg,
 204                 string refname,
 205                 string wepname
 206         ) {
 207                 CONSTRUCT(Weapon);
 208                 this.weapon_func = function;
 209                 this.ammo_field = ammotype;
 210                 this.impulse = i;
 211                 this.spawnflags = weapontype;
 212                 this.bot_pickupbasevalue = pickupbasevalue;
 213                 this.wpcolor = clr;
 214                 this.mdl = modelname;
 215                 this.model = strzone(W_Model(strcat("g_", modelname, ".md3")));
 216                 this.w_simplemdl = strzone(simplemdl); // simpleitems weapon model/image
 217                 this.w_crosshair = strzone(car(crosshair));
 218                 string s = cdr(crosshair);
 219                 this.w_crosshair_size = ((s != "") ? stof(s) : 1); // so that we can scale the crosshair from code (for compat)
 220                 this.model2 = strzone(wepimg);
 221                 this.netname = refname;
 222                 this.message = wepname;
 223         }
 224         void register_weapon(entity this, int id, WepSet bit)
 225         {
 226                 this.classname = "weapon_info";
 227                 this.weapon = id;
 228                 this.weapons = bit;
 229                 this.wpmodel = strzone(strcat("wpn-", ftos(id)));
 230                 #ifdef CSQC
 231                 this.weapon_func(WR_INIT);
 232                 #endif
 233         }
 234 ENDCLASS(Weapon)
 235
 236 void RegisterWeapons();
 237 REGISTER_REGISTRY(RegisterWeapons)
 238 entity weapon_info[WEP_MAXCOUNT], weapon_info_first, weapon_info_last;
 239 entity dummy_weapon_info;
 240
 241 #define _REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 242         WepSet WEPSET_##id; \
 243         REGISTER(RegisterWeapons, WEP, weapon_info, WEP_COUNT, id, m_id, \
 244                 NEW(Weapon, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 245         ) { \
 246                 this.m_id++; \
 247                 WEPSET_ALL |= (WEPSET_##id = WepSet_FromWeapon(this.m_id)); \
 248                 if ((flags) & WEP_FLAG_SUPERWEAPON) WEPSET_SUPERWEAPONS |= WEPSET_##id; \
 249                 register_weapon(this, this.m_id, WEPSET_##id); \
 250         }
 251
 252 #ifndef MENUQC
 253         #define REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 254         bool function(int); \
 255         _REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname)
 256 #else
 257         #define REGISTER_WEAPON(id, function, ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname) \
 258                 _REGISTER_WEAPON(id, w_null,   ammotype, impulse, flags, rating, color, modelname, simplemdl, crosshair, wepimg, refname, wepname)
 259 #endif
 260
 261 #include "all.inc"
 262
 263 #undef WEP_ADD_CVAR_MO_PRI
 264 #undef WEP_ADD_CVAR_MO_SEC
 265 #undef WEP_ADD_CVAR_MO_BOTH
 266 #undef WEP_ADD_CVAR_MO_NONE
 267 #undef WEP_ADD_CVAR
 268 #undef WEP_ADD_PROP
 269 void register_weapons_done();
 270 ACCUMULATE_FUNCTION(RegisterWeapons, register_weapons_done);
 271 #endif