]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/common/items/item.qh
a4fea71ad8ec73842ebbe946d377a8b88a4e2a61
[xonotic/xonotic-data.pk3dir.git] / 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
61 // item bboxes for sv_legacy_bbox_expand 0
62 // Small, Default and Large (large maxs are used with default mins)
63 const vector ITEM_S_MINS = '-16 -16 0'; // smaller items now get the same "unexpanded" bbox that normal items
64 const vector ITEM_S_MAXS = '16 16 48';  // had during MoveOutOfSolid and DropToFloor (before expansion) in 0.8.5
65 const vector ITEM_D_MINS = '-30 -30 0'; // 0.8.5 set '-16 -16 0' then DP subtracted '15 15 1' but NetRadiant used '-30 -30 0'
66 const vector ITEM_D_MAXS = '30 30 48';  // 0.8.5 set '16 16 48' then DP added '15 15 1' but NetRadiant used '30 30 32'
67 const vector ITEM_L_MAXS = '30 30 70';  // 0.8.5 set '16 16 80' for powerups, '16 16 70' for megas, '16 16 60' for buffs
68
69 .float fade_start;
70 .float fade_end;
71
72 .string mdl;
73 #endif
74
75 #ifdef SVQC
76 .float strength_finished; // NOTE: this field is used only by map entities, it does not directly apply the strength stat
77 .float invincible_finished; // ditto
78 .float buffs_finished; // ditts
79
80 #define SPAWNFUNC_BODY(item) \
81         if (item && Item_IsDefinitionAllowed(item)) \
82                 StartItem(this, item); \
83         else \
84         { \
85                 startitem_failed = true; \
86                 delete(this); \
87         }
88
89 #define SPAWNFUNC_ITEM(name, item) \
90         spawnfunc(name) \
91         { \
92                 SPAWNFUNC_BODY(item) \
93         }
94
95 #define SPAWNFUNC_ITEM_COND(name, cond, item1, item2) \
96         SPAWNFUNC_ITEM(name, (cond ? item1 : item2))
97
98 #else
99
100 #define SPAWNFUNC_ITEM(name, item)
101
102 #endif
103
104 enum
105 {
106         ITEM_FLAG_NORMAL = BIT(0), ///< Item is usable during normal gameplay.
107         ITEM_FLAG_MUTATORBLOCKED = BIT(1),
108         ITEM_FLAG_RESOURCE = BIT(2) ///< Item is is a resource, not a held item.
109 };
110
111 #define ITEM_HANDLE(signal, ...) __Item_Send_##signal(__VA_ARGS__)
112 CLASS(GameItem, Object)
113     ATTRIB(GameItem, m_id, int, 0);
114     /** the canonical spawnfunc name */
115     ATTRIB(GameItem, m_canonical_spawnfunc, string);
116     METHOD(GameItem, m_spawnfunc_hookreplace, GameItem(GameItem this, entity e)) { return this; }
117     ATTRIB(GameItem, m_name, string);
118     ATTRIB(GameItem, m_icon, string);
119     ATTRIB(GameItem, m_color, vector, '1 1 1');
120     ATTRIB(GameItem, m_waypoint, string);
121     ATTRIB(GameItem, m_waypointblink, int, 1);
122 #ifdef GAMEQC
123     ATTRIB(GameItem, m_glow, bool, false);
124     ATTRIB(GameItem, m_respawnsound, Sound, SND_ITEMRESPAWN);
125 #endif
126     METHOD(GameItem, display, void(GameItem this, void(string name, string icon) returns))
127     {
128         TC(GameItem, this);
129         returns(this.m_name, this.m_icon ? sprintf("/gfx/hud/%s/%s", cvar_string("menu_skin"), this.m_icon) : string_null);
130     }
131     METHOD(GameItem, show, void(GameItem this))
132     {
133         TC(GameItem, this);
134         LOG_INFO("A game item");
135     }
136     void ITEM_HANDLE(Show, GameItem this) { this.show(this); }
137 ENDCLASS(GameItem)