1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
|
/* copyright (c) 2007 magnus auvinen, see licence.txt for more info */
#ifndef ENGINE_INTERFACE_H
#define ENGINE_INTERFACE_H
#ifdef __cplusplus
extern "C" {
#endif
/*
Title: Engine Interface
*/
#include "e_keys.h"
#include "e_system.h"
enum
{
MAX_CLIENTS=12,
SERVER_TICK_SPEED=50, /* TODO: this should be removed */
SNAP_CURRENT=0,
SNAP_PREV=1,
IMG_AUTO=-1,
IMG_RGB=0,
IMG_RGBA=1,
IMG_ALPHA=2,
MASK_NONE=0,
MASK_SET,
MASK_ZERO,
SNDFLAG_LOOP=1,
SNDFLAG_POS=2,
SNDFLAG_ALL=3,
CLIENTSTATE_OFFLINE=0,
CLIENTSTATE_CONNECTING,
CLIENTSTATE_LOADING,
CLIENTSTATE_ONLINE,
CLIENTSTATE_QUITING,
BROWSESORT_NAME = 0,
BROWSESORT_PING,
BROWSESORT_MAP,
BROWSESORT_GAMETYPE,
BROWSESORT_PROGRESSION,
BROWSESORT_NUMPLAYERS
};
typedef struct
{
int type;
int id;
} SNAP_ITEM;
typedef struct
{
const char *name;
int latency;
} CLIENT_INFO;
typedef struct
{
int width, height;
int format;
void *data;
} IMAGE_INFO;
typedef struct
{
int width, height;
int red, green, blue;
} VIDEO_MODE;
typedef struct
{
int sorted_index;
int server_index;
int progression;
int game_type;
int max_players;
int num_players;
int flags;
int latency; /* in ms */
char name[64];
char map[32];
char version[32];
char address[24];
char player_names[16][48];
int player_scores[16];
} SERVER_INFO;
typedef struct PERFORMACE_INFO_t
{
const char *name;
struct PERFORMACE_INFO_t *parent;
struct PERFORMACE_INFO_t *first_child;
struct PERFORMACE_INFO_t *next_child;
int tick;
int64 start;
int64 total;
int64 biggest;
int64 last_delta;
} PERFORMACE_INFO;
void perf_init();
void perf_next();
void perf_start(PERFORMACE_INFO *info);
void perf_end();
void perf_dump();
int gfx_init();
void gfx_shutdown();
void gfx_swap();
int gfx_window_active();
int gfx_window_open();
void gfx_set_vsync(int val);
void gfx_mask_op(int mask, int write);
void gfx_clear_mask(int fill);
int snd_init();
int snd_shutdown();
int snd_update();
int map_load(const char *mapname);
void map_unload();
void map_set(void *m);
/*
Group: Graphics
*/
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float gfx_screenaspect();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int gfx_get_video_modes(VIDEO_MODE *list, int maxcount);
/* image loaders */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int gfx_load_png(IMAGE_INFO *img, const char *filename);
/* textures */
/*
Function: gfx_load_texture
Loads a texture from a file. TGA and PNG supported.
Arguments:
filename - Null terminated string to the file to load.
store_format - What format to store on gfx card as.
Returns:
An ID to the texture. -1 on failure.
See Also:
<gfx_unload_texture>
*/
int gfx_load_texture(const char *filename, int store_format);
/*
Function: gfx_load_texture_raw
Loads a texture from memory.
Arguments:
w - Width of the texture.
h - Height of the texture.
data - Pointer to the pixel data.
format - Format of the pixel data.
store_format - The format to store the texture on the graphics card.
Returns:
An ID to the texture. -1 on failure.
Remarks:
The pixel data should be in RGBA format with 8 bit per component.
So the total size of the data should be w*h*4.
See Also:
<gfx_unload_texture>
*/
int gfx_load_texture_raw(int w, int h, int format, const void *data, int store_format);
/*
Function: gfx_texture_set
Sets the active texture.
Arguments:
id - ID to the texture to set.
*/
void gfx_texture_set(int id);
/*
Function: gfx_unload_texture
Unloads a texture.
Arguments:
id - ID to the texture to unload.
See Also:
<gfx_load_texture_tga>, <gfx_load_texture_raw>
Remarks:
NOT IMPLEMENTED
*/
int gfx_unload_texture(int id);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_clear(float r, float g, float b);
/*
Function: gfx_screenwidth
Returns the screen width.
See Also:
<gfx_screenheight>
*/
int gfx_screenwidth();
/*
Function: gfx_screenheight
Returns the screen height.
See Also:
<gfx_screenwidth>
*/
int gfx_screenheight();
/*
Function: gfx_mapscreen
Specifies the coordinate system for the screen.
Arguments:
tl_x - Top-left X
tl_y - Top-left Y
br_x - Bottom-right X
br_y - Bottom-right y
*/
void gfx_mapscreen(float tl_x, float tl_y, float br_x, float br_y);
/*
Function: gfx_blend_normal
Set the active blending mode to normal (src, 1-src).
Remarks:
This must be used before calling <gfx_quads_begin>.
This is equal to glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA).
See Also:
<gfx_blend_additive>
*/
void gfx_blend_normal();
/*
Function: gfx_blend_additive
Set the active blending mode to additive (src, one).
Remarks:
This must be used before calling <gfx_quads_begin>.
This is equal to glBlendFunc(GL_SRC_ALPHA, GL_ONE).
See Also:
<gfx_blend_normal>
*/
void gfx_blend_additive();
/*
Function: gfx_quads_begin
Begins a quad drawing session.
Remarks:
This functions resets the rotation, color and subset.
End the session by using <gfx_quads_end>.
You can't change texture or blending mode during a session.
See Also:
<gfx_quads_end>
*/
void gfx_quads_begin();
/*
Function: gfx_quads_end
Ends a quad session.
See Also:
<gfx_quads_begin>
*/
void gfx_quads_end();
/*
Function: gfx_quads_setrotation
Sets the rotation to use when drawing a quad.
Arguments:
angle - Angle in radians.
Remarks:
The angle is reset when <gfx_quads_begin> is called.
*/
void gfx_quads_setrotation(float angle);
/*
Function: gfx_quads_setcolorvertex
Sets the color of a vertex.
Arguments:
i - Index to the vertex.
r - Red value.
g - Green value.
b - Blue value.
a - Alpha value.
Remarks:
The color values are from 0.0 to 1.0.
The color is reset when <gfx_quads_begin> is called.
*/
void gfx_setcolorvertex(int i, float r, float g, float b, float a);
/*
Function: gfx_quads_setcolor
Sets the color of all the vertices.
Arguments:
r - Red value.
g - Green value.
b - Blue value.
a - Alpha value.
Remarks:
The color values are from 0.0 to 1.0.
The color is reset when <gfx_quads_begin> is called.
*/
void gfx_setcolor(float r, float g, float b, float a);
/*
Function: gfx_quads_setsubset
Sets the uv coordinates to use.
Arguments:
tl_u - Top-left U value.
tl_v - Top-left V value.
br_u - Bottom-right U value.
br_v - Bottom-right V value.
Remarks:
O,0 is top-left of the texture and 1,1 is bottom-right.
The color is reset when <gfx_quads_begin> is called.
*/
void gfx_quads_setsubset(float tl_u, float tl_v, float br_u, float br_v);
/*
Function: gfx_quads_drawTL
Draws a quad by specifying the top-left point.
Arguments:
x - X coordinate of the top-left corner.
y - Y coordinate of the top-left corner.
width - Width of the quad.
height - Height of the quad.
Remarks:
Rotation still occurs from the center of the quad.
You must call <gfx_quads_begin> before calling this function.
See Also:
<gfx_quads_draw>
*/
void gfx_quads_drawTL(float x, float y, float width, float height);
/*
Function: gfx_quads_draw
Draws a quad by specifying the center point.
Arguments:
x - X coordinate of the center.
y - Y coordinate of the center.
width - Width of the quad.
height - Height of the quad.
Remarks:
You must call <gfx_quads_begin> before calling this function.
See Also:
<gfx_quads_drawTL>
*/
void gfx_quads_draw(float x, float y, float w, float h);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_quads_draw_freeform(
float x0, float y0,
float x1, float y1,
float x2, float y2,
float x3, float y3);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_quads_text(float x, float y, float size, const char *text);
/* sound (client) */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void snd_set_channel(int cid, float vol, float pan);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int snd_load_wv(const char *filename);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int snd_play_at(int cid, int sid, int flags, float x, float y);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int snd_play(int cid, int sid, int flags);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void snd_stop(int id);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void snd_set_listener_pos(float x, float y);
/*
Group: Input
*/
/*
Function: inp_mouse_relative
Fetches the mouse movements.
Arguments:
x - Pointer to the variable that should get the X movement.
y - Pointer to the variable that should get the Y movement.
*/
void inp_mouse_relative(int *x, int *y);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_mouse_scroll();
/*
Function: inp_key_pressed
Checks if a key is pressed.
Arguments:
key - Index to the key to check
Returns:
Returns 1 if the button is pressed, otherwise 0.
Remarks:
Check keys.h for the keys.
*/
int inp_key_pressed(int key);
/*
Group: Map
*/
/*
Function: map_is_loaded
Checks if a map is loaded.
Returns:
Returns 1 if the button is pressed, otherwise 0.
*/
int map_is_loaded();
/*
Function: map_num_items
Checks the number of items in the loaded map.
Returns:
Returns the number of items. 0 if no map is loaded.
*/
int map_num_items();
/*
Function: map_find_item
Searches the map for an item.
Arguments:
type - Item type.
id - Item ID.
Returns:
Returns a pointer to the item if it exists, otherwise it returns NULL.
*/
void *map_find_item(int type, int id);
/*
Function: map_get_item
Gets an item from the loaded map from index.
Arguments:
index - Item index.
type - Pointer that recives the item type (can be NULL).
id - Pointer that recives the item id (can be NULL).
Returns:
Returns a pointer to the item if it exists, otherwise it returns NULL.
*/
void *map_get_item(int index, int *type, int *id);
/*
Function: map_get_type
Gets the index range of an item type.
Arguments:
type - Item type to search for.
start - Pointer that recives the starting index.
num - Pointer that recives the number of items.
Returns:
If the item type is not in the map, start and num will be set to 0.
*/
void map_get_type(int type, int *start, int *num);
/*
Function: map_get_data
Fetches a pointer to a raw data chunk in the map.
Arguments:
index - Index to the data to fetch.
Returns:
A pointer to the raw data, otherwise 0.
*/
void *map_get_data(int index);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void *map_get_data_swapped(int index);
/*
Group: Network (Server)
*/
/*
Function: snap_new_item
Creates a new item that should be sent.
Arguments:
type - Type of the item.
id - ID of the item.
size - Size of the item.
Returns:
A pointer to the item data, otherwise 0.
Remarks:
The item data should only consist pf 4 byte integers as
they are subject to byte swapping. This means that the size
argument should be dividable by 4.
*/
void *snap_new_item(int type, int id, int size);
/*
Group: Network (Client)
*/
/*
Function: snap_num_items
Check the number of items in a snapshot.
Arguments:
snapid - Snapshot ID to the data to fetch.
* SNAP_PREV for previous snapshot.
* SNAP_CUR for current snapshot.
Returns:
The number of items in the snapshot.
*/
int snap_num_items(int snapid);
/*
Function: snap_get_item
Gets an item from a snapshot.
Arguments:
snapid - Snapshot ID to the data to fetch.
* SNAP_PREV for previous snapshot.
* SNAP_CUR for current snapshot.
index - Index of the item.
item - Pointer that recives the item info.
Returns:
Returns a pointer to the item if it exists, otherwise NULL.
*/
const void *snap_get_item(int snapid, int index, SNAP_ITEM *item);
/*
Function: snap_find_item
Searches a snapshot for an item.
Arguments:
snapid - Snapshot ID to the data to fetch.
* SNAP_PREV for previous snapshot.
* SNAP_CUR for current snapshot.
type - Type of the item.
id - ID of the item.
Returns:
Returns a pointer to the item if it exists, otherwise NULL.
*/
const void *snap_find_item(int snapid, int type, int id);
/*
Function: snap_input
Sets the input data to send to the server.
Arguments:
data - Pointer to the data.
size - Size of the data.
Remarks:
The data should only consist of 4 bytes integer as they are
subject to byte swapping.
*/
void snap_input(void *data, int size);
/*
Group: Server Callbacks
*/
/*
Function: mods_init
Called when the server is started.
Remarks:
It's called after the map is loaded so all map items are available.
*/
void mods_init();
/*
Function: mods_shutdown
Called when the server quits.
Remarks:
Should be used to clean up all resources used.
*/
void mods_shutdown();
/*
Function: mods_client_enter
Called when a client has joined the game.
Arguments:
cid - Client ID. Is 0 - MAX_CLIENTS.
Remarks:
It's called when the client is finished loading and should enter gameplay.
*/
void mods_client_enter(int cid);
/*
Function: mods_client_drop
Called when a client drops from the server.
Arguments:
cid - Client ID. Is 0 - MAX_CLIENTS
*/
void mods_client_drop(int cid);
/*
Function: mods_client_input
Called when the server recives new input from a client.
Arguments:
cid - Client ID. Is 0 - MAX_CLIENTS.
input - Pointer to the input data.
size - Size of the data. (NOT IMPLEMENTED YET)
*/
void mods_client_input(int cid, void *input);
/*
Function: mods_tick
Called with a regular interval to progress the gameplay.
Remarks:
The SERVER_TICK_SPEED tells the number of ticks per second.
*/
void mods_tick();
/*
Function: mods_presnap
Called before the server starts to construct snapshots for the clients.
*/
void mods_presnap();
/*
Function: mods_snap
Called to create the snapshot for a client.
Arguments:
cid - Client ID. Is 0 - MAX_CLIENTS.
Remarks:
The game should make a series of calls to <snap_new_item> to construct
the snapshot for the client.
*/
void mods_snap(int cid);
/*
Function: mods_postsnap
Called after the server is done sending the snapshots.
*/
void mods_postsnap();
/*
Group: Client Callbacks
*/
/*
Function: modc_preinit
Called when the client starts, but before the engine is initialized.
Remarks:
*/
void modc_preinit();
/*
Function: modc_init
Called when the client starts.
Remarks:
The game should load resources that are used during the entire
time of the game. No map is loaded.
*/
void modc_init();
/*
Function: modc_newsnapshot
Called when the client progressed to a new snapshot.
Remarks:
The client can check for items in the snapshot and perform one time
events like playing sounds, spawning client side effects etc.
*/
void modc_newsnapshot();
/*
Function: modc_entergame
Called when the client has successfully connect to a server and
loaded a map.
Remarks:
The client can check for items in the map and load them.
*/
void modc_entergame();
/*
Function: modc_shutdown
Called when the client closes down.
*/
void modc_shutdown();
/*
Function: modc_render
Called every frame to let the game render it self.
*/
void modc_render();
/*
Function: modc_statechange
Called every time client changes state.
*/
void modc_statechange(int new_state, int old_state);
/* undocumented callbacks */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void modc_connected();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void modc_message(int msg);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void modc_predict();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int modc_snap_input(int *data);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void mods_message(int msg, int client_id);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void mods_connected(int client_id);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *modc_net_version();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *mods_net_version();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *mods_version();
/* server */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int server_getclientinfo(int client_id, CLIENT_INFO *info);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *server_clientname(int client_id);
/* grabs the latest input for the client. not withholding anything */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int *server_latestinput(int client_id, int *size);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void server_setclientname(int client_id, const char *name);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void server_setclientscore(int client_id, int score);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void server_setbrowseinfo(int game_type, int progression);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void server_kick(int client_id, const char *reason);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int server_tick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int server_tickspeed();
/* input */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_was_pressed(int key);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_down(int key);
typedef struct
{
char ch;
int key;
} INPUTEVENT;
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_num_events();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
INPUTEVENT inp_get_event(int index);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void inp_clear_events();
void inp_update();
void inp_init();
void inp_mouse_mode_absolute();
void inp_mouse_mode_relative();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_mouse_doubleclick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void inp_clear_key_states();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_presses(int key);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_releases(int key);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_state(int key);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *inp_key_name(int k);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int inp_key_code(const char *key_name);
/* message packing */
enum
{
MSGFLAG_VITAL=1
};
void msg_pack_start_system(int msg, int flags);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void msg_pack_start(int msg, int flags);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void msg_pack_int(int i);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void msg_pack_string(const char *p, int limit);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void msg_pack_raw(const void *data, int size);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void msg_pack_end();
typedef struct
{
int msg;
int flags;
const unsigned char *data;
int size;
} MSG_INFO;
const MSG_INFO *msg_get_info();
/* message unpacking */
int msg_unpack_start(const void *data, int data_size, int *system);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int msg_unpack_int();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *msg_unpack_string();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const unsigned char *msg_unpack_raw(int size);
/* message sending */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int server_send_msg(int client_id); /* client_id == -1 == broadcast */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_send_msg();
/* client */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_tick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_predtick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float client_intratick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float client_ticktime();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float client_intrapredtick();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_tickspeed();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float client_frametime();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float client_localtime();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_direct_input(int *input, int size);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_state();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
const char *client_error_string();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int *client_get_input(int tick);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_connection_problems();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_connect(const char *address);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_disconnect();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_quit();
void client_entergame();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_rcon(const char *cmd);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_serverbrowse_refresh(int lan);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
SERVER_INFO *client_serverbrowse_sorted_get(int index);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_serverbrowse_sorted_num();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
SERVER_INFO *client_serverbrowse_get(int index);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_serverbrowse_num();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int client_serverbrowse_num_requests();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void client_serverbrowse_update();
/* undocumented graphics stuff */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_text(void *font, float x, float y, float size, const char *text, int max_width);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
float gfx_text_width(void *font, float size, const char *text, int length);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_text_color(float r, float g, float b, float a);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_text_set_default_font(void *font);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_getscreen(float *tl_x, float *tl_y, float *br_x, float *br_y);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int gfx_memory_usage();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_screenshot();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_lines_begin();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_lines_draw(float x0, float y0, float x1, float y1);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_lines_end();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_clip_enable(int x, int y, int w, int h);
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_clip_disable();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void gfx_quads_setsubset_free(
float x0, float y0,
float x1, float y1,
float x2, float y2,
float x3, float y3);
/* server snap id */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
int snap_new_id();
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void snap_free_id(int id);
/* other */
/*
Function: TODO
Arguments:
arg1 - desc
Returns:
See Also:
<other_func>
*/
void map_unload_data(int index);
#ifdef __cplusplus
}
#endif
#endif
|