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 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377
|
<?xml version="1.0" encoding="utf-8"?>
<!--
This is the default transformation to show the reference as an XML
document. To turn this text into script that can be read by the
AssaultCube engine, simply uncomment the below line, comment the
line below that one, save and then refresh.
-->
<!--<?xml-stylesheet type="text/xsl" href="transformations/cuberef2cubescript.xslt"?>-->
<?xml-stylesheet type="text/xsl" href="transformations/cuberef2xhtml.xslt"?>
<cuberef
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://cubers.net/Schemas/CubeRef"
name="AssaultCube Reference"
version="v1.0"
xsi:schemaLocation="http://cubers.net/Schemas/CubeRef schemas/cuberef.xsd">
<description>This reference describes the commands and variables available in AssaultCube.</description>
<!--
Sections are: CubeScript, General, Game modes, Editing, Gameplay, Visuals, Head-up display,
Sound, Menus, Ingame reference, server commands, Game modes, Editing configs.
-->
<sections sort="true">
<!-- CubeScript language Section Starts -->
<section name="CubeScript" sortindex="00">
<description>This section describes identifiers that are closely related to the CubeScript language.</description>
<identifiers sort="true">
<command name="<f">
<description>Determines if a floating-point value is smaller than a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name="<=f">
<description>Determines if a floating-point value is less than or equal to a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name="=f">
<description>Determines if a floating-point value is equal to a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name=">f">
<description>Determines if a floating-point value is greater than a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name=">=f">
<description>Determines if a floating-point value is greater than or equal to a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name="!=f">
<description>Determines if a floating-point value is not equal to a second floating-point value.</description>
<return token="F" description="(true)1||0(false)"/>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name="result">
<description>sets the result value of a CubeScript block</description>
<arguments>
<argument token="R" description="the result"/>
</arguments>
</command>
<command name="push">
<arguments>
<argument token="N" description="alias name"/>
<argument token="A" description="action"/>
</arguments>
<references>
<identifierReference identifier="pop"/>
</references>
</command>
<command name="modf">
<description>Performs a floating-point modulo operation.</description>
<arguments>
<argument token="A" description="the dividend"/>
<argument token="B" description="the divisor"/>
</arguments>
<return token="F" description="the modulo value"/>
<examples>
<example>
<code><![CDATA[echo (modf 7.5 12.5)]]></code>
<explanation>Output: 7.5</explanation>
</example>
<example>
<code><![CDATA[echo (modf 17.5 12.5)]]></code>
<explanation>Output: 5.0</explanation>
</example>
</examples>
</command>
<command name="pop">
<arguments>
<argument token="A" description="alias"/>
</arguments>
<references>
<identifierReference identifier="push"/>
</references>
</command>
<command name="+">
<description>Performs an addition.</description>
<remarks>
<remark>
Example: echo the sum of x and y is (+ $x $y)
</remark>
</remarks>
<arguments>
<argument token="A" description="the first summand"/>
<argument token="B" description="the second summand"/>
</arguments>
<return token="N" description="the sum"/>
</command>
<command name="-">
<description>Performs a subtraction.</description>
<arguments>
<argument token="A" description="the minuend"/>
<argument token="B" description="the subtrahend"/>
</arguments>
<return token="N" description="the difference"/>
</command>
<command name="-f">
<description>Subtracts two floating-point numbers.</description>
<arguments>
<argument token="A" description="the minuend" valueNotes="float"/>
<argument token="B" description="the subtrahend" valueNotes="float"/>
</arguments>
<return token="F" description="the difference"/>
</command>
<command name="+f">
<description>Adds up two floating-point numbers.</description>
<arguments>
<argument token="A" description="the first summand" valueNotes="float"/>
<argument token="B" description="the second summand" valueNotes="float"/>
</arguments>
<return token="F" description="the sum"/>
</command>
<command name="*">
<description>Performs a multiplication.</description>
<arguments>
<argument token="A" description="the multiplicand"/>
<argument token="B" description="the multiplier"/>
</arguments>
<return token="N" description="the product"/>
</command>
<command name="div">
<description>Performs an integer division.</description>
<arguments>
<argument token="A" description="the dividend"/>
<argument token="B" description="the divisor"/>
</arguments>
<return token="N" description="the quotient (integer)"/>
</command>
<command name="divf">
<description>Performs a division with floating-point precision.</description>
<arguments>
<argument token="A" description="" valueNotes="the dividend"/>
<argument token="B" description="" valueNotes="the divisor"/>
</arguments>
<return token="F" description="the quotient (floating-point)"/>
</command>
<command name="mod">
<description>Performs a modulo operation.</description>
<arguments>
<argument token="A" description="the dividend"/>
<argument token="B" description="the divisor"/>
</arguments>
<return token="N" description="the modulo value"/>
</command>
<command name="=">
<description>Determines if two values are equal.</description>
<arguments>
<argument token="A" description="first value"/>
<argument token="B" description="second value"/>
</arguments>
<return token="N" description="the equality" valueNotes="1 (equal) or 0 (not equal)"/>
<examples>
<example>
<code><![CDATA[echo there are only (concatword (= 1 1) (= 1 0)) types of people in the world]]></code>
<explanation>Output: there are only 10 types of people in the world</explanation>
</example>
</examples>
</command>
<command name="!=">
<description>Determines if two values are not equal.</description>
<arguments>
<argument token="A" description="first value"/>
<argument token="B" description="second value"/>
</arguments>
<return token="N" description="the inequality" valueNotes="1 (not equal) or 0 (equal)"/>
</command>
<command name="<">
<description>Determines if a value is smaller than a second value.</description>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
<return token="N" description="the comparison" valueNotes="1 (smaller) or 0 (not smaller)"/>
</command>
<command name=">">
<description>Determines if a value is bigger than a second value.</description>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
<return token="N" description="the comparison" valueNotes="1 (bigger) or 0 (not bigger)"/>
</command>
<command name="<=">
<description>Determines if a values is less than or equal than a second value.</description>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name=">=">
<description>Determines if a values is greater than or equal than a second value.</description>
<arguments>
<argument token="A" description="the first value"/>
<argument token="B" description="the second value"/>
</arguments>
</command>
<command name="&&">
<description>logical AND.</description>
<examples>
<example>
<code><![CDATA[echo (&& 1 1)]]></code>
<explanation>Output: 1</explanation>
</example>
<example>
<code><![CDATA[echo (&& 1 0)]]></code>
<explanation>Output: 0</explanation>
</example>
</examples>
<arguments>
<argument token="A" description="first value"/>
<argument token="B" description="second value"/>
</arguments>
<return token="N" description="A AND B"/>
</command>
<command name="||">
<description>logical OR.</description>
<examples>
<example>
<code><![CDATA[echo (|| 1 0)]]></code>
<explanation>
output: 1
</explanation>
</example>
<example>
<code><![CDATA[echo (|| 0 0)]]></code>
<explanation>
output: 0
</explanation>
</example>
</examples>
<arguments>
<argument token="A" description="first value"/>
<argument token="B" description="second value"/>
</arguments>
<return token="N" description="A OR B"/>
</command>
<command name="!">
<description>Performs a negation.</description>
<arguments>
<argument token="A" description="argument"/>
</arguments>
</command>
<command name="*f">
<description>Performs a floating point multiplication.</description>
<arguments>
<argument token="A" description="the multiplicand"/>
<argument token="B" description="the multiplier"/>
</arguments>
<return token="N" description="the product"/>
</command>
<command name="rnd">
<description>Random value</description>
<arguments>
<argument token="A" description="The upper limit of the random value" valueNotes=""/>
</arguments>
<return token="R" description="The random value" valueNotes="larger or equal 0 and smaller than A"/>
</command>
<command name="strcmp">
<description>Determines if two strings are equal.</description>
<arguments>
<argument token="A" description="the first string"/>
<argument token="B" description="the second string"/>
</arguments>
<return token="N" description="the equality" valueNotes="1 (equal) or 0 (unequal)"/>
</command>
<command name="if">
<description>Controls the script flow based on a boolean expression.</description>
<examples>
<example>
<code><![CDATA[if (> $x 10) [ echo x is bigger than 10 ] [ echo x too small ]]]></code>
</example>
</examples>
<arguments>
<argument token="cond" description="the condition" valueNotes="0 (false) or anything else (true)"/>
<argument token="true" description="the body to execute if the condition is true"/>
<argument token="false" description="the body to execute if the condition is false"/>
</arguments>
</command>
<command name="loop">
<description>Loops the specified body.</description>
<remarks>
<remark>This command sets the alias you choose, as first argument, from 0 to N-1 for every iteration.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[loop i 10 [ echo $i ]]]></code>
</example>
</examples>
<arguments>
<argument token="V" description="the alias used as counter"/>
<argument token="N" description="the amount of loops"/>
<argument token="body" description="the body to execute on each iteration"/>
</arguments>
</command>
<command name="while">
<description>Loops the specified body while the condition evaluates to true.</description>
<remarks>
<remark>
This command sets the alias "i" from 0 to N-1 for every iteration.
Note that the condition here has to have [], otherwise it would only be evaluated once.
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[alias i 0; while [ (< $i 10) ] [ echo $i; alias i (+ $i 1) ]]]></code>
</example>
</examples>
<arguments>
<argument token="cond" description="the condition" valueNotes="0 (false) or anything else (true)"/>
<argument token="body" description="the body to execute on each iteration"/>
</arguments>
</command>
<command name="concat">
<description>Concatenates multiple strings with spaces inbetween.</description>
<examples>
<example>
<code><![CDATA[alias a "hello"; echo (concat $a "world")]]></code>
<explanation>output: hello world</explanation>
</example>
</examples>
<arguments>
<argument token="S" description="the first string"/>
<variableArgument token="..." description="collection of strings to concatenate"/>
</arguments>
<return token="R" description="The newly created string"/>
</command>
<command name="concatword">
<description>Concatenates multiple strings.</description>
<remarks>
<remark>The newly created string is saved to the alias 's'.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[alias a "Cube"; echo (concatword $a "Script")]]></code>
<explanation>output: CubeScript</explanation>
</example>
</examples>
<arguments>
<argument token="S" description="the first string"/>
<variableArgument token="..." description="collection of strings to concatenate"/>
</arguments>
<return token="R" description="The newly created string"/>
</command>
<command name="at">
<description>Grabs a word out of a string.</description>
<examples>
<example>
<code><![CDATA[echo (at "zero one two three" 2)]]></code>
<explanation>output: two</explanation>
</example>
</examples>
<arguments>
<argument token="S" description="the string"/>
<argument token="N" description="the index of the word"/>
</arguments>
<return token="W" description="the word from the specified idex"/>
</command>
<command name="listlen">
<description>returns the element count of the given list.</description>
<arguments>
<argument token="L" description="the list"/>
</arguments>
</command>
<command name="findlist">
<description>Searches a list for a specified value.</description>
<arguments>
<argument token="L" description="the list"/>
<argument token="I" description="the item to find"/>
</arguments>
<return token="I" description="the index of the item in the list"/>
</command>
<command name="sleep">
<description>Executes a command after specified time period.</description>
<examples>
<example>
<code><![CDATA[sleep 1000 [ echo foo ]]]></code>
<explanation>Prints 'foo' to the screen after 1 second.</explanation>
</example>
</examples>
<arguments>
<argument token="N" description="the amount of milliseconds"/>
<argument token="C" description="the command to execute"/>
</arguments>
</command>
<variable name="numargs">
<description>The number of arguments passed to the current alias</description>
<value token="V" description="numargs" minValue="0" maxValue="25" defaultValue="0" readOnly="true"/>
</variable>
<command name="format">
<arguments>
<argument token="F" description="format" valueNotes="use %1..%9 for the values"/>
<argument token="V" description="value(s)"/>
</arguments>
<examples>
<example>
<code><![CDATA[echo (format "%1 bottles of %2 on the %3, %1 bottles of %2!" 99 beer wall)]]></code>
<explanation>output: 99 bottles of beer on the wall, 99 bottles of beer!</explanation>
</example>
</examples>
</command>
</identifiers>
</section>
<!-- CubeScript language Section ends -->
<!-- General Section Starts -->
<section name="General" sortindex="01">
<description>This section describes general identifiers.</description>
<identifiers sort="true">
<variable name="autoscreenshot">
<description>Toggle for taking an automatic screenshot during intermission.</description>
<value token="B" description="0=Off, 1=On" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="screenshottype">
<description>Toggle format of screenshot image. Your choice is for BMP (0), JPEG (1) or PNG (2).</description>
<value token="T" description="0=BMP, 1=JPEG, 2=PNG" minValue="0" maxValue="2" defaultValue="1"/>
</variable>
<variable name="jpegquality">
<description>Sets the JPEG screenshot image quality.</description>
<remarks>
<remark>The image quality is set by it's compression level, a value of 10 sets maximum compression and a small file size but results in a bad quality image</remark>
<remark>while a value of 100 results in a large file but gives the best quality image.</remark>
</remarks>
<value token="N" description="Compression level" minValue="10" maxValue="100" defaultValue="70" />
</variable>
<variable name="pngcompress">
<description>Sets the PNG screenshot file compression.</description>
<remarks>
<remark>A value of 9 sets maximum data compression and a smaller file size while a value of 0 results in a large file image, quality is always the same since PNG its a loosless format.</remark>
</remarks>
<value token="N" description="Compression level" minValue="0" maxValue="9" defaultValue="9" />
</variable>
<command name="soundtest">
<description>Plays all hardcoded sounds in order.</description>
</command>
<command name="writecfg">
<description>writes current configuration to config/saved.cfg - automatic on quit</description>
</command>
<command name="registermusic">
<description>registers a track as music - the first three tracks have special meaning. Track #1 is for "flag grab" the second and third are used as "last minute" tracks.</description>
<arguments>
<argument token="M" description="music file"/>
</arguments>
</command>
<command name="echo">
<arguments>
<argument token="L" description="List of strings"/>
</arguments>
</command>
<command name="debugargs">
<description>Dump all command arguments to STDOUT</description>
<arguments>
<variableArgument token="..." description="..."/>
</arguments>
</command>
<command name="clearservers">
</command>
<variable name="browsefiledesc">
<description>Toggles getting descriptive text from CGZ or DMO files in menudirlist.</description>
<value token="B" description="" minValue="0" maxValue="1" defaultValue="1"/>
<references>
<identifierReference identifier="menudirlist"/>
</references>
</variable>
<variable name="physinterp">
<description>Toggles physics interpolation.</description>
<value token="B" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<command name="menudirlist">
<description>create a menu listing of files from a path and perform an action on them when clicked.</description>
<remarks>
<remark>use this inside menu definitions, almost always as the only command of that menu.</remark>
<remark>compare the usage inside config/menus.cfg</remark>
</remarks>
<arguments>
<argument token="" description=""/>
</arguments>
<examples>
<example>
<code><![CDATA[menudirlist "packages/maps" "cgz" "map $arg1"]]></code>
<explanation>will create a list of maps and load them when clicked</explanation>
</example>
</examples>
<references>
<identifierReference identifier="newmenu"/>
<identifierReference identifier="browsefiledesc"/>
</references>
</command>
<command name="toggleconsole">
<description>Toggles the console.</description>
</command>
<command name="jump">
<description>Triggers a jump.</description>
<remarks>
<remark>default keys: space and right mouse.</remark>
</remarks>
</command>
<command name="updatefrommaster">
<description>Contacts the masterserver and adds any new servers to the server list.</description>
<remarks>
<remark>The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu.</remark>
</remarks>
<arguments>
<argument token="B" description="force update" valueNotes="0 (delayed), 1 (immediate)"/>
</arguments>
</command>
<command name="millis">
<description>Returns the number of milliseconds since engine start.</description>
<examples>
<example>
<code><![CDATA[echo (millis)]]></code>
</example>
</examples>
<return token="N" description="the milliseconds"/>
</command>
<command name="systime">
<description>seconds since the epoch (00:00:00 UTC on January 1, 1970)</description>
<examples>
<example>
<code><![CDATA[echo (systime)]]></code>
</example>
</examples>
</command>
<command name="timestamp">
<description>a list of values for current time</description>
<remarks>
<remark>format: YYYY mm dd HH MM SS</remark>
</remarks>
<examples>
<example>
<code><![CDATA[echo (timestamp) "2008 08 08 08 08 08"]]></code>
</example>
<example>
<code><![CDATA[echo (timestamp) "2063 04 05 12 00 00"]]></code>
</example>
<example>
<code><![CDATA[echo (at (timestamp) 0) (at (timestamp) 2) (at (timestamp) 1) "2063 05 04"]]></code>
</example>
</examples>
</command>
<command name="datestring">
<description>representation of date</description>
<remarks>
<remark>format: Www Mmm dd hh:mm:ss yyyy</remark>
<remark>Use timestamp to create your own formatting.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[echo (datestring) "Sat Jun 7 17:08:35 2008"]]></code>
</example>
</examples>
</command>
<command name="timestring">
<description>the current time in (H)H:MM:SS format</description>
<examples>
<example>
<code><![CDATA[echo (timestring) "12:34:56"]]></code>
</example>
<example>
<code><![CDATA[echo (timestring) "1:02:03"]]></code>
</example>
</examples>
</command>
<command name="bind">
<description>Binds a key to a command.</description>
<remarks>
<remark>
To find out what key names and their default bindings are, look at config/keymap.cfg,
then add bind commands to your autoexec.cfg.
</remark>
</remarks>
<arguments>
<argument token="K" description="the key to bind" valueNotes="string"/>
<argument token="A" description="the command" valueNotes="string, usually an alias"/>
</arguments>
</command>
<command name="onrelease">
<description>Executes a command on the release of a key/button.</description>
<remarks>
<remark>This command must be placed in an action in a bind or in an alias in a bind.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[bind CTRL [ echo "key pressed"; onrelease [ echo "key released" ] ]]]></code>
</example>
</examples>
<references>
<identifierReference identifier="bind"/>
</references>
<arguments>
<argument token="A" description="the command"/>
</arguments>
</command>
<command name="alias">
<description>Binds a name to commands.</description>
<arguments>
<argument token="N" description="the name of the alias" valueNotes="string, must not contain '$'"/>
<argument token="A" description="the commands" valueNotes="string"/>
</arguments>
<examples>
<example>
<code><![CDATA[alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]]]></code>
<explanation>It is possible to re-bind an alias, even during its evaluation.</explanation>
</example>
<example>
<code><![CDATA[test = [ echo "successful" ]]]></code>
<explanation>There is also the shorthand version of defining an alias via the "="-sign.</explanation>
</example>
</examples>
</command>
<command name="quit">
<description>Quits the game without asking.</description>
</command>
<command name="forward">
<description>Moves the player forward.</description>
<remarks>
<remark>default keys: W and Up Arrow</remark>
</remarks>
</command>
<command name="backward">
<description>Moves the player backward.</description>
<remarks>
<remark>default keys: S and Down Arrow</remark>
</remarks>
</command>
<command name="left">
<description>Moves the player left.</description>
<remarks>
<remark>default keys: A and Left Arrow</remark>
</remarks>
</command>
<command name="right">
<description>Moves the player right.</description>
<remarks>
<remark>default keys: D and Right Arrow</remark>
</remarks>
</command>
<command name="attack">
<description>Fires the current weapon.</description>
<remarks>
<remark>default: left mouse button</remark>
</remarks>
</command>
<command name="invmouse">
<description>Sets mouse to "flight sim" mode.</description>
<arguments>
<argument token="B" description="sets invmouse" valueNotes="0 (off), else (on)"/>
</arguments>
</command>
<command name="screenshot">
<description>Takes a screenshot.</description>
<remarks>
<remark>
Screenshots are saved to "screenshots/screenshotN.bmp",
where N is the number of milliseconds since the game was launched.
</remark>
</remarks>
<defaultKeys>
<key alias="F12"/>
</defaultKeys>
</command>
<command name="exec">
<description>Executes all commands in a specified config file.</description>
<arguments>
<argument token="C" description="the config file"/>
</arguments>
</command>
<command name="keymap">
<description>Sets up the keymap for the specified key.</description>
<remarks>
<remark>You should never have to use this command manually, use "bind" instead.</remark>
</remarks>
<references>
<identifierReference identifier="bind"/>
</references>
<arguments>
<argument token="K" description="the key to map"/>
<argument token="N" description="the name for the key"/>
<argument token="A" description="the default action"/>
</arguments>
</command>
<command name="sensitivity">
<description>Sets the mouse sensitivity.</description>
<arguments>
<argument token="S" description="the sensitivity" valueNotes="floating-point"/>
</arguments>
</command>
<command name="addserver">
<description>Adds a server to the list of server to query in the server list menu.</description>
<arguments>
<argument token="S" description="the address of the server (hostname or IP)"/>
<argument token="P" description="the port"/>
</arguments>
</command>
<command name="resetsecuremaps">
<description>Clears the list of secured maps.</description>
<references>
<identifierReference identifier="securemap"/>
</references>
</command>
<command name="securemap">
<description>Adds a map to the list of secured maps.</description>
<remarks>
<remark>Secured maps can not be overwritten by the commands sendmap and getmap.</remark>
</remarks>
<references>
<identifierReference identifier="resetsecuremaps"/>
<identifierReference identifier="sendmap"/>
<identifierReference identifier="getmap"/>
</references>
<arguments>
<argument token="S" description="the name of the map"/>
</arguments>
</command>
<variable name="networkdebug">
<description>Enables output of processed network packets.</description>
<remarks>
<remark>This variable only has an effect if the client binary is compiled in debug mode.</remark>
</remarks>
<value token="B" description="enable network debugging" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="autogetmap">
<description>Determines if the current played map should be automatically downloaded if it is not available locally.</description>
<value token="B" description="enable auto map download" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="autogetnewmaprevisions">
<description>Automatically get new map revisions from the server.</description>
<value token="N" description="0: no, 1: yes" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="clockerror">
<description>Sets the correction value for clockfix.</description>
<remarks>
<remark>Engine source-code snippet (main.cpp): if(clockfix) millis = int(millis*(double(clockerror)/1000000));</remark>
</remarks>
<references>
<identifierReference identifier="clockfix"/>
</references>
<value token="V" description="correction value" minValue="990000" maxValue="1010000" defaultValue="1000000"/>
</variable>
<variable name="clockfix">
<description>Enables correction of the system clock.</description>
<references>
<identifierReference identifier="clockerror"/>
</references>
<value token="B" description="enable correction" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="dbgts">
<description>Enable triangle debug.</description>
<remarks>
<remark>Prints details while connecting triangles of 3d models.</remark>
</remarks>
<value token="B" description="triangle debug" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="maxfps">
<description>Limits the FPS (frames per second) of the game.</description>
<value token="V" description="maximum FPS" minValue="0" maxValue="200" defaultValue="200"/>
</variable>
<variable name="maxtmus">
<description>Gets the maximum number of supported textures when performing multitexturing.</description>
<value token="V" description="max. number of textures" minValue="1" maxValue="0" defaultValue="0" readOnly="true"/>
</variable>
<variable name="minlod">
<description>Minimal level of detail.</description>
<value token="V" description="" minValue="25" maxValue="250" defaultValue="60"/>
</variable>
<variable name="modeacronyms">
<description>Toggles use of acronyms instead of full modenames in the serverbrowser.</description>
<value token="B" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="resetbinds">
<description>Resets all binds back to their default values.</description>
<remarks>
<remark>
This command executes the file /config/resetbinds.cfg which will bind all keys to the values specified in that
file, thus resetting the binds to their default values.
</remark>
</remarks>
</variable>
<variable name="changeteam">
<description>Swaps your player to the enemy team.</description>
</variable>
<variable name="resetcfg">
<description>Determines if all settings should be reset when the game quits.</description>
<remarks>
<remark>
It is recommended to quit the game immediately after enabling this setting. Note that the reset happens
only once as the value of this variable is reset as well.
</remark>
</remarks>
<references>
<identifierReference identifier="quit"/>
</references>
<value token="B" description="enable reset" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="smoothdist">
<description>Determines the valid distance when extrapolating a players position.</description>
<value token="V" description="distance" minValue="0" maxValue="16" defaultValue="8"/>
</variable>
<variable name="smoothmove">
<description>Determines the speed when extrapolating a players position.</description>
<value token="V" description="movement speed" minValue="0" maxValue="100" defaultValue="75"/>
</variable>
<variable name="throttle_accel">
<description>Determines how fast network throttling accelerates.</description>
<references>
<identifierReference identifier="throttle_accel"/>
<identifierReference identifier="throttle_decel"/>
</references>
<value token="V" description="acceleration" minValue="0" maxValue="32" defaultValue="2"/>
</variable>
<variable name="throttle_decel">
<description>Determines how fast network throttling decelerates.</description>
<references>
<identifierReference identifier="throttle_accel"/>
<identifierReference identifier="throttle_interval"/>
</references>
<value token="V" description="deceleration" minValue="0" maxValue="32" defaultValue="2"/>
</variable>
<variable name="throttle_interval">
<description>Determines the interval of re-evaluating network throttling.</description>
<references>
<identifierReference identifier="throttle_accel"/>
<identifierReference identifier="throttle_decel"/>
</references>
<value token="V" description="interval" minValue="0" maxValue="30" defaultValue="5" valueNotes="seconds"/>
</variable>
<variable name="tsswap">
<description>Swaps vertices of model triangles.</description>
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="version">
<description>Gets an integer representing the game version. READ ONLY</description>
<remarks>
<remark>As example, version 1.0 is represented as value 1000.</remark>
</remarks>
</variable>
<variable name="gamemode">
<description>Holds the current game mode. READ ONLY</description>
<examples>
<example>
<code><![CDATA[echo $gamemode]]></code>
<explanation>Output: 5</explanation>
</example>
</examples>
<references>
<identifierReference identifier="mode"/>
</references>
</variable>
<variable name="connected">
<description>Indicates if a connection to a server exists.</description>
<value token="B" description="the connection state" valueNotes="1 (connected), 0 (disconnected)" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="maxroll">
<description>Sets the maximum value the display will roll on strafing.</description>
<value token="N" description="the roll value" minValue="0" maxValue="20" defaultValue="0"/>
</variable>
</identifiers>
</section>
<!-- General Section Ends -->
<!-- Gameplay Section Starts -->
<section name="Gameplay" sortindex="02">
<description>This section describes gameplay related identifiers.</description>
<identifiers sort="true">
<scriptalias name="start_intermission">
<description>If this alias exists it will be run when the game reaches intermission.</description>
<examples>
<example>
<code><![CDATA[
start_intermission = [
echo "INTERMISSION - STATISTICS TIME"
loop p 255 [
pn = (findpn $p)
if (strcmp $pn "") [ ] [
echo (concatword Player $p ":") (pstat_score $p) ":" (pstat_weap $p)
]
]
echo "------------------------------"
]
]]></code>
<explanation>This will output the full statistics line for all players.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="pstat_score"/>
<identifierReference identifier="pstat_weap"/>
</references>
</scriptalias>
<scriptalias name="mapstartonce">
<description>If this alias exists it will be run when the game starts a new map, then it is deleted.</description>
<examples>
<example>
<code><![CDATA[
mapstartonce = [
echo "------------------------------"
]
]]></code>
<explanation>This will output the string and override any other actions that might've been defined.</explanation>
</example>
<example>
<code><![CDATA[
addOnLoadOnce [
echo "------------------------------"
]
]]></code>
<explanation>This will output the string after any previously defined actions have run.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="add2alias"/>
<identifierReference identifier="mapstartalways"/>
</references>
</scriptalias>
<scriptalias name="mapstartalways">
<description>If this alias exists it will be run every time the game starts a new map.</description>
<examples>
<example>
<code><![CDATA[
mapstartalways = [
echo "------------------------------"
]
]]></code>
<explanation>This will output the string and override any other actions that might've been defined.</explanation>
</example>
<example>
<code><![CDATA[
addOnLoadAlways [
echo "------------------------------"
]
]]></code>
<explanation>This will output the string after any previously defined actions have run.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="add2alias"/>
<identifierReference identifier="mapstartonce"/>
</references>
</scriptalias>
<scriptalias name="add2alias">
<description>This will append the passed 2nd argument to any existing content of the alias named in the 1st argument. Several popular aliases have predefined shortcuts using this scriptalias: addOnQuit, addOnLoadOnce, addOnLoadAlways. Check config/scripts.cfg for possible omissions in that list.</description>
<examples>
<example>
<code><![CDATA[
foo = "one"
add2alias foo two
echo foo
]]></code>
<explanation>Output: one two</explanation>
<explanation>This will output the string and override any other actions that might've been defined.</explanation>
</example>
</examples>
</scriptalias>
<command name="pstat_score">
<description>Returns the score statistics for the player with the given clientnumber.</description>
<arguments>
<argument token="C" description="client" valueNotes="0..N"/>
</arguments>
<examples>
<example>
<code><![CDATA[
echo (pstat_score 0)
]]></code>
<explanation>Output: 0 5 3 43 1 unarmed</explanation>
<explanation>The output is a list of FLAGS, FRAGS, DEATHS, POINTS, TEAM, and NAME.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="start_intermission"/>
<identifierReference identifier="pstat_weap"/>
</references>
</command>
<command name="pstat_weap">
<description>Returns the shot statistics for the player with the given clientnumber.</description>
<arguments>
<argument token="C" description="client" valueNotes="0..N"/>
</arguments>
<examples>
<example>
<code><![CDATA[
echo (pstat_weap 0)
]]></code>
<explanation>Output: 0 0 0 0 0 0 0 0 0 0 1 240 15 312 0 0 3 112 0 0</explanation>
<explanation>The output is a list of tuples for all weapons, SHOTS-FIRED and DAMAGE-DEALT for each.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="start_intermission"/>
<identifierReference identifier="pstat_score"/>
<identifierReference identifier="weapon"/>
</references>
</command>
<command name="shiftweapon">
<description>shifts your selected weapon by a given delta. By default the mouse-wheel shifts one up or down according to your scroll direction.</description>
<defaultKeys>
<key alias="MOUSE4" description="cycle one up"/>
<key alias="MOUSE5" description="cycle one down"/>
</defaultKeys>
<arguments>
<argument token="D" description="delta" valueNotes="-N..-1,+1..N"/>
</arguments>
</command>
<command name="setscope">
<description>will display a scope for the sniper-rifle. used in the zoom-script (config/scripts.cfg [l. 92ff "alias zoom"]</description>
<arguments>
<argument token="Y" description="scope on?" valueNotes="0||1"/>
</arguments>
</command>
<command name="togglespect">
<description>cycles through all available spectator modes. Follow-1stPerson, Follow-3rdPerson, Follow-3rdPerson-transparent and Fly.</description>
<defaultKeys>
<key alias="SPACE" description="cycle spectator modes"/>
</defaultKeys>
</command>
<command name="whois">
<description>get the IP address of a given clientnumber - only admins get shown the last octet</description>
<arguments>
<argument token="C" description="clientnum"/>
</arguments>
</command>
<command name="vote">
<description>agree or disagree to the currently running vote</description>
<arguments>
<argument token="V" description="vote value" valueNotes="1 (yes) OR 2 (no)"/>
</arguments>
<defaultKeys>
<key alias="F1" description="votes YES"/>
<key alias="F2" description="votes NO"/>
</defaultKeys>
</command>
<command name="voicecom">
<arguments>
<argument token="S" description="sound" valueNotes="must be a registered voicecom-sound"/>
<argument token="T" description="text"/>
</arguments>
<defaultKeys>
<key alias="V" description="opens the voicecom menu, use number keys for your choice"/>
</defaultKeys>
</command>
<command name="mapname">
<description>returns the mapname</description>
</command>
<command name="mapsize">
<description>outputs the mapsize.</description>
</command>
<command name="loadcrosshair">
<description>Loads a crosshair for a specific weapon of - if the weapon argument is omitted or <0 - for all weapons.</description>
<arguments>
<argument token="I" description="image"/>
<argument token="W" description="weapon" valueNotes="-1,0..7"/>
</arguments>
</command>
<command name="idlebots">
<description>Enables or disables the processing of the bots artificial intelligence</description>
<arguments>
<argument token="T" description="off OR on" valueNotes="0||1"/>
</arguments>
<examples>
<example>
<code><![CDATA[idlebots 1]]></code>
<explanation>Will make the bots stand still.</explanation>
</example>
<example>
<code><![CDATA[idlebots 0]]></code>
<explanation>Will enable the bots to move and shoot.</explanation>
</example>
</examples>
</command>
<command name="kickallbots">
<description>Kicks all bots out of the current game.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
</command>
<command name="kickbot">
<description>Kicks the bot with the given name out of the current game.</description>
<arguments>
<argument token="N" description="botname" valueNotes="name of the bot to kick."/>
</arguments>
<examples>
<example>
<code><![CDATA[kickbot Robbie]]></code>
<explanation>Will make the bot named "Robbie" dissapear from the current game.</explanation>
</example>
</examples>
</command>
<command name="lanconnect"/>
<command name="listdemos">
<description>Get the game demos listing from the server we are currently connected.</description>
<references>
<identifierReference identifier="getdemo"/>
</references>
</command>
<command name="getdemo">
<arguments>
<argument token="X" description="number in list"/>
<argument token="P" description="subpath (optional)"/>
</arguments>
<references>
<identifierReference identifier="listdemos"/>
</references>
</command>
<command name="dropflag">
<description>Drops the enemy flag.</description>
</command>
<command name="drawbeamtobots">
<description>Draws a shooting line in the direction of all available bots.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
<remarks>
<remark>This is a debugging command and only works for single player modes.</remark>
</remarks>
</command>
<command name="crouch"/>
<command name="addbot">
<description>add a bot for a given team with a given skill calling him a given name.</description>
<arguments>
<argument token="T" description="team" valueNotes="RVSF or CLA"/>
<argument token="S" description="skill" valueNotes="best, good, medium, worse OR bad"/>
<argument token="N" description="name" valueNotes="name for the bot"/>
</arguments>
<remarks>
<remark>This command only works for single player modes.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[addbot RVSF medium Robbie]]></code>
<explanation>Will add a bot named Robbie with a medium skill level to the RVSF team.</explanation>
</example>
</examples>
</command>
<command name="addnbot">
<description>will add a given count of bots for the given team with the given skill and select random names for them.</description>
<arguments>
<argument token="C" description="count" valueNotes="how many bots to add"/>
<argument token="T" description="team" valueNotes="RVSF or CLA"/>
<argument token="S" description="skill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<remarks>
<remark>This command only works for single player modes.</remark>
<remark>The name of the bots will be selected randomly.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[addnbot 2 CLA bad]]></code>
<explanation>Will add 2 bots with a bad skill level to the CLA team.</explanation>
</example>
</examples>
</command>
<command name="botskill">
<description>changes the skill level for the given bot.</description>
<arguments>
<argument token="N" description="botname" valueNotes="the name of the bot"/>
<argument token="S" description="botskill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<examples>
<example>
<code><![CDATA[botskill Robbie best]]></code>
<explanation>Changes the previous bot skill level of the bot named Robbie to a 'best' skill level.</explanation>
</example>
</examples>
</command>
<command name="botskillall">
<description>changes the skill level for all bots.</description>
<arguments>
<argument token="S" description="botskill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<examples>
<example>
<code><![CDATA[botskillall worse]]></code>
<explanation>Changes the previous bot skill level for all bots to a 'worse' skill level.</explanation>
</example>
</examples>
</command>
<command name="botsshoot">
<description>Enables or disables the ability of the bots to fire their weapons</description>
<arguments>
<argument token="T" description="shooting bots?" valueNotes="0||1"/>
</arguments>
<examples>
<example>
<code><![CDATA[botsshoot 0]]></code>
<explanation>Bots won't shoot.</explanation>
</example>
</examples>
</command>
<command name="changefollowplayer">
<arguments>
<argument token="D" description="delta" valueNotes="how many players to shift +/-"/>
</arguments>
</command>
<command name="alive">
<description>Returns 1 if the local player is alive.</description>
<examples>
<example>
<code><![CDATA[echo (alive)]]></code>
<explanation>Output: 1</explanation>
</example>
</examples>
</command>
<command name="curmap">
<description>Returns the current map being played.</description>
<remarks>
<remark>If you pass it a non-zero value, the result will be path-less.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[echo playing: (curmap) vote for: (curmap 1)]]></code>
<explanation>output: playing maps/ac_complex vote for: ac_complex</explanation>
</example>
</examples>
<references>
<identifierReference identifier="curmode"/>
<identifierReference identifier="map"/>
<identifierReference identifier="mode"/>
</references>
<arguments>
<argument token="I" description="clean" valueNotes="0, 1"/>
</arguments>
</command>
<command name="curmode">
<description>Returns the mode number for the current game.</description>
<references>
<identifierReference identifier="curmap"/>
<identifierReference identifier="map"/>
<identifierReference identifier="mode"/>
</references>
</command>
<variable name="curmaprevision">
<description>Current map revision number.</description>
<value description="-" minValue="1" maxValue="0" defaultValue="1" readOnly="true"/>
</variable>
<command name="curmodeattr">
<description>Checks the current game mode for certain attributes.</description>
<arguments>
<argument token="A" description="attribute name"/>
</arguments>
<remarks>
<remark>Possible attributes are: team, arena, flag and bot.</remark>
</remarks>
</command>
<command name="getclientmode">
<description>Returns the current game mode number.</description>
</command>
<command name="curmastermode">
<description>Returns the current mastermode</description>
</command>
<command name="currentprimary">
<description>Returns the weapon-index the local player currently has selected as primary.</description>
<remarks>
<remark>This is not the same as curweapon - which could be a grenade or the knife.</remark>
</remarks>
<references>
<identifierReference identifier="nextprimary"/>
<identifierReference identifier="curweapon"/>
<identifierReference identifier="prevweapon"/>
<identifierReference identifier="weapon"/>
<identifierReference identifier="magcontent"/>
<identifierReference identifier="magreserve"/>
</references>
</command>
<command name="currole">
<description>Returns 1 if the local player has admin privileges, 0 otherwise.</description>
<references>
<identifierReference identifier="setadmin"/>
<identifierReference identifier="connectadmin"/>
</references>
</command>
<command name="curserver">
<description>Returns information on the current server - if you're connected to one.</description>
<remarks>
<remark>If I is 0 (omitted or any other value than the ones below) you will get a string with 'IP PORT'</remark>
<remark>If I is 1,2 or 3 you will get the IP, HostName or port respectively.</remark>
<remark>If I is 4 you get a string representing the current state of the peer - usually this should be 'connected'.</remark>
</remarks>
<arguments>
<argument token="I" description="info" valueNotes="0, 1, 2, 3 or 4"/>
</arguments>
<examples>
<example>
<code><![CDATA[echo [I am (curserver 4) to (curserver 2)]]]></code>
<explanation>Output: I am connected to ctf-only.assault-servers.net</explanation>
</example>
<example>
<code>
<![CDATA[last_server = ""
remember_server = [ if (strcmp (curserver 4) "connected")
[ last_server = (curserver 0) echo "I'm remembering:" $last_server ]
[ echo "you are not 'connected' - you" (concatword "are '" (curserver 4) "' !") ] ]
bind PRINT [ if (strcmp $last_server "") [ remember_server ]
[ say (concat "^L2I was just ^Lfon^L3" $last_server) last_server = "" ] ]]]>
</code>
<explanation>This will either remember or retrieve the last server you pressed the PrintScreen-key on.</explanation>
</example>
</examples>
</command>
<command name="curteam">
<description>Returns 1 if the local player is on the RVSF team, 0 if on CLA.</description>
<references>
<identifierReference identifier="team"/>
<identifierReference identifier="skin"/>
</references>
</command>
<command name="curweapon">
<description>Returns the weapon-index the local player is currently holding.</description>
<references>
<identifierReference identifier="currentprimary"/>
<identifierReference identifier="nextprimary"/>
<identifierReference identifier="prevweapon"/>
<identifierReference identifier="weapon"/>
<identifierReference identifier="magcontent"/>
<identifierReference identifier="magreserve"/>
</references>
</command>
<command name="prevweapon">
<description>Returns the weapon-index the local player was previously holding.</description>
<references>
<identifierReference identifier="currentprimary"/>
<identifierReference identifier="nextprimary"/>
<identifierReference identifier="curweapon"/>
<identifierReference identifier="weapon"/>
<identifierReference identifier="magcontent"/>
<identifierReference identifier="magreserve"/>
</references>
</command>
<variable name="hidecustomskins">
<value token="B" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="mdldyncache">
<value token="V" description="" minValue="1" maxValue="32" defaultValue="2"/>
</variable>
<variable name="mdlstatcache">
<value token="V" description="" minValue="1" maxValue="32" defaultValue="1"/>
</variable>
<command name="map">
<description>Loads up a map in the gamemode set previously by the 'mode' command.</description>
<remarks>
<remark>
If connected to a multiplayer server, it votes to load the map (others will have to type "map M" as well
to agree with loading this map). To vote for a map with a specific mode, set the mode before you issue the map command.
</remark>
<remark>
A map given as "blah" refers to "packages/maps/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz".
At every map load, "config/default_map_settings.cfg" is loaded which sets up all texture definitions, etc. Everything
defined there can be overridden per package or per map by creating a "mapname.cfg" which
contains whatever you want to do differently from the default.
</remark>
<remark>
When the map finishes it will load the next map when one is defined, otherwise it reloads the current map.
You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2
(loads "blah2" after "blah1").
</remark>
</remarks>
<arguments>
<argument token="M" description="Name of the map to load" valueNotes="string"/>
</arguments>
</command>
<command name="nextprimary">
<description>Returns the primary weapon on next respawn.</description>
<arguments>
<argument token="A" description="weapon id" valueNotes="value"/>
</arguments>
</command>
<command name="reload">
<description>Reloads the weapon.</description>
<arguments>
<argument token="A" description="" valueNotes="value"/>
</arguments>
</command>
<command name="skin">
<description>Determines the skin of the current player.</description>
<remarks>
<remark>See the player model folder for the according skin-id.</remark>
</remarks>
<arguments>
<argument token="N" description="skin id" valueNotes="value"/>
</arguments>
</command>
<command name="skin_cla">
<description>Choose skin when playing for team CLA.</description>
<arguments>
<argument token="N" description="skin id"/>
</arguments>
</command>
<command name="skin_rvsf">
<description>Choose skin when playing for team RVSF.</description>
<arguments>
<argument token="N" description="skin id"/>
</arguments>
</command>
<command name="name">
<description>Sets the nick name for the local player.</description>
<arguments>
<argument token="N" description="the name"/>
</arguments>
</command>
<command name="say">
<description>Outputs text to other players.</description>
<remarks>
<remark>
If the text begins with a percent character (%),
only team mates will receive the message.
</remark>
</remarks>
<arguments>
<variableArgument token="S..." description="the text"/>
</arguments>
</command>
<command name="ignore">
<description>Ignore a player.</description>
<arguments>
<argument token="A" description="client number"/>
</arguments>
<remarks>
<remark>You won't see any further game chat or hear any more voice com messages from that player.</remark>
</remarks>
</command>
<command name="listignored">
<description>Print a list of all players that you are currently ignoring.</description>
</command>
<command name="clearignored">
<description>Clear list of ignored players.</description>
<arguments>
<argument token="A" description="optional client number"/>
</arguments>
<remarks>
<remark>Omit the client number to clear the whole list.</remark>
</remarks>
</command>
<command name="muteplayer">
<description>Mute a player</description>
<arguments>
<argument token="A" description="client number"/>
</arguments>
<remarks>
<remark>You won't hear any further voice com messages from that player.</remark>
</remarks>
</command>
<command name="clearmuted">
<description>Clear list of muted players.</description>
<arguments>
<argument token="A" description="optional client number"/>
</arguments>
<remarks>
<remark>Omit the client number to clear the whole list.</remark>
</remarks>
</command>
<command name="listmuted">
<description>Print a list of all players that you have muted.</description>
</command>
<command name="me">
<description>Action chat message.</description>
<arguments>
<variableArgument token="..." description="..."/>
</arguments>
</command>
<command name="saycommand">
<description>Puts a prompt on screen.</description>
<remarks>
<remark>
this puts a prompt on screen that you can type into,
and will capture all keystrokes until you press return (or ESC to cancel).
If what you typed started with a "/", the rest of it will be executed as a command,
otherwise its something you "say" to all players.
</remark>
</remarks>
<defaultKeys>
<key alias="T" description="opens empty prompt"/>
<key alias="BACKQUOTE" name="`" description="opens a command prompt /"/>
<key alias="TAB" description="autocompletes commands/variables/aliases"/>
<key alias="UP" description="browse command history forwards"/>
<key alias="DOWN" description="browse command history backwards"/>
</defaultKeys>
<arguments>
<variableArgument token="S..." description="the text to display in the prompt" optional="true"/>
</arguments>
<references>
<identifierReference identifier="complete"/>
<identifierReference identifier="listcomplete"/>
<identifierReference identifier="inputcommand"/>
</references>
</command>
<command name="inputcommand">
<description>Makes an input perform a certain command.</description>
<arguments>
<argument token="I" description="input"/>
<argument token="C" description="command"/>
<argument token="P" description="prompt"/>
</arguments>
<references>
<identifierReference identifier="complete"/>
<identifierReference identifier="listcomplete"/>
<identifierReference identifier="saycommand"/>
</references>
<examples>
</examples>
</command>
<command name="complete">
<arguments>
<argument token="C" description="command" valueNotes="any command or alias"/>
<argument token="P" description="path" valueNotes="path to search"/>
<argument token="E" description="extension" valueNotes="extension to match"/>
</arguments>
<remarks>
<remark>The completion will work on the first word of your console input.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[complete demo "demos" dmo]]></code>
<explanation>If you enter "/demo " and press TAB you will cycle through all available demos.</explanation>
</example>
<example>
<code><![CDATA[alias mapcomplete [complete $arg1 "packages/maps" cgz]]]></code>
<explanation>helper alias for quickly adding complete-definitions for all gamemodes - see config/script.cfg (below "Auto-Completions")</explanation>
</example>
</examples>
<references>
<identifierReference identifier="saycommand"/>
<identifierReference identifier="listcomplete"/>
</references>
</command>
<command name="listcomplete">
<argument token="A" description="" valueNotes="value"/>
<references>
<identifierReference identifier="saycommand"/>
<identifierReference identifier="complete"/>
</references>
</command>
<command name="nickcomplete">
<argument token="C" description="command" valueNotes="any command or alias"/>
<description>adds a command to complete nicknames on</description>
<remarks>
<remark>your own nick will be ignored</remark>
</remarks>
<examples>
<example>
<code><![CDATA[nickgreet = [ say (concat "Hello," (concatword $arg1 "!")) ]; nickcomplete nickgreet]]></code>
<explanation>with this you can enter "/nickgreet " and cycle via TAB to the nickname you want to greet.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="complete"/>
</references>
</command>
<command name="connect">
<description>Connects to a server.</description>
<remarks>
<remark>
If the server name is omitted, the client will try to connect to an available server in the LAN.
If the port is omitted or set to 0, the default port will be used.
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[connect 127.0.0.1 555 myServerPassword]]></code>
</example>
</examples>
<references>
<identifierReference identifier="connectadmin"/>
</references>
<arguments>
<argument token="N" description="the address of the server (hostname or IP)" optional="true"/>
<argument token="O" description="the port" optional="true"/>
<argument token="P" description="the server password" optional="true"/>
</arguments>
</command>
<command name="connectadmin">
<description>Connects to a server and tries to claim admin state.</description>
<remarks>
<remark>
This command will connect to a server just like the command 'connect' and
try to claim admin state. If the specified password is correct, the admin
will be able to connect even if he is locked out by ban, private master mode or taken client slots.
If successfully connected, bans assigned to the admin's host will be removed automatically. If all
client slots are taken a random client will be kicked to let the admin in.
</remark>
<remark>
If the server name ist omitted, the client will try to connect to an available server in the LAN.
If the port is omitted or set to 0, the default port will be used.
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[connectadmin 127.0.0.1 777 myAdminPassword]]></code>
<explanation>connect as admin on port 777 of localhost</explanation>
</example>
<example>
<code><![CDATA[connectadmin "" 0 myAdminPassword]]></code>
<explanation>will try to connect to a LAN server on the default port as admin with the given password of "myAdminPassword".</explanation>
</example>
</examples>
<references>
<identifierReference identifier="currole"/>
<identifierReference identifier="connect"/>
</references>
<arguments>
<argument token="N" description="the address of the server (hostname or IP)" optional="true"/>
<argument token="O" description="the port" optional="true"/>
<argument token="P" description="the admin password"/>
</arguments>
</command>
<command name="disconnect">
<description>Leaves a server.</description>
</command>
<command name="team">
<description>Sets the team for the local player.</description>
<examples>
<example>
<code><![CDATA[team CLA]]></code>
</example>
</examples>
<arguments>
<argument token="S" description="the team name" valueNotes="either CLA or RVSF"/>
</arguments>
</command>
<command name="benchme">
<description>Move from active team to spectator during match.</description>
</command>
<command name="modconnect">
<description>Connect to a modded server.</description>
<arguments>
<argument token="A" description="IP"/>
<argument token="B" description="port"/>
<argument token="C" description="password"/>
</arguments>
<remarks>
<remark>
The modified server needs to use the original client-server protocol. The protocol version number
will be the negated value of an unmodded server.
</remark>
</remarks>
</command>
<command name="modconnectadmin">
<description>Connect to a modded server and claim admin.</description>
<arguments>
<argument token="A" description="IP"/>
<argument token="B" description="port"/>
<argument token="C" description="admin password"/>
</arguments>
<remarks>
<remark>
The modified server needs to use the original client-server protocol. The protocol version number
will be the negated value of an unmodded server.
</remark>
</remarks>
</command>
<command name="modlanconnect">
<description>Connect to a modified LAN server.</description>
<remarks>
<remark>
The modified server needs to use the original client-server protocol. The protocol version number
will be the negated value of an unmodded server.
</remark>
</remarks>
</command>
<command name="showscores">
<description>Shows or hides the scores.</description>
<defaultKeys>
<key alias="TAB"/>
</defaultKeys>
</command>
<command name="weapon">
<description>Changes the weapon.</description>
<arguments>
<argument token="N" description="the weapon number" valueNotes="0 (knife), 1 (pistol), 2 (shotgun), 3 (sub), 4 (sniper), 5 (assault), 6 (grenades)"/>
</arguments>
</command>
<command name="magcontent">
<description>Returns contents of current magazine.</description>
<remarks>
<remark>A knife will always return 1.</remark>
<remark>Weapons that aren't available will return -1.</remark>
</remarks>
<examples>
<example>
<code>
<![CDATA[wnames = "Knife Pistol Shotgun Sub Sniper Assault Grenades"
numtwo = [ if (< $arg1 10) [ result (concatword 0 $arg1) ] [ result $arg1 ] ]
ammoinfo = [
loop w (listlen $wnames) [
mc = (magcontent $w)
mr = (magreserve $w)
mt = (+ $mr $mc)
if (> $mt 0) [ echo (numtwo $mc) "/" (numtwo $mr) ":" (at $wnames $w) ]
]
]
Output:
01 / 01 : Knife
08 / 64 : Pistol
30 / 60 : Sub]]>
</code>
</example>
</examples>
<references>
<identifierReference identifier="curweapon"/>
<identifierReference identifier="currentprimary"/>
<identifierReference identifier="nextprimary"/>
<identifierReference identifier="prevweapon"/>
<identifierReference identifier="weapon"/>
<identifierReference identifier="magreserve"/>
</references>
<arguments>
<argument token="N" description="the weapon number" valueNotes="0 (knife), 1 (pistol), 2 (shotgun), 3 (sub), 4 (sniper), 5 (assault), 6 (grenades)"/>
</arguments>
</command>
<command name="magreserve">
<description>Returns contents of magazine reserve.</description>
<references>
<identifierReference identifier="curweapon"/>
<identifierReference identifier="currentprimary"/>
<identifierReference identifier="nextprimary"/>
<identifierReference identifier="prevweapon"/>
<identifierReference identifier="weapon"/>
<identifierReference identifier="magcontent"/>
</references>
<arguments>
<argument token="N" description="the weapon number" valueNotes="0 (knife), 1 (pistol), 2 (shotgun), 3 (sub), 4 (sniper), 5 (assault), 6 (grenades)"/>
</arguments>
</command>
<command name="getmap">
<description>Retrieves the last map that was sent to the server using 'sendmap'.</description>
<references>
<identifierReference identifier="sendmap"/>
</references>
</command>
<command name="spectatemode">
<description>Toggle into spectator mode - only possible when you're dead!</description>
<defaultKeys>
<key alias="SPACE" description="switch spectator mode"/>
<key alias="MOUSE4" description="next player"/>
<key alias="MOUSE5" description="previous player"/>
</defaultKeys>
</command>
<command name="stopdemo">
<description>Stops any demo recording or playback.</description>
</command>
<command name="watchingdemo">
<description>Returns 1 when the current game is being played from a demo, else 0.</description>
<examples>
<example>
<code><![CDATA[echo I am (at [not now] (watchingdemo)) watching a demo. "so, are you?"]]></code>
</example>
</examples>
<return token="B" description="truth value"/>
</command>
<command name="suicide">
<description>Kills your player. You will lose 1 frag point and gain 1 death point when using this command.</description>
</command>
<command name="demo">
<description>Plays a recorded demo.</description>
<remarks>
<remark>Playback is interpolated for the player whose perspective you view.</remark>
</remarks>
<arguments>
<argument token="S" description="the demo name"/>
</arguments>
</command>
<variable name="xhairwpsel">
<description>Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player.</description>
<value token="V" description="Note: This is turned on by default." minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="minutesremaining">
<description>Returns the remaining minutes of the currently played game. READ ONLY</description>
<references>
<identifierReference identifier="gametimecurrent"/>
<identifierReference identifier="gametimemaximum"/>
<identifierReference identifier="lastgametimeupdate"/>
<identifierReference identifier="millis"/>
</references>
</variable>
<variable name="gametimecurrent">
<description>Returns the time (in milliseconds) of the currently played game. READ ONLY</description>
<examples>
<example>
<code><![CDATA[showtime = [
if (> $lastgametimeupdate 0) [
gmr = (- $gametimemaximum (+ $gametimecurrent (- (millis) $lastgametimeupdate)))
gsr = (div $gmr 1000)
gts = (mod $gsr 60)
if (< $gts 10) [ gts = (concatword 0 $gts) ] [ ]
gtm = (div $gsr 60)
if (< $gtm 10) [ gtm = (concatword 0 $gtm) ] [ ]
echo (concatword $gtm : $gts) remaining
] [
echo gametime not updated yet
]
]]]></code>
</example>
</examples>
<references>
<identifierReference identifier="minutesremaining"/>
<identifierReference identifier="gametimemaximum"/>
<identifierReference identifier="lastgametimeupdate"/>
<identifierReference identifier="millis"/>
</references>
</variable>
<variable name="gametimemaximum">
<description>Returns the maximum time (in milliseconds) of the currently played game. READ ONLY</description>
<references>
<identifierReference identifier="minutesremaining"/>
<identifierReference identifier="gametimecurrent"/>
<identifierReference identifier="lastgametimeupdate"/>
<identifierReference identifier="millis"/>
</references>
</variable>
<variable name="lastgametimeupdate">
<description>Returns the last time (in milliseconds) the gametime was updated. READ ONLY</description>
<references>
<identifierReference identifier="minutesremaining"/>
<identifierReference identifier="gametimecurrent"/>
<identifierReference identifier="gametimemaximum"/>
<identifierReference identifier="millis"/>
</references>
</variable>
<variable name="paused">
<description>Determines if the game should be paused.</description>
<value token="B" description="pause game" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="autoreload">
<description>Indicates if the weapons should be reloaded automatically.</description>
<value token="B" description="the autoreload state" minValue="0" maxValue="1" defaultValue="1" valueNotes="on (1), off (0)"/>
</variable>
<variable name="scopefov">
<description>Determines the FOV when scoping.</description>
<references>
<identifierReference identifier="fov"/>
</references>
<value token="V" description="" minValue="5" maxValue="50" defaultValue="50"/>
</variable>
<variable name="showmap">
<description>Determines if the mini-map should be shown on screen.</description>
<value token="B" description="show mini-map" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="showscoresondeath">
<description>Determines if scores should be shown on death.</description>
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="footsteps">
<description>Indicates if the footsteps sound should be played</description>
<value token="B" description="enable footsteps" minValue="0" maxValue="1" defaultValue="1" valueNotes="1 (true), 0 (false)"/>
</variable>
<variable name="localfootsteps">
<description>Indicates if the footsteps sound for the local player should be played</description>
<value token="B" description="enable footsteps" minValue="0" maxValue="1" defaultValue="1" valueNotes="1 (true), 0 (false)"/>
</variable>
<variable name="footstepalign">
<description>Maximum time span between player animation and the playback of the footstep sound</description>
<remarks>
<remark>
If the footstep sound would be played immediately when entering the radius of the other player, it would
not be synchronous to the player model animation.
</remark>
</remarks>
<value token="T" description="time span" minValue="5" maxValue="4000" defaultValue="15"/>
</variable>
<variable name="gamespeed">
<description>Sets the gamespeed in percent.</description>
<remarks>
<remark>This does not work in multiplayer. For entertainment purposes only :)</remark>
</remarks>
<value token="N" description="the game speed" minValue="10" maxValue="1000" defaultValue="100"/>
</variable>
</identifiers>
</section>
<!-- Gameplay Section Ends -->
<!-- Editing Section Starts -->
<section name="Editing" sortindex="09">
<identifiers sort="true">
<command name="togglegrap">
<description>Will toggle the focus of the mouse in game. Normally you can use your mouse to look around, when you type this command your mouse cursor is visible and can be used as normally. This is only useful when you run cube windowed, of course.</description>
</command>
<command name="getentattr">
<argument token="A" description="attribute" valueNotes="0..3"/>
</command>
<command name="getenttype"/>
<command name="edittag">
<arguments>
<argument token="T" description="tag" valueNotes="integer value"/>
</arguments>
</command>
<command name="setjumpwp">
<references>
<identifierReference identifier="unsetjumpwp"/>
</references>
</command>
<command name="unsetjumpwp">
<references>
<identifierReference identifier="setjumpwp"/>
</references>
</command>
<command name="wpclear"/>
<command name="wpflood"/>
<command name="wpinfo">
<description>makes waypoints visible and either turns on or off the waypoint information display.</description>
<arguments>
<argument token="Y" description="show info?" valueNotes="0||1"/>
</arguments>
</command>
<command name="wpload"/>
<command name="wpsave"/>
<command name="wpvisible">
<arguments>
<argument token="V" description="visible" valueNotes="0||1"/>
</arguments>
</command>
<command name="setwpyaw">
<description>takes the current player yaw for the current waypoint</description>
</command>
<command name="telebot">
<description>teletransports the bot with the lowest connection number to you current position.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
<remarks>
<remark>This is a debugging command and only works for single player modes.</remark>
</remarks>
</command>
<command name="togglebotview">
<description>When used you will see what the bot sees. Type it again (with or without name) to return to the game(you will respawn).</description>
<arguments>
<argument token="N" description="botname" valueNotes="the name of the bot"/>
</arguments>
</command>
<command name="testvisible">
<arguments>
<argument token="D" description="direction" valueNotes="0..5 for Forward, Backward, Left, Right, Up AND Down"/>
</arguments>
</command>
<command name="addpath1way1"/>
<command name="addpath1way2"/>
<command name="addpath2way1"/>
<command name="addpath2way2"/>
<command name="addwp">
<argument token="A" description="autoconnect" valueNotes="0||1"/>
</command>
<command name="autowp">
<argument token="O" description="on" valueNotes="0||1"/>
</command>
<command name="delpath1way1"/>
<command name="delpath1way2"/>
<command name="delpath2way1"/>
<command name="delpath2way2"/>
<command name="delwp"/>
<command name="applymapsoundchanges">
<description>during map editing, drop all mapsounds so they can be re-added</description>
</command>
<variable name="editing">
<value token="V" description="" minValue="1" maxValue="0" defaultValue="0"/>
</variable>
<command name="edittoggle">
<description><![CDATA[switches between map edit mode and normal.]]></description>
<remarks>
<remark>
In map edit mode you can select bits of the map by clicking or dragging your crosshair on the floor
or ceiling (using the "attack" identifier, normally MOUSE1), then use the identifiers below to
modify the selection. While in edit mode, normal physics and collision don't apply (clips), and key repeat is ON.
Note that if you fly outside the map, cube still renders the world as if you were standing on the floor
directly below the camera.
</remark>
<remark>Hotkey E</remark>
</remarks>
<references>
<identifierReference name="select" identifier="select"/>
<wikiReference article="Coopedit"/>
</references>
</command>
<command name="edittex">
<description><![CDATA[Changes the texture on current selection by browsing through a list of textures directly shown on the cubes.]]></description>
<remarks>
<remark>
Default keys are the six keys above the cursor keys, which each 2 of them cycle one type (and numpad 7/4 for upper).
</remark>
<remark>
The way this works is slightly strange at first, but allows for very fast texture assignment. All textures are in 3 individual lists for each type (both wall kinds treated the same), and each time a texture is used, it is moved to the top of the list. So after a bit of editing, all your most frequently used textures will come first when pressing these keys, and the most recently used texture is set immediately when you press the forward key for the type. These lists are saved with the map. make a selection (including wall bits) and press these keys to get a feel for what they do.
</remark>
</remarks>
<arguments>
<argument token="T" description="an integer denoting the type" valueNotes="0 (floor), 1 (lower or wall), 2 (ceiling), 3 (upper wall)"/>
<argument token="D" description="the direction you want to cycle the textures in" valueNotes="1 (forwards), -1 (backwards)"/>
</arguments>
</command>
<command name="editheight">
<description><![CDATA[Changes the height of the current selection.]]></description>
<remarks>
<remark>Default keys are [ and ] for floor level, and o/p for ceiling.</remark>
</remarks>
<arguments>
<argument token="T" description="an integer denoting the type" valueNotes="0 (floor), 2 (ceiling)"/>
<argument token="D" description="the delta value to move it in" valueNotes="1 (forwards), -1 (backwards)"/>
</arguments>
</command>
<command name="solid">
<description>makes the current selection all solid (i.e. wall) or all non-solid.</description>
<remarks>
<remark>
This operation retains floor/ceiling heights/textures while swapping between the two. Default keys f and g respectively.
</remark>
</remarks>
<arguments>
<argument token="B" description="an integer denoting the solid-ness" valueNotes="0 (non-solid), 1..* (solid)"/>
</arguments>
</command>
<command name="equalize">
<description>Levels the floor/ceiling of the selection.</description>
<remarks>
<remark>default keys , and .</remark>
</remarks>
<arguments>
<argument token="T" description="an integer denoting the type" valueNotes="0 (floor), 2 (ceiling)"/>
</arguments>
</command>
<command name="heightfield">
<description>Marks the current selection as a heightfield.</description>
<remarks>
<remark>
marks the current selection as a heightfield, with T being floor or ceiling, as above.
A surface marked as heightfield will use the vdelta values (see below) of its 4 corners to create a sloped surface.
To mark a heightfield as normal again (ignoring vdelta values, set or not) use "solid 0".
Default keys are h (floor) and i (ceiling).
</remark>
<remark>
Heightfields should be made the exact size that is needed, not more not less.
The most important reason for this is that cube automatically generates "caps" (side-faces for heightfields)
only on the borders of the heightfield. This also means if you have 2 independent heightfields accidentally
touch each other, you will not get correct caps. Also, a heightfield is slightly slower to render than a
non-heightfield floor or ceiling. Last but not least, a heightfield should have all the same baseheight
(i.e. the height determined by a normal editheight operation) to get correct results.
</remark>
</remarks>
<references>
<identifierReference name="vdelta" identifier="vdelta"/>
</references>
<arguments>
<argument token="T" description="an integer denoting the type" valueNotes="0 (floor), 2 (ceiling)"/>
</arguments>
</command>
<command name="vdelta">
<description>changes the vdelta value of the current selection</description>
<remarks>
<remark>
Note that unlike all other editing functions, this function doesn't affect a cube, but its top-left vertex
(market by the dot in the editing cursor). So to edit a N * M heightfield, you will likely have to edit
the vdelta of (N+1) * (M+1) cubes, i.e. you have to select 1 row and 1 column more in the opposite direction
of the red dot to affect all the vertices of a heightfield of a given size (try it, it makes sense :)
</remark>
<remark>
A floor delta offsets vertices to beneath the level set by editheight (and a ceil delta to above). Delta offsets have a precision of a quarter of a unit, however you should use non-unitsize vertices only to touch other such vertices. Default keys are 8 and 9 to decrease/increase the vdelta.
</remark>
</remarks>
<arguments>
<argument token="N" description="vdelta value"/>
</arguments>
</command>
<command name="corner">
<description>Makes the current selection into a "corner".</description>
<remarks>
<remark>
Currently there is only one type of corner (a 45 degree one), only works on a single unit (cube) at a time.
It can be positioned either next to 2 solid walls or
in the middle of 2 higher floorlevels and 2 lower ones forming a diagonal (and similar with ceiling).
</remark>
<remark>
In both cases, the corner will orient itself automatically depending on its neighbours, behaviour with other
configurations than the 2 above is unspecified. Since the latter configuration generates possibly 2 floor and
2 ceiling levels, up to 4 textures are used: for example for the 2 floors the higher one will of the cube
itself, and the lower one of a neighbouring low cube. You can make bigger corners at once by
issuing "corner" on grid aligned 2x2/4x4/8x8 selections, with equal size solid blocks next to them.
</remark>
</remarks>
<defaultKeys>
<key alias="K"/>
</defaultKeys>
</command>
<command name="undo">
<description>Multi-level undo of any of the changes caused by editing operations</description>
<remarks>
<remark>hotkey u</remark>
</remarks>
</command>
<command name="undomegs">
<description>Sets the number of megabytes used for the undo buffer.</description>
<remarks>
<remark>
undo's work for any size areas, so the amount of undo steps per megabyte is more for small areas
than for big ones (a megabyte fits 280 undo steps on a 16x16 area, but only 4 steps on a 128x128 area).
</remark>
</remarks>
<arguments>
<argument token="N" description="number of megabytes, default is 1" valueNotes="integer"/>
</arguments>
</command>
<command name="copy">
<description>Copies the current selection into a buffer.</description>
<remarks>
<remark>hotkey c</remark>
</remarks>
</command>
<command name="paste">
<description>Pastes a previously copied selection.</description>
<remarks>
<remark>
To paste a selection back requires a same size selection at the destination location. If it is not the same
size the selection will be resized automatically prior to the paste operation (with the red dot as anchor),
which is easier for large selections.
</remark>
<remark>hotkey v</remark>
</remarks>
</command>
<command name="replace">
<description>Repeats the last texture edit throughout the map.</description>
<remarks>
<remark>
The way it works is intuitive: simply edit any texture anywhere, then using "replace" will replace
all textures throughout the map in the same way (taking into account whether it was a floor/wall/ceil/upper too).
If the there was more than one "old" texture in your selection, the one nearest to the red dot is used.
This operation can't be undone.
</remark>
</remarks>
</command>
<command name="newent">
<description>Adds a new entity</description>
<remarks>
<remark>
(x,y) is determined by the current selection (the red dot corner) and z by the camera height, of said type.
Type is a string giving the type of entity, such as "light", and may optionally take values (depending on the entity).
</remark>
</remarks>
<arguments>
<argument token="type" description="the entity type" valueNotes="light, sound, clip, plclip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag, helmet"/>
<argument token="value1" description="see newent 'type'"/>
<argument token="value2" description="see newent 'type'"/>
<argument token="value3" description="see newent 'type'"/>
<argument token="value4" description="see newent 'type'"/>
</arguments>
</command>
<command name="newent light">
<description>Adds a new light entity</description>
<remarks>
<remark>if only argument R is specified, it is interpreted as brightness for white light.</remark>
</remarks>
<arguments>
<argument token="radius" description="the light radius" valueNotes="1..32"/>
<argument token="R" description="red colour component. see remarks below." valueNotes="1..255"/>
<argument token="G" description="green colour component" valueNotes="1..255"/>
<argument token="B" description="blue colour component" valueNotes="1..255"/>
</arguments>
</command>
<command name="newent playerstart">
<description>Adds a new spawn spot.</description>
<remarks>
<remark>The yaw is taken from the current camera yaw.</remark>
</remarks>
</command>
<command name="newent ammobox">
<description>Adds a new ammo box item.</description>
</command>
<command name="newent pistol">
<description>Adds a pistol magazine item.</description>
</command>
<command name="newent grenades">
<description>Adds a new grenades item.</description>
</command>
<command name="newent health">
<description>Adds a new health item.</description>
</command>
<command name="newent armour">
<description>Adds a new armour item.</description>
</command>
<command name="newent helmet">
<description>Adds a new helmet item.</description>
</command>
<command name="newent akimbo">
<description>Adds a new akimbo item.</description>
</command>
<command name="newent mapmodel">
<description>Adds a map model to the map (i.e. a rendered md2/md3 model which you collide against but has no behaviour or movement)</description>
<remarks>
<remark>
The mapmodel identifier is the desired map model which is defined by the 'mapmodel' command. The order in which
the mapmodel is placed in the map config file defines the mapmodel identifier.
The map texture refers to a texture which is defined by the 'texture' command, if omitted the
models default skin will be used. The 'mapmodel' and 'texture' commands are placed in the map config normally.
Mapmodels are more expensive than normal map geometry, so do not use insane amounts of them to replace normal geometry.
</remark>
</remarks>
<arguments>
<argument token="N" description="The mapmodel identifier" valueNotes="Integer"/>
<argument token="Z" description="Extra elevation above ground" valueNotes="Integer"/>
<argument token="T" description="The map texture to use (optional)" valueNotes="Integer"/>
</arguments>
</command>
<command name="newent ctf-flag">
<description>Adds a CTF flag entity.</description>
<remarks>
<remark>Note that this entity is only rendered as flag if the current game mode is CTF.</remark>
</remarks>
<arguments>
<argument token="T" description="denotes the flag's team" valueNotes="0 (CLA), 1 (RVSF)"/>
</arguments>
</command>
<command name="newent ladder">
<description>Adds a ladder entity.</description>
<remarks>
<remark>
Note that this entity is used for physics only, to create a visual ladder you
will need to add a mapmodel entity too.
</remark>
</remarks>
<references>
<identifierReference name="newent mapmodel" identifier="newent mapmodel"/>
</references>
<arguments>
<argument token="H" description="the height of the ladder" valueNotes="integer"/>
</arguments>
</command>
<command name="newent sound">
<description>Adds a sound entity.</description>
<remarks>
<remark>
Will play map-specific sound so long as the player is within the radius.
However, only up to the max uses allowed for N (specified in the mapsound command) will play, even if the player is within the radius of more N sounds than the max.
By default (size 0), the sound is a point source. Its volume is maximal at the entity's location, and tapers off to 0 at the radius. If size is specified,
the volume is maximal within the specified size, and only starts tapering once outside this distance. Radius is always defined as distance from the entity's location,
so a size greater than or equal to the radius will just make a sound that is always max volume within the radius, and off outside.
</remark>
<remark>
A sound entity can be either ambient or non-ambient. Ambient sounds have no specific direction, they are 'just there'. Non-ambient sounds however appear to come from a specific direction (stereo panning).
If S is set to 0, the sound is a single point and will therefore be non-ambient. However if S is greater than 0, the sound will be ambient as it covers a specified area instead of being a single point.
</remark>
</remarks>
<references>
<identifierReference identifier="mapsound"/>
</references>
<arguments>
<argument token="N" description="the sound to play" valueNotes="integer"/>
<argument token="R" description="the radius"/>
<argument token="S" description="the size" optional="true" valueNotes="default 0"/>
<argument token="V" description="the volume" optional="true" valueNotes="default 255"/>
</arguments>
</command>
<command name="newent clip">
<description>Adds a clip entity.</description>
<remarks>
<remark>Defines a clipping box against which the player will collide.</remark>
<remark>
Use this clip type to clip visible obstacles like fences or the gas tank. If you only want to prevent a player from entering an area, use plclip instead.
</remark>
</remarks>
<arguments>
<argument token="Z" description="elevation above the ground" valueNotes="integer"/>
<argument token="X" description="X radius around the box center" valueNotes="integer"/>
<argument token="Y" description="Y radius around the box center" valueNotes="integer"/>
<argument token="H" description="height of the box" valueNotes="integer"/>
</arguments>
</command>
<command name="ambientsoundvol">
<description>Deletes the entity closest to the player</description>
<remarks>
<remark>hotkey x</remark>
</remarks>
</command>
<command name="newent plclip">
<description>Adds a player clip entity.</description>
<remarks>
<remark>Defines a clipping box against which (only) the player will collide.</remark>
<remark>
Use this clip type to define no-go areas for players without visible obstacles, for example to prevent players from walking on a wall.
</remark>
<remark>Nades will not be affected by this clip type.</remark>
</remarks>
<arguments>
<argument token="Z" description="elevation above the ground" valueNotes="integer"/>
<argument token="X" description="X radius around the box center" valueNotes="integer"/>
<argument token="Y" description="Y radius around the box center" valueNotes="integer"/>
<argument token="H" description="height of the box" valueNotes="integer"/>
</arguments>
</command>
<command name="delent">
<description>Deletes the entity closest to the player</description>
<remarks>
<remark>hotkey x</remark>
</remarks>
</command>
<command name="entset">
<description>Edits the closest entity.</description>
<remarks>
<remark>Overwrites the closest entity with the specified values.</remark>
</remarks>
<arguments>
<argument token="type" description="the entity type" valueNotes="light, sound, clip, plclip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag, helmet"/>
<argument token="value1" description="see newent 'type'"/>
<argument token="value2" description="see newent 'type'"/>
<argument token="value3" description="see newent 'type'"/>
<argument token="value4" description="see newent 'type'"/>
</arguments>
</command>
<command name="entproperty">
<description>Changes property of the closest entity.</description>
<remarks>
<remark>For example 'entproperty 0 2' when executed near a lightsource would increase its radius by 2.</remark>
</remarks>
<arguments>
<argument token="P" description="the property to change" valueNotes="0..3"/>
<argument token="A" description="amount by wich the property is increased" valueNotes="integer"/>
</arguments>
</command>
<command name="clearents">
<description>Deletes all entities of said type.</description>
<arguments>
<argument token="T" description="the entity type, see command 'newent'" valueNotes="string"/>
</arguments>
</command>
<command name="recalc">
<description>Recomputes all there is to recompute about a map, currently only lighting.</description>
<remarks>
<remark>hotkey R</remark>
</remarks>
</command>
<command name="savemap">
<description>Saves the current map.</description>
<remarks>
<remark>
savemap makes a versioned backup (mapname_N.BAK) if a map by that name already exists.
If the name argument is omitted, it is saved under the current map name.
</remark>
<remark>
Where you store a map depends on the complexity of what you are creating: if its a single
map (maybe with its own .cfg) then the "base" package is the best place. If its multiple maps
or a map with new media (textures etc.) its better to store it in its own package (a directory under "packages"),
which makes distributing it less messy.
</remark>
</remarks>
<references>
<identifierReference name="map" identifier="map"/>
</references>
<arguments>
<argument token="M" description="file name of the map, see command 'map' for the naming scheme" valueNotes="string"/>
</arguments>
</command>
<command name="newmap">
<description>Creates a new map.</description>
<remarks>
<remark>The new map has 2^S cubes. For S, 6 is small, 7 medium, 8 large.</remark>
</remarks>
<arguments>
<argument token="S" description="the size of the new map" valueNotes="6..12"/>
</arguments>
</command>
<command name="mapenlarge">
<description>Enlarges the current map.</description>
<remarks>
<remark>
This command will make the current map 1 power of two bigger.
So a size 6 map (64x64 units) will become a size 7 map (128x128),
with the old map in the middle (from 32-96) and the new areas solid.
</remark>
</remarks>
<references>
<identifierReference name="newmap" identifier="newmap"/>
</references>
</command>
<command name="mapshrink">
<description>Reduces the world size by 1.</description>
<remarks>
<remark>
This command will make the current map 1 power of two smaller.
So a size 7 map (128x128) will become a 6 size map (64x64 units), by removing 32 cubes from each side.
The area to be removed needs to be empty (= all solid).
</remark>
</remarks>
</command>
<command name="mapmsg">
<description>Sets the map message, which will be displayed when the map loads.</description>
<remarks>
<remark>You will need to use quote marks around the message, otherwise it save the message correctly.</remark>
<remark>For example: /mapmsg "Map By Author"</remark>
</remarks>
<arguments>
<argument token="M" description="The map message" valueNotes="String"/>
</arguments>
</command>
<command name="getmapmsg">
<description>Returns the map message of the current map.</description>
</command>
<command name="listmapdependencies">
<description>Prints all media dependencies of a map to a file.</description>
<arguments>
<argument token="A" description="map name"/>
</arguments>
<remarks>
<remark>The output will be added to the file 'mapdependencies.txt'.</remark>
</remarks>
</command>
<command name="listmapdependencies_all">
<description>Prints all media dependencies of all maps to a file.</description>
<arguments>
<argument token="A" description="42"/>
</arguments>
<remarks>
<remark>The output will be written to the file 'mapdependencies.txt'.</remark>
</remarks>
</command>
<command name="entstats">
<description>Print some map entity statistics to the console.</description>
</command>
<command name="closestenttype">
<description>Restrict 'closest entity' display to one entity type.</description>
<arguments>
<argument token="A" description="entity type"/>
</arguments>
</command>
<command name="nextclosestent">
<description>Choose another 'closest ent'.</description>
<remarks>
<remark>
Use this, when two entities are placed in exactly the same location.
</remark>
</remarks>
</command>
<command name="nextplayerstart">
<description>Visit next player spawn entity.</description>
<arguments>
<argument token="TYPE" description="0|1|100"/>
</arguments>
</command>
<command name="movemap">
<description>Move the whole map (including all entities) in the specified direction.</description>
<arguments>
<argument token="dX" description="x-offset"/>
<argument token="dY" description="y-offset"/>
<argument token="dZ" description="z-offset"/>
</arguments>
</command>
<command name="selectionflip">
<description>Flip the selected part of the map at an axis.</description>
<arguments>
<argument token="AXIS" description="X or Y"/>
</arguments>
</command>
<command name="selectionrotate">
<description>Rotate the selected part of the map in 90 degree steps.</description>
<arguments>
<argument token="D" description="steps"/>
</arguments>
<remarks>
<remark>
To rotate clockwise, use a positive number of steps. Note, that only quadratic selections can be rotated by 90 degrees.
</remark>
</remarks>
</command>
<variable name="editaxis">
<description>Contains the main axis of the player orientation.</description>
<value token="N" description="11: X, 12: Y, 13: Z" minValue="0" maxValue="13" defaultValue="0" />
</variable>
<variable name="advancemaprevision">
<description>Select the increment of the map revision number for the next 'savemap'.</description>
<value token="N" description="increment" minValue="1" maxValue="100" defaultValue="1" />
</variable>
<variable name="selx">
<description>Current selection: x-coordinate</description>
<value token="N" description="x" minValue="0" maxValue="4096" defaultValue="0" />
</variable>
<variable name="selxs">
<description>Current selection: x-span</description>
<value token="N" description="xs" minValue="0" maxValue="4096" defaultValue="0" />
</variable>
<variable name="sely">
<description>Current selection: y-coordinate</description>
<value token="N" description="y" minValue="0" maxValue="4096" defaultValue="0" />
</variable>
<variable name="selys">
<description>Current selection: y-span</description>
<value token="N" description="ys" minValue="0" maxValue="4096" defaultValue="0" />
</variable>
<variable name="showmodelclipping">
<description>Show mapmodel clipping during edit mode.</description>
<value token="N" description="-" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<command name="waterlevel">
<description>Sets the global water level for the map.</description>
<remarks>
<remark>
Every cube that has a lower floor than the water level will be rendered with a nice wavy
water alpha texture. Water physics will be applied to any entity located below it.
</remark>
<remark>
Performance notes: water is rendered for a whole square encapsulating all visible water areas
in the map (try flying above the map in edit mode to see how). So the most efficient water is
a single body of water, or multiple water areas that are mostly not visible from each other.
Players can influence how accurate the water is rendered using the "watersubdiv" command (map config).
</remark>
</remarks>
<arguments>
<argument token="H" description="the water level" valueNotes="integer"/>
</arguments>
</command>
<command name="fullbright">
<description>Sets all light values to fullbright.</description>
<remarks>
<remark>Will be reset when you issue a 'recalc'. Only works in edit mode.</remark>
</remarks>
<arguments>
<argument token="B" description="sets fullbright on or off" valueNotes="0 (off), 1 (on)"/>
</arguments>
</command>
<command name="showmip">
<description>Toggles between showing what parts of the scenery are rendered.</description>
<remarks>
<remark>
Shows what parts of the scenery are rendered using what size cubes, and outputs some statistics about it.
This can give map editors hints as to what architecture to align, textures to change, etc.
</remark>
</remarks>
</command>
<command name="toggleocull">
<description>Turns occlusion culling on and off.</description>
<remarks>
<remark>
The reason one may want to turn it off is to get an overview of the map from above,
without having all occluded bits stripped out.
</remark>
</remarks>
</command>
<command name="slope">
<description>Makes a slope out of the current selection.</description>
<remarks>
<remark>
The selection must be a heightfield before this command can be used.
The steps specify the slope with the red vertex as left-top,
i.e. "slope 1 2" will make a slope that increases just 1 step from left to right,
and is slightly steeper from top to bottom. "slope -6 0" decreases steeply from left to right,
and does not slope at all from top to bottom. Note that like the vdelta command,
an increasing vdelta goes further away from the player, regardless of floor or ceiling.
</remark>
</remarks>
<arguments>
<argument token="X" description="x delta step" valueNotes="integer"/>
<argument token="Y" description="y delta step" valueNotes="integer"/>
</arguments>
</command>
<command name="arch">
<description>Makes an arch out of the current selection.</description>
<remarks>
<remark>
The selection must be a heightfield before this command can be used.
Will make the arch in the long direction, i.e when you have 6x2 cubes selected, the arch will span 7 vertices.
Optionally, sidedelta specifies the delta to add to the outer rows of vertices in the other direction,
i.e. give the impression of an arch that bends 2 ways (try "arch 2" on an selection of at least 2 thick to see the effect).
Not all arch sizes are necessarily available, see config/prefabs.cfg.
</remark>
</remarks>
<arguments>
<argument token="S" description="side delta (optional)"/>
</arguments>
</command>
<command name="archvertex">
<description>Defines a vertex delta for a specific arch span prefab, used by the 'arch' command.</description>
<remarks>
<remark>See config/prefabs.cfg for an example on usage.</remark>
</remarks>
<arguments>
<argument token="S" description="span value" valueNotes="integer"/>
<argument token="V" description="vertex value" valueNotes="integer"/>
<argument token="D" description="delta value" valueNotes="integer"/>
</arguments>
</command>
<command name="perlin">
<description>Generates a perlin noise landscape in the current selection.</description>
<remarks>
<remark>
Keep the seed the same to create multiple perlin areas which fit with each other,
or use different numbers if to create alternative random generations.
</remark>
</remarks>
<arguments>
<argument token="S" description="the scale, frequency of the features" valueNotes="default is 10"/>
<argument token="E" description="the random seed" valueNotes="integer"/>
<argument token="C" description="cube size, how many cubes to generate a surface for at once (unused)"/>
</arguments>
</command>
<command name="select">
<description>Selects the given area, as if dragged with the mouse.</description>
<remarks>
<remark>
This command is useful for making complex geometry-generating scripts.
The current dimensions of the selection (either created by the user or this command)
are in the variables selx, sely, selxs and selys and can also be read/modified.
</remark>
<remark>
Coordinates are as follows: after a "newmap 6" the top-left corner (the one where the red dot points) are (8,8),
the opposite corner is (56,56) (or (120,120) on a "newmap 7" etc.).
</remark>
</remarks>
<references>
<identifierReference name="selx" identifier="selx"/>
<identifierReference name="sely" identifier="sely"/>
<identifierReference name="selxs" identifier="selxs"/>
<identifierReference name="selys" identifier="selys"/>
</references>
<arguments>
<argument token="X" description="the X coordinate"/>
<argument token="Y" description="the Y coordinate"/>
<argument token="XS" description="the length along the X axis"/>
<argument token="XY" description="the length along the Y axis"/>
</arguments>
</command>
<command name="registersound">
<description>Registers a sound.</description>
<remarks>
<remark>
This command returns the sound number, which is assigned from 0 onwards,
and which can be used with "sound" command. If the sound was already registered,
its existing index is returned. registersound does not actually load the sound, this is done on first play.
</remark>
<remark>See for example config/sounds.cfg.</remark>
</remarks>
<references>
<identifierReference name="sound" identifier="sound"/>
</references>
<arguments>
<argument token="N" description="sound name" valueNotes="string, see config/sounds.cfg"/>
</arguments>
</command>
<command name="scalelights">
<description>Scales all lights in the map.</description>
<remarks>
<remark>This command is useful if a map is too dark or bright but you want to keep the light entities where they are.</remark>
</remarks>
<arguments>
<argument token="S" description="size change (percentage)"/>
<argument token="I" description="intensity change (percentage)"/>
</arguments>
</command>
<variable name="Map editing">
<description>A variable indicating if the game is in editmode.</description>
<value token="B" description="editmode" minValue="0" maxValue="1" readOnly="true" valueNotes="1 (true), 0 (false)" defaultValue="0"/>
</variable>
<variable name="flrceil">
<description>A variable indicating if the player looks at the floor or at the ceiling.</description>
<value token="B" description="flrceil" minValue="0" maxValue="2" readOnly="true" valueNotes="0 (floor), 2 (ceiling)" defaultValue="0"/>
</variable>
<variable name="lightscale">
<description>Used to finetune the "overbright lighting" rendering feature when enabled.</description>
<remarks>
<remark>After changing this value, a "recalc" is needed to see the differences.</remark>
</remarks>
<references>
<identifierReference identifier="recalc"/>
</references>
<value token="N" description="the brightness of the scene" minValue="1" maxValue="100" defaultValue="4"/>
</variable>
</identifiers>
</section>
<!-- Editing Section Ends -->
<!-- Menus Section Starts -->
<section name="Menus" sortindex="11">
<description>This section describes identifiers related to the menu gui.</description>
<identifiers sort="true">
<command name="menuinit">
<description>Specifies commands to be executed when a menu opens.</description>
<references>
<identifierReference identifier="newmenu"/>
</references>
<remarks>
<remark>This command should be placed after newmenu.</remark>
</remarks>
<arguments>
<argument token="C" description="The code to execute on init"/>
</arguments>
</command>
<command name="newmenu">
<description>Creates a new menu.</description>
<references>
<identifierReference identifier="menuitem"/>
</references>
<remarks>
<remark>
All menu commands placed after newmenu (i.e. menuitem, menuitemcheckbox, etc) are added
into the menu until another "newmenu" command is specified.
</remark>
</remarks>
<arguments>
<argument token="N" description="The name of the menu"/>
</arguments>
</command>
<command name="menuitem">
<description>Creates a new menuitem.</description>
<remarks>
<remark>
Upon activating the menuitem, the associated command will be executed.
(See config/menus.cfg for examples). If the command argument is omitted,
then it will be set to the same value as the description. If -1 is specified
instead of the command to execute, then no command is executed when activating the item.
If the rollover option is used, the menuitem will execute that command when selecting (but not activating)
the menuitem.
</remark>
<remark>(Note: To activate the menu item, select it, and either: Click, press SPACE or press ENTER/Return).</remark>
</remarks>
<references>
<identifierReference identifier="newmenu"/>
</references>
<arguments>
<argument token="N" description="The menuitem description."/>
<argument token="A" description="The command to execute on selection of the menuitem." optional="true"/>
<argument token="H" description="The command to execute upon rolling over the menuitem." optional="true"/>
</arguments>
</command>
<command name="menuinitselection">
<description>Defines the initial selection for a menu.</description>
<arguments>
<argument token="A" description="line number"/>
</arguments>
</command>
<command name="menuitemvar">
<description>Creates a new menuitem with variable content.</description>
<remarks>
<remark>
Like 'menuitem', but the menuitem description will be the result of an evaluation, everytime the menu gets displayed.
</remark>
</remarks>
<references>
<identifierReference identifier="newmenu"/>
<identifierReference identifier="menuitem"/>
</references>
<arguments>
<argument token="N" description="The cubescript to generate the menuitem description."/>
<argument token="A" description="The command to execute on selection of the menuitem." optional="true"/>
<argument token="H" description="The command to execute upon rolling over the menuitem." optional="true"/>
</arguments>
</command>
<command name="menuselection">
<description>Selects a line in a menu.</description>
<arguments>
<argument token="A" description="menu name"/>
<argument token="B" description="line number"/>
</arguments>
</command>
<command name="menuselectionbgcolor">
<description>Defines the background color for the menu selection bar.</description>
<arguments>
<argument token="R" description="red (0..100)"/>
<argument token="G" description="green (0..100)"/>
<argument token="B" description="blue (0..100)"/>
<argument token="A" description="alpha (0..100)"/>
</arguments>
</command>
<command name="menuitemcheckbox">
<argument token="T" description="text"/>
<argument token="V" description="value"/>
<argument token="A" description="action"/>
</command>
<command name="menuitemimage">
<argument token="N" description="image filename"/>
<argument token="T" description="text"/>
<argument token="A" description="action"/>
<argument token="H" description="hoveraction"/>
</command>
<command name="menuitemkeyinput">
<argument token="T" description="text"/>
<argument token="B" description="bind command"/>
</command>
<command name="menuitemslider">
<argument token="T" description="text"/>
<argument token="L" description="min"/>
<argument token="U" description="max"/>
<argument token="V" description="value"/>
<argument token="S" description="step"/>
<argument token="D" description="display"/>
<argument token="A" description="action"/>
</command>
<command name="menuitemtextinput">
<argument token="T" description="text"/>
<argument token="V" description="value"/>
<argument token="A" description="action"/>
<argument token="H" description="hoveraction"/>
<argument token="M" description="maxchars"/>
</command>
<command name="showmenu">
<description>Displays the specified menu.</description>
<remarks>
<remark>
The menu allows the user to pick an item with the cursor keys.
Upon pressing return, the associated action will be executed.
Pressing ESC will cancel the menu.
</remark>
</remarks>
<arguments>
<argument token="N" description="the name of a previously defined menu"/>
</arguments>
<references>
<identifierReference identifier="closemenu"/>
</references>
</command>
<command name="closemenu">
<description>Closes the specified menu if it is open.</description>
<remarks>
<remark>If it is open multiple times in the stack only the topmost instance will be closed!</remark>
</remarks>
<arguments>
<argument token="N" description="the name of a previously defined menu"/>
</arguments>
<references>
<identifierReference identifier="showmenu"/>
</references>
</command>
<command name="menumdl">
<description>Specifies a model to render while displaying the last added menu.</description>
<arguments>
<argument token="M" description="the model"/>
<argument token="A" description="the animation to play"/>
<argument token="R" description="the rotation speed"/>
<argument token="S" description="the scale"/>
</arguments>
</command>
<command name="chmenumdl">
<description>Changes the menu model of a specified menu.</description>
<references>
<identifierReference identifier="menumdl"/>
</references>
<arguments>
<argument token="N" description="the name of the menu"/>
<argument token="M" description="the (new) model"/>
<argument token="A" description="the animation to play"/>
<argument token="R" description="the rotation speed"/>
<argument token="S" description="the scale"/>
</arguments>
</command>
</identifiers>
</section>
<!-- Menus Section Ends -->
<!-- Head-Up Display Section Starts -->
<section name="Head-Up Display" sortindex="06">
<description>This section describes the identifiers to configure the head-up display (HUD).</description>
<identifiers>
<variable name="clockdisplay">
<description>Sets the display mode for the HUD clock.</description>
<remarks>
<remark>The clock shows game-time, it is either off (0) or counts backward (1) or forward (2).</remark>
</remarks>
<value token="D" description="display mode" minValue="0" maxValue="2" defaultValue="0"/>
</variable>
<command name="clearminimap">
<description>Recreates the minimap for the current map.</description>
<references>
<identifierReference identifier="minimapres"/>
</references>
</command>
<command name="history">
<description>Executes the specified command in the command line history.</description>
<remarks>
<remark>
For example, binding "history 1" to a key allows you to quickly repeat the last
command typed in (useful for placing many identical entities etc.)
</remark>
</remarks>
<arguments>
<argument token="N" description="the N'th command from the history"/>
</arguments>
</command>
<command name="conskip">
<description>Allows to browse through the console history by offsetting the console output.</description>
<defaultKeys>
<key alias="KP_MINUS" name="- on the keypad" description="scrolls into the history (conskip 1)"/>
<key alias="KP_PLUS" name="+ on the keypad" description="resets the history (conskip -1000)"/>
</defaultKeys>
<arguments>
<argument token="N" description="the offset"/>
</arguments>
</command>
<variable name="maxhistory">
<description>Sets how many typed console commands to store.</description>
<remarks>
<remark>
This value sets how many command lines to store in memory, everytime a command is entered
it gets store so it can be recalled using the "/" key along with the arrow keys to scroll back and forth through the list.
</remark>
</remarks>
<value token="N" description="Total of stored commands" minValue="0" maxValue="10000" defaultValue="1000" />
</variable>
<variable name="minimapres">
<description>Sets the resolution for the minimap.</description>
<references>
<identifierReference identifier="clearminimap"/>
</references>
<value token="N" description="the resolution" minValue="7" maxValue="10" defaultValue="9"/>
</variable>
<variable name="hidecompass">
<description>Turns on/off the radar compass</description>
<value token="V" description="enable/disable radar compass" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidedamageindicator">
<description>Turns on/off the damage indicator</description>
<value token="V" description="enable/disable damage indicator" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidebigmenuimages">
<description>Hide big images in menus.</description>
<value token="N" description="0: show, 1: hide" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="oldfashionedgunstats">
<description>Show ammo stats like in 1.0</description>
<value token="N" description="0: new, 1: old" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="righthanded">
<description>Choose player hand to carry the weapon.</description>
<value token="N" description="0: lefty, 1: righty" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="confade">
<description>Sets how many seconds before the console text rolls up.</description>
<remarks>
<remark>
It may also be viewed as the speed at wich the console text dissapears.
</remark>
</remarks>
<value token="V" description="time before text rollout" minValue="0" maxValue="60" defaultValue="20"/>
</variable>
<variable name="maxcon">
<description>Sets the total number of text lines from the console to store as history.</description>
<value token="V" description="" minValue="10" maxValue="1000" defaultValue="200"/>
</variable>
<variable name="consize">
<description>Sets how many lines of text the console displays.</description>
<value token="V" description="" minValue="0" maxValue="100" defaultValue="6"/>
<references>
<identifierReference identifier="altconsize"/>
<identifierReference identifier="fullconsize"/>
</references>
</variable>
<variable name="altconsize">
<description>Sets the number of text lines on an alternate F11 history display.</description>
<value token="V" description="" minValue="0" maxValue="100" defaultValue="0"/>
<references>
<identifierReference identifier="consize"/>
<identifierReference identifier="fullconsize"/>
</references>
</variable>
<variable name="fullconsize">
<description>Sets the number of text lines on the F11 history display.</description>
<value token="V" description="" minValue="0" maxValue="100" defaultValue="40"/>
<references>
<identifierReference identifier="consize"/>
<identifierReference identifier="altconsize"/>
</references>
</variable>
<variable name="aboveheadiconfadetime">
<description>Time in milliseconds before the abovehead icon dissapears.</description>
<value token="V" description="abovehead icon display time" minValue="1" maxValue="10000" defaultValue="2000"/>
</variable>
<variable name="hideconsole">
<description>Turns on or off the display of console text.</description>
<value token="V" description="enable/disable console text" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidehudequipment">
<description>Turns on or off the display of equipement icons.</description>
<value token="V" description="enable/disable equipement icons" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidehudmsgs">
<description>Turns on or off the display of messages at the bottom of the screen.</description>
<value token="V" description="enable/disable messages" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidespecthud">
<description>Turns on or off the display of spectator staus.</description>
<value token="V" description="enable/disable spectator status" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidectfhud">
<description>Turns on or off the display of flag icons.</description>
<value token="V" description="enable/disable flag icons" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hideteam">
<description>Turns on or off the display of local player team icons.</description>
<value token="V" description="enable/disable team icons" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hideradar">
<description>Turns on or off the display of the on-screen radar.</description>
<value token="V" description="enable/disable radar" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="hidevote">
<description>Turns on or off the display of vote icons.</description>
<value token="V" description="enable/disable vote info" minValue="0" maxValue="2" defaultValue="0"/>
</variable>
<variable name="hudgun">
<description>Turns on or off the display of the current selected gun.</description>
<value token="V" description="show/hide guns 3D models" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="showstats">
<description>Turns on/off display of FPS/rendering statistics on the HUD.</description>
<value token="N" description="0: Show no stats, 1: Only show FPS stats, 2: Show all stats" minValue="0" maxValue="2" defaultValue="1"/>
</variable>
<variable name="recoiltest">
<description>.</description>
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="maxrecoil">
<description>.</description>
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="1000"/>
</variable>
<variable name="recoilbackfade">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="100"/>
</variable>
<variable name="recoilbase">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="40"/>
</variable>
<variable name="recoilincrease">
<value token="V" description="" minValue="1" maxValue="10" defaultValue="2"/>
</variable>
<variable name="swaymovediv">
<value token="V" description="" minValue="1" maxValue="1000" defaultValue="200"/>
</variable>
<variable name="swayspeeddiv">
<value token="V" description="" minValue="1" maxValue="1000" defaultValue="105"/>
</variable>
<variable name="swayupmovediv">
<value token="V" description="" minValue="1" maxValue="1000" defaultValue="200"/>
</variable>
<variable name="swayupspeeddiv">
<value token="V" description="" minValue="1" maxValue="1000" defaultValue="105"/>
</variable>
<variable name="crosshairteamsign">
<description>Turns on/off display of team warning crosshair.</description>
<value token="V" description="enable/disable warning crosshair" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="damageindicatoralpha">
<description>Set the level of transparency of the damage indicator, 0 = is fully transparent, 100 = totaly solid.</description>
<value token="V" description="damage indicator alpha value" minValue="1" maxValue="100" defaultValue="50"/>
</variable>
<variable name="damageindicatordist">
<description>Sets the separation of the arrows in the damage indicator.</description>
<value token="V" description="damage indicator separation size" minValue="0" maxValue="10000" defaultValue="500"/>
</variable>
<variable name="damageindicatorsize">
<description>Sets the size of the damage indicator.</description>
<value token="V" description="damage indicator icon size" minValue="0" maxValue="10000" defaultValue="200"/>
</variable>
<variable name="damageindicatortime">
<description>Sets how long the damage indicator stays on screen.</description>
<value token="V" description="damage indicator display time" minValue="1" maxValue="10000" defaultValue="1000"/>
</variable>
<variable name="crosshairsize">
<description>Sets the size of your crosshair.</description>
<remarks>
<remark>
The crosshair is turned off entirely if the size is set to 0.
</remark>
</remarks>
<value token="N" description="the crosshair size" minValue="0" maxValue="50" defaultValue="15"/>
</variable>
<variable name="crosshairfx">
<description>Turns on or off crosshair effects.</description>
<remarks>
<remark>
When on, the crosshair will go grey when the weapon is reloading, orange when health is 50 or red when is 25.
</remark>
</remarks>
<value token="B" description="Turns the effects on (1) or off (0)" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="nosway">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="radarentsize">
<description>Sets the icon size of the players shown in the radar and the minimap.</description>
<value token="V" description="size of icons inside radar" minValue="1" maxValue="64" defaultValue="4"/>
</variable>
</identifiers>
</section>
<!-- Head-Up Display Section ends -->
<!-- Visuals Section Starts -->
<section name="Visuals" sortindex="05">
<description>This section describes identifiers to configure the visuals.</description>
<identifiers>
<command name="resetgl">
<description>Resets the OpenGL rendering settings</description>
</command>
<command name="screenres">
<description>Changes the screen resolution, available only for LINUX</description>
<arguments>
<argument token="W" description="width"/>
<argument token="H" description="height"/>
</arguments>
</command>
<command name="glext">
<description>checks for the searchstring in all loaded extensions</description>
<arguments>
<argument token="E" description="extension"/>
</arguments>
<examples>
<example>
<code><![CDATA[if (glext shadow_funcs) [echo you have shadow functionality] [echo no shadows for you]]]></code>
</example>
</examples>
</command>
<command name="fpsrange">
<description>(descripton unavailable)</description>
<arguments>
<argument token="A" description="min" defaultValue="30"/>
<argument token="B" description="max" defaultValue="40"/>
</arguments>
</command>
<variable name="skyclip">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="shadowcasters">
<value token="V" description="" minValue="1" maxValue="0" defaultValue="0"/>
</variable>
<variable name="shadowclip">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="shadowtile">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="ati_mda_bug">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="dbgpos">
<description>Displays local player's current x,y,z position in map, showstats 1 must be enabled.</description>
<value token="V" description="display current position" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="dbgmbatch">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="dbgstenc">
<value token="V" description="" minValue="0" maxValue="2" defaultValue="0"/>
</variable>
<variable name="dbgtiles">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="dbgvlight">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="stencilbits">
<value token="V" description="" minValue="0" maxValue="32" defaultValue="0"/>
</variable>
<variable name="stencilshadow">
<description>Sets the transparency/opacity level of stencil shadows.</description>
<value token="V" description="Alpha level" minValue="0" maxValue="100" defaultValue="40"/>
</variable>
<variable name="depthoffset">
<value token="V" description="" defaultValue="0.005f"/>
</variable>
<variable name="polygonoffsetfactor">
<value token="V" description="" defaultValue="-3.0f"/>
</variable>
<variable name="polygonoffsetunits">
<value token="V" description="" defaultValue="-3.0f"/>
</variable>
<variable name="dynshadowdecay">
<value token="V" description="" minValue="0" maxValue="3000" defaultValue="1000"/>
</variable>
<variable name="dynshadowquad">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="fullbrightlevel">
<description>Sets the level of brightness to use when using the command "/fullbright 1".</description>
<value token="V" description="Light intensity level" minValue="0" maxValue="255" defaultValue="176"/>
</variable>
<command name="fovcompat">
<description>Sets the field of view (fov) based on the rules of AC v0.93</description>
<remarks>
<remark>This command is supplied for backward compatibility.</remark>
</remarks>
<arguments>
<argument token="A" description="FOV degree" valueNotes=""/>
</arguments>
</command>
<command name="font">
<description>Loads an image to be used as a text font.</description>
<arguments>
<argument token="A" description="Check font.cfg for examples of use" valueNotes="value"/>
</arguments>
</command>
<command name="fontchar">
<description>Especify a region of an image to be used as a font character.</description>
<arguments>
<argument token="A" description="Check font.cfg for examples of use" valueNotes="value"/>
</arguments>
</command>
<command name="setfont">
<description>Changes the current font.</description>
<arguments>
<argument token="N" description="Font name" valueNotes="name of the font"/>
</arguments>
</command>
<variable name="fov">
<description>Sets the field of view (fov).</description>
<value token="N" description="the FOV value" minValue="75" maxValue="120" defaultValue="90"/>
</variable>
<variable name="aboveheadiconsize">
<description>Sets the size for the icon shown above a player using comunications voices.</description>
<value token="V" description="Icon size" minValue="0" maxValue="1000" defaultValue="50"/>
</variable>
<variable name="bloodttl">
<description>Sets the amount of time in milliseconds that blood is displayed on the ground.</description>
<value token="V" description="Blood display time" minValue="0" maxValue="30000" defaultValue="10000"/>
</variable>
<variable name="blood">
<description>Turn on and off the display of blood.</description>
<value token="V" description="Enable/Disable blood" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="gibnum">
<description>Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot).</description>
<remarks>
<remark>Larger values are more spectacular, but can slow down less powerful machines. Reducing gibttl may help in this case.</remark>
</remarks>
<references>
<identifierReference identifier="gibttl"/>
<identifierReference identifier="gibspeed"/>
</references>
<value token="N" description="number of gibs" minValue="0" maxValue="1000" defaultValue="6"/>
</variable>
<variable name="gibttl">
<description>Sets the time for gibs to live (in milliseconds), after which they will disappear.</description>
<references>
<identifierReference identifier="gibnum"/>
<identifierReference identifier="gibspeed"/>
</references>
<value token="N" description="time to live" minValue="0" maxValue="15000" defaultValue="5000"/>
</variable>
<variable name="gibspeed">
<description>Sets the velocity at which gibs will fly from a victim.</description>
<references>
<identifierReference identifier="gibnum"/>
<identifierReference identifier="gibttl"/>
</references>
<value token="N" description="velocity" minValue="1" maxValue="100" defaultValue="30"/>
</variable>
<variable name="teamdisplaymode">
<description>Sets the team display mode.</description>
<remarks>
<remark>
In mode 0 team display is disabled
In mode 1 players will be rendered with a colored vest to make the teams distinguishable.
In mode 2 almost the whole suit of the players will be colored. These display modes are only
applied in team gameodes.
</remark>
</remarks>
<value token="N" description="the team display mode" minValue="0" maxValue="2" defaultValue="1" valueNotes="0 (none), 1 (color vests), 2 (color skins)"/>
</variable>
<variable name="aadynshadow">
<description>Sets the size/resolution of the dynamic shadow data.</description>
<value description="the size" minValue="0" maxValue="3" defaultValue="2"/>
</variable>
<variable name="dynshadowsize">
<description>Sets the display size of the dynamic shadows.</description>
<value description="the size" minValue="4" maxValue="8" defaultValue="5"/>
</variable>
<variable name="saveshadows">
<description>Sets if dynamic shadows should be saved to disk.</description>
<value description="auto save" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="dynshadow">
<description>Sets the alpha value (transparency) for dynamic shadows.</description>
<value description="the alpha value" minValue="0" maxValue="100" defaultValue="40"/>
</variable>
<variable name="bilinear">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="scorchttl">
<value token="V" description="" minValue="0" maxValue="30000" defaultValue="10000"/>
</variable>
<variable name="scorch">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="mtexplosion">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="mtwater">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="reflectclip">
<value token="V" description="" minValue="0" maxValue="100" defaultValue="3"/>
</variable>
<variable name="reflectsize">
<value token="V" description="" minValue="6" maxValue="10" defaultValue="8"/>
</variable>
<variable name="reflectscissor">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="dynlight">
<description>Determines whether dynamic shadows and lights are rendered, provided just incase they slow your fps down too much.</description>
<remarks>
<remark>
With radius you can specify the radius of a dynamic light,
smaller to maybe gain some speed (0 is off entirely),
or bigger to see the effect of dynamic shadows more dramatically
(try shooting it past some pillars that have a dark area on the other side... or use the "gamespeed" variable).
</remark>
</remarks>
<value token="R" description="the radius of a dynamic light" minValue="0" maxValue="32" defaultValue="16"/>
</variable>
<variable name="watersubdiv">
<description>Determines the subdivision of the water surface in maps.</description>
<remarks>
<remark>
Must be a power of 2: 4 is the default, 8 is recommended for people on slow machines,
2 is nice for fast machines, and 1 is quite OTT. See "waterlevel" (edit reference)
on how to add water to your own levels.
</remark>
</remarks>
<value token="N" description="the subdivisioin value" minValue="1" maxValue="64" defaultValue="4"/>
</variable>
<variable name="waterreflect">
<description>Turns on/off the reflections in the water surface.</description>
<value token="V" description="enable/disable water reflections" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="waterrefract">
<description>Turns on/off water refractions.</description>
<value token="V" description="enable/disable water refractions" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="shotlinettl">
<value token="V" description="" minValue="0" maxValue="10000" defaultValue="75"/>
</variable>
<variable name="shotline">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="fullscreen">
<description>Enables or disables fullscreen.</description>
<remarks>
<remark>Not supported on Windows and Mac.</remark>
</remarks>
<value description="fullscreen" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="fsaa">
<description>Sets the level of fullscreen antialiasing (FSAA).</description>
<value description="fsaa" minValue="0" maxValue="16" defaultValue="0"/>
</variable>
<variable name="scr_w">
<description>Sets the screen width.</description>
<value description="the screen width" minValue="0" maxValue="1024" defaultValue="10000"/>
</variable>
<variable name="scr_h">
<description>Sets the screen height.</description>
<value description="the screen height" minValue="0" maxValue="768" defaultValue="10000"/>
</variable>
<variable name="colorbits">
<description>Sets the bits per pixel value.</description>
<value description="bits per pixel" minValue="0" maxValue="32" defaultValue="0"/>
</variable>
<variable name="depthbits">
<description>Sets the bits for the depth buffer.</description>
<value description="depth pixels" minValue="0" maxValue="32" defaultValue="0"/>
</variable>
<variable name="vsync">
<description>Enables or disables vsync.</description>
<value description="vsync" minValue="-1" maxValue="1" defaultValue="-1"/>
<remarks>
<remark>-1 uses the default settings obtained from the system. 0 disables, 1 enables vsync.</remark>
</remarks>
</variable>
<variable name="gamma">
<description>Sets the hardware gamma value.</description>
<remarks>
<remark>May not work if your card/driver doesn't support it.</remark>
</remarks>
<value token="N" description="the gamma value" minValue="30" maxValue="300" defaultValue="100"/>
</variable>
<variable name="lighterror">
<description>Allows to finetune the amount of "error" the mipmapper/stripifier allow themselves for changing lightlevels.</description>
<remarks>
<remark>If this variable is changed this during play, a "recalc" is needed to see the effect.</remark>
</remarks>
<references>
<identifierReference identifier="recalc"/>
</references>
<value token="E" description="the error value, 1 being the best quality" minValue="1" maxValue="100" defaultValue="8" readOnly="false"/>
</variable>
<variable name="spectfov">
<description>Specifies the Field Of View when in spectating/ghost mode.</description>
<value token="V" description="Spectate FOV size" minValue="5" maxValue="120" defaultValue="120"/>
</variable>
<variable name="hwtexsize">
<value token="V" description="" minValue="1" maxValue="0" defaultValue="0"/>
</variable>
<variable name="maxtexsize">
<value token="V" description="" minValue="0" maxValue="4096" defaultValue="0"/>
</variable>
<variable name="trilinear">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="bulletholettl">
<description>Specifies how long (in milliseconds) to display bullet holes.</description>
<value token="V" description="Bullethole display time" minValue="0" maxValue="30000" defaultValue="10000"/>
</variable>
<variable name="bullethole">
<description>Turns on/off the display of bullet holes</description>
<value token="V" description="Enable/Disable bullet holes" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="particlesize">
<description>Scales all particles.</description>
<value token="P" description="the scale percentage" minValue="20" maxValue="500" defaultValue="100"/>
</variable>
<variable name="animationinterpolationtime">
<description>Sets the time available for interpolation between model animations.</description>
<value token="N" description="the amount of milliseconds for the interpolation" minValue="0" maxValue="1000" defaultValue="100"/>
</variable>
<variable name="mergestrips">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="gibsgore">
<value token="N" description="" minValue="0" maxValue="4" defaultValue="1" values=""/>
<description>Adjusts gib/gibnum/gibspeed/gibttl variables collectively.</description>
<arguments>
<argument valueNotes="0 - Off"/>
<argument valueNotes="1 - Default/Normal values"/>
<argument valueNotes="2 - Good"/>
<argument valueNotes="3 - Messy"/>
<argument valueNotes="4 - Unrealistic"/>
</arguments>
</variable>
</identifiers>
</section>
<!-- Visuals Section Ends -->
<!-- Sound Section Starts -->
<section name="Sound" sortindex="07">
<description>This section describes all identifiers related to music and sound effects.</description>
<identifiers>
<variable name="soundscheddistancescore">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="5"/>
</variable>
<variable name="soundschedoldbonus">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="100"/>
</variable>
<variable name="soundschedpriorityscore">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="100"/>
</variable>
<variable name="soundschedreserve">
<value token="V" description="" minValue="0" maxValue="100" defaultValue="2"/>
</variable>
<variable name="al_referencedistance">
<description>The distance from the source emitting the sound to the listener.</description>
<value token="V" description="" minValue="0" maxValue="1000000" defaultValue="400"/>
</variable>
<variable name="al_rollofffactor">
<description>This value indicates the relative "strength" of a sound (how far away the sound can be heard.</description>
<value token="V" description="" minValue="0" maxValue="1000000" defaultValue="100"/>
</variable>
<command name="sound">
<description>Plays the specified sound.</description>
<remarks>
<remark>
See config/sounds.cfg for default sounds, and use registersound to register your own.
For example, sound 0 and sound (registersound "aard/jump") both play the standard jump sound.
</remark>
</remarks>
<arguments>
<argument token="S" description="the sound to play" valueNotes="string, see config/sounds.cfg"/>
</arguments>
</command>
<command name="mutesound">
<description>Mute a specific game sound.</description>
<references>
<identifierReference identifier="unmuteallsounds"/>
</references>
<arguments>
<argument token="N" description="ID of the sound to mute" valueNotes="see config/sounds.cfg, starting at ID 0"/>
<argument token="A" description="audible?" valueNotes="(mute) 0 || 1 (unmute)"/>
</arguments>
</command>
<command name="unmuteallsounds">
<description>Unmutes all previously muted sounds.</description>
<references>
<identifierReference identifier="mutesound"/>
</references>
</command>
<variable name="mapsoundrefresh">
<description>Specifies the interval for checking mapsounds.</description>
<remarks>
<remark>If set to value 0, the map sounds will be checked in every frame without any interval limitation.</remark>
</remarks>
<references>
<identifierReference identifier="mapsound"/>
<identifierReference identifier="newent sound"/>
</references>
<value token="N" description="interval in milliseconds" minValue="0" maxValue="1000" defaultValue="50"/>
</variable>
<variable name="audiodebug">
<description>Enables verbose output for debugging purposes.</description>
<value token="B" description="enable audio debug" minValue="0" maxValue="1" defaultValue="0"/>
</variable>
<variable name="gainscale">
<description>Each subsequent played sound's gain-value is scaled by this percentage.</description>
<remarks>
<remark>
This lowers the gain of the sounds before they are mixed, this might be useful in cases when the mixer has problems with too high gain values.
</remark>
</remarks>
<value token="N" description="percentage" minValue="0" maxValue="100" defaultValue="100"/>
</variable>
<variable name="musicvol">
<description>Sets the music volume.</description>
<references>
<identifierReference name="soundvol" identifier="soundvol"/>
</references>
<value token="N" description="the volume" minValue="0" maxValue="255" defaultValue="128"/>
</variable>
<command name="music">
<description>Play music in the background.</description>
<arguments>
<argument token="A" description="music file name"/>
<argument token="B" description="playtime"/>
<argument token="C" description="command to be executed, when music is done"/>
</arguments>
</command>
<variable name="audio">
<description>Enables or disables the audio subsystem in AC.</description>
<value token="B" description="enable" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="soundchannels">
<description>Sets the desired amount of allocated sound channels.</description>
<remarks>
<remark>AC will try to allocate that number of channels but it is not guaranteed to succeed.</remark>
</remarks>
<value description="number of channels" minValue="4" maxValue="1024" defaultValue="32"/>
</variable>
<variable name="bulletairsounddestrad">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="8"/>
</variable>
<variable name="bulletairsoundrad">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="15"/>
</variable>
<variable name="bulletairsoundsourcerad">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="8"/>
</variable>
<variable name="bulletairsound">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="bulletbouncesoundrad">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="15"/>
</variable>
<variable name="bulletbouncesound">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="maxsoundsatonce">
<value token="V" description="" minValue="0" maxValue="100" defaultValue="40"/>
</variable>
<variable name="soundvol">
<description>Sets the sound volume for all sounds.</description>
<value token="N" description="the volume" minValue="0" maxValue="255" defaultValue="128"/>
</variable>
</identifiers>
</section>
<!-- Sound Section Ends -->
<!-- Ingame Reference Section Starts -->
<section name="Ingame Reference" sortindex="12">
<description>This section describes all identifiers related to the ingame documentation reference.</description>
<identifiers>
<command name="docsection">
<description>Adds a new section to the ingame documentation.</description>
<references>
<identifierReference identifier="docident"/>
</references>
<arguments>
<argument token="S" description="the section name"/>
</arguments>
</command>
<command name="docident">
<description>Adds a new identifier documentation to the last added section.</description>
<remarks>
<remark>An identifier represents a command or variable. The new identifier</remark>
<remark>
The name may contain spaces to create a "multipart" identifier documentation
that can be used to describe a complex argument as a single pseudo identifier,
look at the examples.
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[docident fov "Sets the field of view."]]></code>
</example>
<example>
<code><![CDATA[docident "newent light" "Adds a new light entity."]]></code>
</example>
</examples>
<references>
<identifierReference identifier="docsection"/>
<identifierReference identifier="docargument"/>
<identifierReference identifier="docremark"/>
<identifierReference identifier="docref"/>
<identifierReference identifier="docundone"/>
<identifierReference identifier="docinvalid"/>
<identifierReference identifier="docfind"/>
<identifierReference identifier="docwritebaseref"/>
</references>
<arguments>
<argument token="N" description="name of the identifier"/>
<argument token="D" description="the description"/>
</arguments>
</command>
<command name="docargument">
<description>Adds a new argument documentation to the last added identifier.</description>
<remarks>
<remark>An argument represents either a command argument or a variable value.</remark>
<remark>
The last argument of an identifier can be flagged as variable-length
to indicate that it represents an unknown number of arguments.
</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
</references>
<arguments>
<argument token="T" description="the token"/>
<argument token="D" description="the description"/>
<argument token="V" description="the value notes"/>
<argument token="I" description="flags this argument as variable-length" valueNotes="1 (true), 0 (false)" optional="true"/>
</arguments>
</command>
<command name="docremark">
<description>Adds a new documentation remark to the last added identifier.</description>
<references>
<identifierReference identifier="docident"/>
</references>
<arguments>
<argument token="S" description="the remark"/>
</arguments>
</command>
<command name="docexample">
<description>Adds an example to the last added identifier.</description>
<arguments>
<argument token="C" description="the example code"/>
<argument token="E" description="the explanation" optional="true"/>
</arguments>
</command>
<command name="docref">
<description>Adds a new documentation reference to an identifier.</description>
<remarks>
<remark>The new reference is added to the last added identifier documentation.</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
</references>
<arguments>
<argument token="N" description="the display name"/>
<argument token="I" description="the identifier to refer to" optional="true"/>
<argument token="U" description="the URL to refer to" optional="true"/>
</arguments>
</command>
<command name="docundone">
<description>Outputs a list of yet undocumented identifiers (commands,variables, etc)</description>
<remarks>
<remark>
If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument
other identifiers like aliases should be included too.
</remark>
<remark>
Note that the list also includes identifiers that contain the substrings "TODO" or "UNDONE" in their documentation.
</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
<identifierReference identifier="docinvalid"/>
<identifierReference identifier="docfind"/>
</references>
<arguments>
<argument token="A" description="output all identifiers" valueNotes="1 (true), 0 (false)" optional="true"/>
</arguments>
</command>
<command name="docinvalid">
<description>Outputs a list of identifier documentations that do not match any existing identifier.</description>
<remarks>
<remark>Multipart identifiers are not included in this list, see 'docident'.</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
<identifierReference identifier="docinvalid"/>
<identifierReference identifier="docfind"/>
</references>
</command>
<command name="docfind">
<description>Searches the ingame docs for identifier documentations matching the specified search string.</description>
<remarks>
<remark>The name, description and remarks are included in the search.</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
<identifierReference identifier="docundone"/>
<identifierReference identifier="docinvalid"/>
</references>
<arguments>
<argument token="S" description="the search string"/>
</arguments>
</command>
<command name="docwritebaseref">
<description>Writes out a base XML documentation reference containing templates for the builtin identifiers.</description>
<remarks>
<remark>
The generated reference is written to "docs/autogenerated_base_reference.xml" by default.
The three arguments can be changed later on in the generated XML document.
</remark>
</remarks>
<references>
<identifierReference identifier="docident"/>
<identifierReference identifier="docundone"/>
<identifierReference identifier="docinvalid"/>
<identifierReference identifier="docfind"/>
</references>
<arguments>
<argument token="R" description="the reference name" optional="true"/>
<argument token="S" description="the XML schema location string" optional="true"/>
<argument token="T" description="XML stylesheet to use" optional="true"/>
</arguments>
</command>
<command name="dockey">
<arguments>
<argument token="A" description="" valueNotes="value"/>
</arguments>
</command>
<variable name="docskip">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="0"/>
</variable>
<variable name="docvisible">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
</identifiers>
</section>
<!-- Ingame Reference Section ends -->
<!-- Server Commands Section Starts -->
<section name="Server commands" sortindex="08">
<description>
This section lists commands used by the client that communicate to the server. Most are used for server administration.
Also see the "mode" section and the "map" command which also communicate to the server.
</description>
<identifiers sort="true">
<command name="serverdesc">
<description>
If the server was run with -n1 and -n2 arguments (prefix and suffix of descriptive title)
a serveradmin can set a user-defined server description with this command, if it wasn't this command results
in "invalid vote". This title will only stay until the next map is loaded.
</description>
<arguments>
<argument token="D" description="description"/>
</arguments>
<remarks>
<remark>
If, for example, the server was run with -n"Fred's Server" -n1"Fred's " -n2" Server",
then you could call "/serverdesc [pWn4g3 TOSOK]" and it would show up as ""Fred's pWn4g3 TOSOK Server"
in the serverbrowser.
</remark>
</remarks>
</command>
<command name="serverextension">
<description>Modded servers announcement of features. See source/src/server.cpp [Line 2926ff. "case SV_EXTENSION:"]</description>
<arguments>
<argument token="E" description="extension"/>
<argument token="D" description="description"/>
</arguments>
</command>
<variable name="showallservers">
<value token="V" description="" minValue="0" maxValue="1" defaultValue="1"/>
</variable>
<variable name="searchlan">
<value token="V" description="" minValue="0" maxValue="2" defaultValue="1"/>
</variable>
<variable name="serversort">
<value token="V" description="" minValue="0" maxValue="NUMSERVSORT-1" defaultValue="0"/>
</variable>
<variable name="servpingrate">
<value token="V" description="" minValue="1000" maxValue="60000" defaultValue="5000"/>
</variable>
<variable name="masterupdatefrequency">
<value token="V" description="" minValue="1" maxValue="24*60*60" defaultValue="60*60"/>
</variable>
<variable name="maxservpings">
<value token="V" description="" minValue="0" maxValue="1000" defaultValue="0"/>
</variable>
<command name="addfavcategory">
<description>Adds a new category in the serverbrowser favourites.</description>
<remarks>
<remark>Add new categories to your autoexec.cfg, check favourites.cfg for examples.</remark>
</remarks>
<arguments>
<argument token="A" description="reference designator (keep short and unique)"/>
</arguments>
</command>
<command name="listfavcats">
<description>List all registered serverbrowser favourites categories</description>
</command>
<variable name="hidefavicons">
<description>Hide favourites icons in serverbrowser.</description>
<value token="N" description="0: show, 1: hide" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="serverbrowserhidefavtag">
<description>Hide favourites tag column in serverbrowser</description>
<value token="N" description="-" minValue="0" maxValue="2" defaultValue="1" />
</variable>
<variable name="serverbrowserhideip">
<description>Hide server IP and port in serverbrowser.</description>
<value token="N" description="-" minValue="0" maxValue="2" defaultValue="2" />
</variable>
<variable name="serversortdir">
<description>Select ascending of descending sort order in serverbrowser.</description>
</variable>
<variable name="serversortpreferofficial">
<description>Sort official maps over custom maps in serverbrowser.</description>
<value token="N" description="-" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="showminremain">
<description>Show 'minutes remaining' in serverbrowser.</description>
<value token="N" description="" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="shownamesinbrowser">
<description>Show player names in serverbrowser.</description>
<value token="N" description="-" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="showonlyfavourites">
<description>Show only servers of one favourites category in serverbrowser.</description>
<value token="N" description="category index" minValue="0" maxValue="100" defaultValue="0" />
</variable>
<variable name="showonlygoodservers">
<description>Show only servers with the correct protocol in serverbrowser.</description>
<value token="N" description="-" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="showweights">
<description>Show 'weights' in serverbrowser.</description>
<value token="N" description="" minValue="0" maxValue="1" defaultValue="0" />
<remarks>
<remark>
'weights' are the sort criteria with the highest priority. Favourites categories can change the weights.
Use 'showweights' to debug problems with serverbrowser sorting.
</remark>
</remarks>
</variable>
<command name="searchnickname">
<description>Search a nickname (or -part) on all servers.</description>
<arguments>
<argument token="N" description="nickname to search"/>
</arguments>
</command>
<command name="autoteam">
<description>Sets automated team assignment.</description>
<references>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="B" description="Enables or disables auto team." valueNotes="1 (On), 0 (Off)"/>
</arguments>
</command>
<command name="ban">
<description>Temporary ban of the specified player from the server.</description>
<remarks>
<remark>Temporary ban duration is fixed at 20 minutes. </remark>
</remarks>
<references>
<identifierReference identifier="removebans"/>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="CN" description="The player to ban" valueNotes="Client number"/>
</arguments>
</command>
<command name="callvote">
<description>Calls a vote on the server.</description>
<remarks>
<remark>
This command is wrapped by aliases for better usability and is used to action votes such as ban, kick, etc.
See config/admin.cfg for actual uses.
</remark>
</remarks>
<arguments>
<argument token="T" description="Vote type" valueNotes="value"/>
<argument token="A" description="First argument" valueNotes=""/>
<argument token="B" description="Second argument" valueNotes=""/>
</arguments>
</command>
<command name="forceteam">
<description>Forces the specified player to join the enemy team.</description>
<references>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="CN" description="The player to assign to a team" valueNotes="Client number"/>
</arguments>
</command>
<command name="giveadmin">
<description>Gives admin state to the specified player.</description>
<remarks>
<remark>Requires admin state. The admin will lose his admin state after successfully issuing this command.</remark>
</remarks>
<references>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="CN" description="The player to become admin" valueNotes="Client number"/>
</arguments>
</command>
<command name="kick">
<description>Kicks the specified player from the server.</description>
<references>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="CN" description="The player to kick" valueNotes="Client number"/>
</arguments>
</command>
<command name="mastermode">
<description>Sets the mastermode for the server.</description>
<remarks>
<remark>
If the mastermode is set to 'private', no more clients can join the server.
Default is 'open' which allows anyone to join the server.
</remark>
</remarks>
<references>
<identifierReference identifier="setadmin"/>
</references>
<arguments>
<argument token="N" description="The master mode" valueNotes="0 (Open), 1 (Private), 2 (Match)"/>
</arguments>
</command>
<command name="removebans">
<description>Removes all temporary bans from the server. Temporary bans are normally automatically removed after 20 minutes.</description>
<references>
<identifierReference identifier="ban"/>
<identifierReference identifier="setadmin"/>
</references>
</command>
<command name="sendmap">
<description>Sends a map to the server.</description>
<remarks>
<remark>
During coop edit, the current map gets saved to file and sent to the server.
Other players can use 'getmap' to download it.
</remark>
<remark>
When not in edit mode, the map will not be saved. The new map will be used, when
the next game on that map starts on the server.
</remark>
</remarks>
<references>
<identifierReference identifier="getmap"/>
</references>
<arguments>
<argument token="M" description="map to send" optional="true"/>
</arguments>
</command>
<command name="deleteservermap">
<description>Deletes a map from the current server.</description>
<arguments>
<argument token="A" description="map name"/>
</arguments>
</command>
<command name="setadmin">
<description>Claims or drops admin status.</description>
<remarks>
<remark>
Failed logins result in an auto kick.
The admin is granted the right to kick, ban, remove bans, set autoteam, set shuffleteam, change server
description (if enabled), change map, change mastermode, force team, change mode, record demos, stop demos
and clear demo(s) - All without needing votes from other users.
If the admin votes on any (other players) call, his vote is final.
In the scoreboard, the admin will be shown as a red colour.
</remark>
</remarks>
<references>
<identifierReference identifier="kick"/>
<identifierReference identifier="autoteam"/>
<identifierReference identifier="mastermode"/>
<identifierReference identifier="ban"/>
<identifierReference identifier="removebans"/>
</references>
<arguments>
<argument token="B" description="Status" valueNotes="1 (Claim), 0 (Drop)"/>
<argument token="PASS" description="Password" valueNotes="case sensitive"/>
</arguments>
</command>
</identifiers>
</section>
<!-- Server commands Section ends -->
<!-- Game Modes Section Starts -->
<section name="Game modes" sortindex="04">
<identifiers sort="true">
<command name="gamemodedesc">
<arguments>
<argument token="M" description="mode" valueNotes="integer"/>
<argument token="D" description="description" valueNotes="string"/>
</arguments>
</command>
<command name="coop">
<description>Starts a map with the mode "Co-op edit"</description>
<remarks>
<remark>See the co-op edit section in page 4 of the map editing guide for more information.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[coop ac_newmap]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to edit"/>
</arguments>
</command>
<command name="ctf">
<description>Starts a map with the mode "Capture the Flag"</description>
<examples>
<example>
<code><![CDATA[ctf ac_mines]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="dm">
<description>Starts a map with the mode "Deathmatch"</description>
<examples>
<example>
<code><![CDATA[dm ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="htf">
<description>Starts a map with the mode "Hunt the Flag"</description>
<examples>
<example>
<code><![CDATA[htf ac_mines]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="ktf">
<description>Starts a map with the mode "Keep the Flag"</description>
<examples>
<example>
<code><![CDATA[ktf ac_mines]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="lms">
<description>Starts a map with the mode "Last Man Standing"</description>
<examples>
<example>
<code><![CDATA[lms ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="lss">
<description>Starts a map with the mode "Last Swiss Standing"</description>
<examples>
<example>
<code><![CDATA[lss ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="mode">
<description>Sets the gameplay mode to N for the next map loaded.</description>
<references>
<wikiReference article="Gamemodes"/>
<identifierReference identifier="map"/>
<identifierReference identifier="gamemode"/>
<identifierReference identifier="tdm"/>
<identifierReference identifier="coop"/>
<identifierReference identifier="dm"/>
<!--<identifierReference identifier="survivor"/>-->
<identifierReference identifier="ts"/>
<identifierReference identifier="ctf"/>
<identifierReference identifier="pf"/>
<!--
<identifierReference identifier="btdm"/>
<identifierReference identifier="bdm"/>
-->
<identifierReference identifier="lss"/>
<identifierReference identifier="osok"/>
<identifierReference identifier="tosok"/>
<identifierReference identifier="htf"/>
<identifierReference identifier="tktf"/>
<identifierReference identifier="ktf"/>
</references>
<remarks>
<remark>You will need to define mode before loading the map or it will stay as the last mode played.</remark>
<remark>There are many aliases for you to use instead of remembering the numeric mapping.</remark>
</remarks>
<arguments>
<argument token="N" description="The mode number" valueNotes="0..15"/>
</arguments>
<examples>
<example><code><![CDATA[mode 7;map ac_complex;echo "Bot Team Deathmatch on ac_complex"]]></code></example>
<example><code><![CDATA[mode 8;map ac_mines;echo "Bot Deathmatch on ac_mines"]]></code></example>
<example><code><![CDATA[mode 5;map ac_shine;echo "CTF @ ac_shine"]]></code></example>
</examples>
</command>
<command name="osok">
<description>Starts a map with the mode "One shot, One kill"</description>
<examples>
<example>
<code><![CDATA[osok ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="pf">
<description>Starts a map with the mode "Pistol Frenzy"</description>
<examples>
<example>
<code><![CDATA[pf ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="tdm">
<description>Starts a map with the mode "Team Deathmatch"</description>
<examples>
<example>
<code><![CDATA[tdm ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="tktf">
<description>Starts a map with the mode "Team Keep the Flag"</description>
<examples>
<example>
<code><![CDATA[tktf ac_mines]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="tosok">
<description>Starts a map with the mode "Team One Shot, One Kill"</description>
<examples>
<example>
<code><![CDATA[tosok ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="ts">
<description>Starts a map with the mode "Team Survivor"</description>
<examples>
<example>
<code><![CDATA[ts ac_complex]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
<command name="vip">
<description>Starts a map with the mode "Hunt the Flag". Some players prefer the name "VIP" for this mode.</description>
<examples>
<example>
<code><![CDATA[vip ac_mines]]></code>
</example>
</examples>
<arguments>
<variableArgument token="M" description="The name of the map you wish to play"/>
</arguments>
</command>
</identifiers>
</section>
<!-- Game Modes Section Ends -->
<!-- Editing Configs Section Starts -->
<section name="Editing configs" sortindex="10">
<description>
All the below commands are used specifically in map configuration files.
Some of these commands can also be used without the need of a map configuration file.
</description>
<identifiers sort="true">
<command name="md2anim">
<arguments>
<argument token="A" description="anim"/>
<argument token="F" description="frame"/>
<argument token="R" description="range"/>
<argument token="S" description="speed"/>
</arguments>
</command>
<command name="md2emit">
<arguments>
<argument token="T" description="tag"/>
<argument token="Y" description="type"/>
<argument token="A" description="arg1"/>
<argument token="B" description="arg2"/>
</arguments>
</command>
<command name="md2tag">
<arguments>
<argument token="N" description="name"/>
<argument token="A" description="vert1"/>
<argument token="B" description="vert2"/>
<argument token="C" description="vert3"/>
<argument token="D" description="vert4"/>
</arguments>
</command>
<command name="md3anim">
<arguments>
<argument token="A" description="anim"/>
<argument token="S" description="startframe"/>
<argument token="R" description="range"/>
<argument token="V" description="speed"/>
</arguments>
</command>
<command name="md3emit">
<arguments>
<argument token="T" description="tag"/>
<argument token="Y" description="type"/>
<argument token="A" description="arg1"/>
<argument token="B" description="arg2"/>
</arguments>
</command>
<command name="md3link">
<arguments>
<argument token="P" description="parentno"/>
<argument token="C" description="childno"/>
<argument token="T" description="tagname"/>
</arguments>
</command>
<command name="md3load">
<arguments>
<argument token="M" description="model"/>
</arguments>
</command>
<command name="md3skin">
<arguments>
<argument token="N" description="object name"/>
<argument token="S" description="skin texture"/>
</arguments>
</command>
<command name="mdlalphatest">
<arguments>
<argument token="A" description="alphatest"/>
</arguments>
</command>
<command name="mdlcachelimit">
<arguments>
<argument token="L" description="cachelimit"/>
</arguments>
</command>
<command name="mdlcullface">
<arguments>
<argument token="C" description="cullface" valueNotes="0||1"/>
</arguments>
</command>
<command name="mdlscale">
<arguments>
<argument token="P" description="percent" valueNotes="0..100..N*100"/>
</arguments>
</command>
<command name="mdlshadowdist">
<arguments>
<argument token="D" description="shadow distance"/>
</arguments>
</command>
<command name="mdltrans">
<description>translates (= moves) the model</description>
<arguments>
<argument token="X"/>
<argument token="Y"/>
<argument token="Z"/>
</arguments>
</command>
<command name="mdltranslucent">
<arguments>
<argument token="T" description="translucency" valueNotes="0..100..N*100"/>
</arguments>
</command>
<command name="mdlvertexlight">
<arguments>
<argument token="V" description="vertexligh" valueNotes="0||1"/>
</arguments>
</command>
<command name="isolatecontext">
<description>Isolates the given context. This disables access from this context to identifiers located in other contexts, also it removes all aliases created in this context once the running context changes</description>
<arguments>
<argument token="C" description="the context"/>
</arguments>
<references>
<identifierReference identifier="sealcontexts"/>
</references>
</command>
<command name="sealcontexts">
<description>secure this configuration for the rest of the game</description>
</command>
<command name="scriptcontext">
<arguments>
<argument token="C" description="context"/>
<argument token="N" description="idname"/>
</arguments>
</command>
<command name="fog">
<description>Sets the fog distance.</description>
<remarks>
<remark>
You can do this for tweaking the visual effect of the fog, or if you are on a slow machine,
setting the fog to a low value can also be a very effective way to increase fps (if you are geometry limited).
Try out different values on big maps / maps which give you low fps. It is also good for aesthetic features of maps
especially when combined with "fogcolour".
</remark>
</remarks>
<references>
<identifierReference identifier="fogcolour"/>
</references>
<arguments>
<argument token="N" description="The fog distance" valueNotes="64...1024, default is 180"/>
</arguments>
</command>
<command name="fogcolour">
<description>Sets the fog and clearing colour.</description>
<references>
<identifierReference identifier="fog"/>
</references>
<arguments>
<argument token="C" description="The colour" valueNotes="Hexadecimal colour, default is 0x8099B3"/>
</arguments>
</command>
<command name="loadnotexture">
<description>Binds a texture to be used if a slot couldn't be loaded with a given textures path.</description>
<remarks>
<remark>
Binds the texture indicated in the filename to the texture slot of any textures that aren't found.
The path is given exactly as with the texture-command, if it is omitted (or can't be loaded) the default is used.
The default is located in packages/misc/notexture.jpg (not in packages/textures - where custom ones must reside!)
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[loadnotexture // Reset to default]]></code>
</example>
<example>
<code><![CDATA[loadnotexture "makke/black.jpg" // Any missing texture will show up black]]></code>
</example>
</examples>
<references>
<identifierReference name="texture" identifier="texture"/>
<identifierReference name="texturereset" identifier="texturereset"/>
</references>
<arguments>
<argument token="F" description="file name of the texture to bind" valueNotes="string"/>
</arguments>
</command>
<command name="loadsky">
<description>Loads a skymap for a map.</description>
<remarks>
<remark>The available skymaps reside in packages/textures/skymaps/..</remark>
<remark>
To select a skymap you need to use the full path from "packages/"
but only up to the underscore "_" in the filename.
</remark>
</remarks>
<examples>
<example>
<code><![CDATA[loadsky "textures/skymaps/makke/mountain"]]></code>
</example>
</examples>
<arguments>
<argument token="P" description="path to the six skybox textures" valueNotes="string"/>
</arguments>
</command>
<command name="mapmodel">
<description>Registers a mapmodel that can be placed in maps.</description>
<remarks>
<remark>
A mapmodel registered with this command can be placed in a map using the 'newent mapmodel' command.
The bounding box is an invisible force surrounding the model, allowing players to collide against it, instead
of walking through the mapmodel. For more information about this command, read mapediting5.xml.
</remark>
<remark>Example: mapmodel 4 2 4 0 "modelname"</remark>
<remark>This mapmodel has a bounding box of 8x8x2 in size (X/Y/Z) and by default hovers 4 units above ground.</remark>
</remarks>
<references>
<identifierReference identifier="mapmodelreset"/>
<identifierReference identifier="newent mapmodel"/>
</references>
<arguments>
<argument token="R" description="The square radius of the bounding box." valueNotes="Integer"/>
<argument token="H" description="The height of the bounding box." valueNotes="Integer"/>
<argument token="Z" description="The initial height offset from the ground." valueNotes="Integer"/>
<argument token="0" description="This integer is redundant. Leave it at zero so you don't break the command." valueNotes="0"/>
<argument token="N" description="The name of the map model" valueNotes="string"/>
</arguments>
</command>
<command name="mapmodelreset">
<description>Resets the mapmodel slots/indices to 0 for the subsequent "mapmodel" commands.</description>
<remarks>
<remark>Each subsequent mapmodel command increases it again. See config/default_map_settings.cfg for an example.</remark>
</remarks>
<references>
<identifierReference identifier="mapmodel"/>
<identifierReference identifier="newent mapmodel"/>
</references>
</command>
<command name="mapsound">
<description>Defines a mapsound.</description>
<remarks>
<remark>
Registers the sound as a map-specific sound. These map-specific sounds may currently
only be used with "sound" entities within a map. The first map sound registered in a map has slot/index number 0
and increases afterwards.
</remark>
</remarks>
<references>
<identifierReference identifier="newent sound"/>
<identifierReference identifier="mapsoundreset"/>
</references>
<arguments>
<argument token="N" description="Path to the sound file"/>
<argument token="M" description="Maximum simultaneous sounds" optional="true" valueNotes="default -1 (unlimited)"/>
</arguments>
</command>
<command name="mapsoundreset">
<description>Resets the mapsound slots/indices to 0 for the subsequent "mapsound" commands.</description>
<remarks>
<remark>Each subsequent mapsound command increases it again. See config/default_map_settings.cfg for an example.</remark>
</remarks>
<references>
<identifierReference identifier="newent sound"/>
<identifierReference identifier="mapsound"/>
</references>
</command>
<command name="shadowyaw">
<description>Shadow yaw specifies the angle at which shadow stencils are drawn on a map.</description>
<examples>
<example>
<code><![CDATA[shadowyaw 90]]></code>
</example>
</examples>
<remarks>
<remark>
When specifying shadowyaw, remember that the default angle is 45 degrees. The example below
would make the shadows appear at 90 degrees (45 degrees more to the left).
</remark>
</remarks>
<arguments>
<argument token="D" description="The angle in degrees to rotate the stencil shadows" valueNotes="0...360, default is 45"/>
</arguments>
</command>
<command name="texture">
<description>Binds a texture to the current texture slot.</description>
<remarks>
<remark>Binds the texture indicated in the filename to the current texture slot and increments the slot number.</remark>
</remarks>
<references>
<identifierReference name="loadnotexture" identifier="loadnotexture"/>
<identifierReference name="texturereset" identifier="texturereset"/>
</references>
<arguments>
<argument token="0" description="This is a redundant value. Always leave this value as 0 here so it doesn'tbreak your configurations." valueNotes="0"/>
<argument token="F" description="File name of the texture to bind" valueNotes="String"/>
</arguments>
</command>
<command name="texturereset">
<description>Sets the texture slots/indicies to 0 for the subsequent "texture" commands.</description>
<remarks>
<remark>Each subsequent texture command increases it again. See config/default_map_settings.cfg for an example.</remark>
</remarks>
<references>
<identifierReference identifier="texture"/>
</references>
</command>
<command name="watercolour">
<description>Determines the water colour in a map.</description>
<references>
<identifierReference identifier="waterlevel"/>
</references>
<remarks>
<remark>
You must define all 3 values, otherwise this command may not work
correctly (use "1" as a placeholder if needed).
</remark>
</remarks>
<arguments>
<argument token="R" description="Red colour intensity" valueNotes="Between 1 and 255"/>
<argument token="G" description="Green colour intensity" valueNotes="Between 1 and 255"/>
<argument token="B" description="Blue colour intensity" valueNotes="Between 1 and 255"/>
</arguments>
</command>
</identifiers>
</section>
<!-- Editing Configs Section Ends -->
<!-- TODO Section Starts -->
<section name="TODO" sortindex="99">
<description>This section describes identifiers that are not documented yet, but you may try to help us there.</description>
<identifiers sort="true">
<command name="addzip">
<description>TODO: Description</description>
<arguments>
<argument token="A" description="TODO"/>
<argument token="B" description="TODO"/>
<argument token="C" description="TODO"/>
</arguments>
</command>
<command name="checkmapdependencies">
<description>Find what media the map depends on, this is used for mediapack providers.</description>
</command>
<command name="findcn">
<description>find client number (cn)</description>
<arguments>
<argument token="N" description="NAME"/>
</arguments>
</command>
<command name="findpn">
<description>find player name</description>
<arguments>
<argument token="C" description="CLIENTNUM"/>
</arguments>
</command>
<command name="fontskip">
<description>At what char does the definition proceed?</description>
<arguments>
<argument token="A" description="TODO"/>
</arguments>
</command>
<command name="gettext">
<description>An alias used for i18n. Translateable text should be marked [(_ "this is the EN-us variant of the text")].</description>
<arguments>
<argument token="M" description="I18Nmessage"/>
</arguments>
</command>
<command name="mapshot">
<description>save an image of the entire radar-overview of the map.</description>
</command>
<command name="menufont">
<description>switch the font in which the menu is displayed</description>
<arguments>
<argument token="F" description="FONT"/>
</arguments>
</command>
<command name="menuitemmapload">
<description>a menuitem that loads a map, displays the title and the preview or a default image</description>
<arguments>
<argument token="M" description="MAP"/>
<argument token="T" description="TEXT"/>
</arguments>
</command>
<command name="musicpreload">
<description>TODO: Description</description>
<arguments>
<argument token="A" description="TODO"/>
</arguments>
</command>
<command name="quicknadethrow">
<description>TODO: Description</description>
</command>
<command name="removezip">
<description>TODO: Description</description>
<arguments>
<argument token="A" description="TODO"/>
</arguments>
</command>
<command name="setburst">
<description>TODO: Description</description>
</command>
<command name="setwptriggernr">
<description>TODO: Description</description>
<arguments>
<argument token="A" description="TODO"/>
</arguments>
</command>
<command name="soundmuted">
<description>TODO: Description</description>
<arguments>
<argument token="A" description="TODO"/>
</arguments>
</command>
<variable name="akimboendaction">
<description>0: none, 1: switch to primary?, 2: switch to nades?-before-switch to primary?</description>
<value token="N" description="TODO" minValue="0" maxValue="2" defaultValue="0" />
</variable>
<variable name="ambient">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="16777215" defaultValue="0" />
</variable>
<variable name="applydialog">
<description>do you <i>reall</i> want to quit?</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="autoscopesens">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="cncolumncolor">
<description>colour of CN column in scoreboard</description>
<value token="N" description="TODO" minValue="0" maxValue="9" defaultValue="5" />
</variable>
<variable name="damagescreen">
<description>show the blood-spat overlay when receiving damage?</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="damagescreenalpha">
<description>if overlay of blood-spat, at what blending (transparency) level?</description>
<value token="N" description="TODO" minValue="1" maxValue="100" defaultValue="45" />
</variable>
<variable name="damagescreenfactor">
<description>if overlay of blood-spat, use which factor</description>
<value token="N" description="TODO" minValue="1" maxValue="100" defaultValue="7" />
</variable>
<variable name="damagescreenfade">
<description>if overlay of blood-spat, at what speed does it fade</description>
<value token="N" description="TODO" minValue="0" maxValue="1000" defaultValue="125" />
</variable>
<variable name="gib">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="hitsound">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="hudextras">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="3" defaultValue="0" />
</variable>
<variable name="interms">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="mapdimsfactor">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="4" defaultValue="2" />
</variable>
<variable name="maxrollremote">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="mdldlist">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
</variable>
<variable name="mfilter">
<description>TODO</description>
<value token="N" description="TODO" minValue="0,0" maxValue="6,0" defaultValue="0,0" />
</variable>
<variable name="mouseaccel">
<description>TODO</description>
<value token="N" description="TODO" minValue="0,0" maxValue="1000,0" defaultValue="0,0" />
</variable>
<variable name="orderscorecolumns">
<description>variants of ordering CN first or not in scoreboard</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="scopesensscale">
<description>TODO</description>
<value token="N" description="TODO" minValue="0,001" maxValue="1000,0" defaultValue="0,5" />
</variable>
<variable name="scorefont">
<description>use monspacefont to render the scoreboard? or the default one?</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="sensitivityscale">
<description>TODO</description>
<value token="N" description="TODO" minValue="0,001" maxValue="1000,0" defaultValue="1,0" />
</variable>
<variable name="testvel">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
</variable>
<variable name="texreduce">
<description>-1: 2x2 : 0 : 1: x0.5 : 2: x0.25 : 3: x0.125</description>
<value token="N" description="TODO" minValue="-1" maxValue="3" defaultValue="0" />
</variable>
<variable name="texturescale">
<description>TODO</description>
<value token="N" description="TODO" minValue="16" maxValue="64" defaultValue="32" />
</variable>
<variable name="voicecomsounds">
<description>TODO</description>
<value token="N" description="TODO" minValue="0" maxValue="2" defaultValue="1" />
</variable>
<variable name="maploaditemlength">
<description>change at what position to truncate the map title string</description>
<value token="N" description="CHAR" minValue="0" maxValue="255" defaultValue="46" />
</variable>
<variable name="showmapbackdrop">
<description>change wether to have a see-through map overview (0), or render it on a black backdrop (1) or a combination of both (2)</description>
<value token="B" description="backdrop-style" minValue="0" maxValue="2" defaultValue="0" />
</variable>
<variable name="showmapbackdroptransparency">
<description></description>
<value token="T" description="transparency" minValue="0" maxValue="100" defaultValue="75" />
</variable>
<variable name="radarheight">
<description>change at what height you are floating in the radar-view</description>
<value token="H" description="height" minValue="20" maxValue="70" defaultValue="35" />
</variable>
<command name="showedithide">
<description>shows the settings of edithide (sparklies)</description>
</command>
<command name="setedithide">
<description>hides the list of entity types you set. pass 1 for light, 2 for spawn, or use "playerstart".</description>
<arguments>
<argument token="L" description="list of types to hide"/>
</arguments>
<remarks>
<remark>pass light or 1, playerstart or 2. Call [setedithide 1 10] to just hide all lights and mapmodels.</remark>
<remark>Or [setedithide [3 4 5 6 7 8 9 12 13]] for all the clips, ammo, nades, health, helmet, armour, akimbo, ladder, and flag.</remark>
<remark>Reversly just use [1 2 10 11 13 14 15 16] to hide light, spawn, mapmodel, ladder, sound, clip, plclip.</remark>
<remark>Only shown entity types are potential 'closest entity'.</remark>
</remarks>
</command>
<command name="seteditshow">
<description>hides all but the single entity type you give. pass 1 for light, 2 for spawn, or use [playerstart].</description>
<arguments>
<argument token="T" description="type to show exclusively"/>
</arguments>
<remarks>
<remark>Just run [seteditshow model] and see just the model entities.</remark>
<remark>The other entity types are ignored as closestentity too.</remark>
<remark>other call forms may use the numerical item type</remark>
</remarks>
</command>
</identifiers>
</section>
<!-- TODO Section Ends -->
</sections>
</cuberef>
|