Label some field pointers with the const attribute
[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.qh>
12 #endif
13
14 const int IT_UNLIMITED_WEAPON_AMMO              =  BIT(0); // when this bit is set, using a weapon does not reduce ammo. Checkpoints can give this powerup.
15 const int IT_UNLIMITED_SUPERWEAPONS             =  BIT(1); // when this bit is set, superweapons don't expire. Checkpoints can give this powerup.
16
17 const int IT_JETPACK                            =  BIT(2); // actual item
18 const int IT_USING_JETPACK                      =  BIT(3); // confirmation that button is pressed
19 const int IT_FUEL_REGEN                         =  BIT(4); // fuel regeneration trigger
20
21 const int IT_FUEL                                       =  BIT(5);
22 const int IT_SHELLS                     =  BIT(6);
23 const int IT_NAILS                      =  BIT(7);
24 const int IT_ROCKETS                    =  BIT(8);
25 const int IT_CELLS                      =  BIT(9);
26 const int IT_PLASMA                                     = BIT(10);
27
28 const int IT_5HP                        = BIT(11);
29 const int IT_25HP                       = BIT(12);
30 const int IT_HEALTH                                     = BIT(13);
31
32 const int IT_ARMOR_SHARD                = BIT(14);
33 const int IT_ARMOR                      = BIT(15);
34
35 const int IT_KEY1                                               = BIT(16);
36 const int IT_KEY2                                               = BIT(17);
37
38 const int IT_CTF_SHIELDED                       = BIT(18); // set for the flag shield
39
40 // special colorblend meaning in engine
41 const int IT_INVISIBILITY                               = BIT(19);
42 const int IT_INVINCIBLE                                 = BIT(20);
43 const int IT_SUPERWEAPON                                = BIT(21); // suit
44 const int IT_STRENGTH                                   = BIT(22);
45
46 // item masks
47 const int IT_UNLIMITED_AMMO             = IT_UNLIMITED_WEAPON_AMMO | IT_UNLIMITED_SUPERWEAPONS;
48 const int IT_PICKUPMASK                 = IT_UNLIMITED_AMMO | IT_JETPACK | IT_FUEL_REGEN; // strength and invincible are handled separately
49
50 #ifdef SVQC
51 const .float strength_finished = _STAT(STRENGTH_FINISHED);
52 const .float invincible_finished = _STAT(INVINCIBLE_FINISHED);
53
54 #define spawnfunc_body(item) \
55         if (!Item_IsDefinitionAllowed(item)) \
56         { \
57                 startitem_failed = true; \
58                 delete(this); \
59                 return; \
60         } \
61         StartItem(this, item)
62
63 #define SPAWNFUNC_ITEM(name, item) \
64         spawnfunc(name) \
65         { \
66                 spawnfunc_body(item); \
67         }
68
69 #define SPAWNFUNC_ITEM_COND(name, cond, item1, item2) \
70         spawnfunc(name) \
71         { \
72                 entity item = (cond) ? item1 : item2; \
73                 spawnfunc_body(item); \
74         }
75
76 #else
77
78 #define SPAWNFUNC_ITEM(name, item)
79
80 #endif
81
82 enum
83 {
84         ITEM_FLAG_NORMAL = BIT(0), ///< Item is usable during normal gameplay.
85         ITEM_FLAG_MUTATORBLOCKED = BIT(1),
86         ITEM_FLAG_RESOURCE = BIT(2) ///< Item is is a resource, not a held item.
87 };
88
89 #define ITEM_HANDLE(signal, ...) __Item_Send_##signal(__VA_ARGS__)
90 CLASS(GameItem, Object)
91     ATTRIB(GameItem, m_id, int, 0);
92     /** the canonical spawnfunc name */
93     ATTRIB(GameItem, m_canonical_spawnfunc, string);
94     METHOD(GameItem, m_spawnfunc_hookreplace, GameItem(GameItem this, entity e)) { return this; }
95     ATTRIB(GameItem, m_name, string);
96     ATTRIB(GameItem, m_icon, string);
97     ATTRIB(GameItem, m_color, vector, '1 1 1');
98     ATTRIB(GameItem, m_waypoint, string);
99     ATTRIB(GameItem, m_waypointblink, int, 1);
100 #ifdef GAMEQC
101     ATTRIB(GameItem, m_glow, bool, false);
102     ATTRIB(GameItem, m_respawnsound, Sound, SND_ITEMRESPAWN);
103 #endif
104     METHOD(GameItem, display, void(GameItem this, void(string name, string icon) returns))
105     {
106         TC(GameItem, this);
107         returns(this.m_name, this.m_icon ? sprintf("/gfx/hud/%s/%s", cvar_string("menu_skin"), this.m_icon) : string_null);
108     }
109     METHOD(GameItem, show, void(GameItem this))
110     {
111         TC(GameItem, this);
112         LOG_INFO("A game item");
113     }
114     void ITEM_HANDLE(Show, GameItem this) { this.show(this); }
115 ENDCLASS(GameItem)