(untested) make rain and snow client side entities
[divverent/nexuiz.git] / data / qcsrc / common / constants.qh
1 // COMMIT-TODO: Update if necessary before committing
2 // Revision 1: additional statistics sent (flag caps, returns, deaths)
3 // Revision 2: Mapvote preview pictures
4 // Revision 3: optimized map vote protocol
5 // Revision 4: CSQC config var system
6 // Revision 5: mapvote time fix
7 // Revision 6: more robust against packet loss/delays, also show not yet connected clients
8 // Revision 7: packet loss column
9 // Revision 8: race
10 // Revision 9: race delta
11 // Revision 10: scoreboard force
12 // Revision 11: scoreboard unforce; spectator support beginning
13 // Revision 12: smaller scores updates (SERVER: requires new engine)
14 // Revision 12: pointparticles
15 #define CSQC_REVISION 13
16
17 // probably put these in common/
18 // so server/ and client/ can be synced better
19 const float GAME_DEATHMATCH             = 1;
20 const float GAME_TEAM_DEATHMATCH        = 2;
21 const float GAME_DOMINATION             = 3;
22 const float GAME_CTF                    = 4;
23 const float GAME_RUNEMATCH              = 5;
24 const float GAME_LMS                    = 6;
25 const float GAME_ARENA          = 7;
26 const float GAME_KEYHUNT                = 8;
27 const float GAME_ASSAULT                = 9;
28 const float GAME_ONSLAUGHT      = 10;
29 const float GAME_RACE   = 11;
30
31 const float AS_STRING           = 1;
32 const float AS_INT              = 2;
33 const float AS_FLOAT_TRUNCATED  = 2;
34 const float AS_FLOAT            = 8;
35
36 const float ENT_CLIENT = 0;
37 const float ENT_CLIENT_DEAD = 1;
38 const float ENT_CLIENT_ENTCS = 2;
39 const float ENT_CLIENT_SCORES_INFO = 3;
40 const float ENT_CLIENT_SCORES = 4;
41 const float ENT_CLIENT_TEAMSCORES = 5;
42 const float ENT_CLIENT_POINTPARTICLES = 6;
43 const float ENT_CLIENT_RAINSNOW = 7;
44
45 ///////////////////////////
46 // key constants
47
48 //
49 // these are the key numbers that should be passed to Key_Event
50 //
51 const float K_TAB                       =       9;
52 const float K_ENTER             =       13;
53 const float K_ESCAPE            =       27;
54 const float K_SPACE             =       32;
55
56 // normal keys should be passed as lowercased ascii
57
58 const float K_BACKSPACE =       127;
59 const float K_UPARROW           =       128;
60 const float K_DOWNARROW =       129;
61 const float K_LEFTARROW =       130;
62 const float K_RIGHTARROW        =       131;
63
64 const float K_ALT               =       132;
65 const float K_CTRL      =       133;
66 const float K_SHIFT     =       134;
67 const float K_F1                =       135;
68 const float K_F2                =       136;
69 const float K_F3                =       137;
70 const float K_F4                =       138;
71 const float K_F5                =       139;
72 const float K_F6                =       140;
73 const float K_F7                =       141;
74 const float K_F8                =       142;
75 const float K_F9                =       143;
76 const float K_F10               =       144;
77 const float K_F11               =       145;
78 const float K_F12               =       146;
79 const float K_INS               =       147;
80 const float K_DEL               =       148;
81 const float K_PGDN      =       149;
82 const float K_PGUP      =       150;
83 const float K_HOME      =       151;
84 const float K_END               =       152;
85
86 const float K_KP_HOME                   =       160;
87 const float K_KP_UPARROW                =       161;
88 const float K_KP_PGUP                   =       162;
89 const float K_KP_LEFTARROW      =       163;
90 const float K_KP_5                      =       164;
91 const float K_KP_RIGHTARROW     =       165;
92 const float K_KP_END                    =       166;
93 const float K_KP_DOWNARROW      =       167;
94 const float K_KP_PGDN                   =       168;
95 const float K_KP_ENTER          =       169;
96 const float K_KP_INS            =       170;
97 const float K_KP_DEL                    =       171;
98 const float K_KP_SLASH          =       172;
99 const float K_KP_MINUS          =       173;
100 const float K_KP_PLUS                   =       174;
101
102 const float K_PAUSE             =       255;
103
104 //
105 // joystick buttons
106 //
107 const float K_JOY1              =       768;
108 const float K_JOY2              =       769;
109 const float K_JOY3              =       770;
110 const float K_JOY4              =       771;
111
112 //
113 // aux keys are for multi-buttoned joysticks to generate so they can use
114 // the normal binding process
115 //
116 const float K_AUX1              =       772;
117 const float K_AUX2              =       773;
118 const float K_AUX3              =       774;
119 const float K_AUX4              =       775;
120 const float K_AUX5              =       776;
121 const float K_AUX6              =       777;
122 const float K_AUX7              =       778;
123 const float K_AUX8              =       779;
124 const float K_AUX9              =       780;
125 const float K_AUX10             =       781;
126 const float K_AUX11             =       782;
127 const float K_AUX12             =       783;
128 const float K_AUX13             =       784;
129 const float K_AUX14             =       785;
130 const float K_AUX15             =       786;
131 const float K_AUX16             =       787;
132 const float K_AUX17             =       788;
133 const float K_AUX18             =       789;
134 const float K_AUX19             =       790;
135 const float K_AUX20             =       791;
136 const float K_AUX21             =       792;
137 const float K_AUX22             =       793;
138 const float K_AUX23             =       794;
139 const float K_AUX24             =       795;
140 const float K_AUX25             =       796;
141 const float K_AUX26             =       797;
142 const float K_AUX27             =       798;
143 const float K_AUX28             =       799;
144 const float K_AUX29             =       800;
145 const float K_AUX30             =       801;
146 const float K_AUX31             =       802;
147 const float K_AUX32             =       803;
148
149 //
150 // mouse buttons generate virtual keys
151 //
152 const float K_MOUSE1            =       512;
153 const float K_MOUSE2            =       513;
154 const float K_MOUSE3            =       514;
155 const float K_MWHEELUP  =       515;
156 const float K_MWHEELDOWN        =       516;
157 const float K_MOUSE4            =       517;
158 const float K_MOUSE5            =       518;
159 const float K_MOUSE6            =       519;
160 const float K_MOUSE7            =       520;
161 const float K_MOUSE8            =       521;
162 const float K_MOUSE9            =       522;
163 const float K_MOUSE10           =       523;
164 const float K_MOUSE11           =       524;
165 const float K_MOUSE12           =       525;
166 const float K_MOUSE13           =       526;
167 const float K_MOUSE14           =       527;
168 const float K_MOUSE15           =       528;
169 const float K_MOUSE16           =       529;
170
171 ///////////////////////////
172 // cvar constants
173
174 float CVAR_SAVE         = 1;
175 float CVAR_NOTIFY       = 2;
176 float CVAR_READONLY     = 4;
177
178 ///////////////////////////
179 // csqc communication stuff
180
181 const float ENTCS_MSG_END = 0;
182 const float ENTCS_MSG_ONS_GPS = 1;
183 const float ENTCS_MSG_ONS_REMOVE = 2;
184 const float ENTCS_MSG_INIT = 3;
185
186 const float TE_CSQC_INIT = 100;
187 const float TE_CSQC_PING = 101;
188 const float TE_CSQC_CAPTURES = 102;
189 const float TE_CSQC_RETURNS = 103;
190 const float TE_CSQC_DEATHS = 104;
191 const float TE_CSQC_PICTURE = 105;
192 const float TE_CSQC_MAPVOTE = 106;
193 const float TE_CSQC_CONFIG = 107;
194 const float TE_CSQC_SCORESINFO = 108;
195 const float TE_CSQC_RACE = 109;
196 const float TE_CSQC_FORCESCOREBOARD = 110;
197 const float TE_CSQC_SPECTATING = 111;
198
199 const float STAT_KH_KEYS = 32;
200 const float STAT_CTF_STATE = 33;
201 const float CTF_STATE_ATTACK = 1;
202 const float CTF_STATE_DEFEND = 2;
203 const float CTF_STATE_COMMANDER = 3;
204
205 // moved that here so the client knows the max.
206 // # of maps, I'll use arrays for them :P
207 #define MAPVOTE_COUNT 10
208 const float MAPVOTE_NET_INIT = 0;
209 const float MAPVOTE_NET_UPDATE = 1;
210 const float MAPVOTE_NET_PIC = 2;
211 const float MAPVOTE_NET_OWNVOTE = 3;
212
213 const float RACE_NET_CHECKPOINT_HIT_QUALIFYING = 0; // byte checkpoint, short time, short recordtime, string recordholder
214 const float RACE_NET_CHECKPOINT_CLEAR = 1;
215 const float RACE_NET_CHECKPOINT_NEXT_QUALIFYING = 2; // byte nextcheckpoint, short recordtime, string recordholder
216 const float RACE_NET_CHECKPOINT_HIT_RACE = 3; // byte checkpoint, short delta, byte lapsdelta, string opponent
217 const float RACE_NET_CHECKPOINT_HIT_RACE_BY_OPPONENT = 4; // byte checkpoint, short delta, byte lapsdelta, string opponent
218 const float RACE_NET_CHECKPOINT_NEXT_SPEC_QUALIFYING = 5; // byte nextcheckpoint, float laptime, short recordtime, string recordholder
219
220 /**
221  * Lower scores are better (e.g. suicides)
222  */
223 #define SFL_LOWER_IS_BETTER     1
224
225 /**
226  * Don't show zero values as scores
227  */
228 #define SFL_HIDE_ZERO           2
229
230 /**
231  * Allow a column to be hidden (do not automatically add it even if it is a sorting key)
232  */
233 #define SFL_ALLOW_HIDE         16
234
235 /**
236  * Display as a rank (with st, nd, rd, th suffix)
237  */
238 #define SFL_RANK               32
239
240 /**
241  * Display as mm:ss.s, value is stored as 10ths of a second (AND 0 is the worst possible value!)
242  */
243 #define SFL_TIME               64
244
245 // not an extra constant yet
246 #define SFL_ZERO_IS_WORST SFL_TIME
247
248 /**
249  * Scoring priority (NOTE: PRIMARY is used for fraglimit)
250  */
251 #define SFL_SORT_PRIO_SECONDARY 4
252 #define SFL_SORT_PRIO_PRIMARY   8
253 #define SFL_SORT_PRIO_MASK     12
254
255 /**
256  * Score indices
257  */
258 #define MAX_SCORE 10
259 #define MAX_TEAMSCORE 2
260
261 #define ST_SCORE 0
262 #define SP_KILLS 0
263 #define SP_DEATHS 1
264 #define SP_SUICIDES 2
265 #define SP_SCORE 3
266 // game mode specific indices are not in common/, but in server/scores_rules.qc!