File: attribute-reference.html

package info (click to toggle)
flare-engine 1.14-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,388 kB
  • sloc: cpp: 47,760; java: 3,956; sh: 309; xml: 45; makefile: 10
file content (2462 lines) | stat: -rw-r--r-- 137,602 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>FLARE Documentation - Attribute Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<style type="text/css">
body {
	font-family: Arial, sans-serif;
	margin-left: auto;
	margin-right: auto;
	width: 70%;
}
.logo {
	text-align: center;
	background: #000;
	color: #fff;
}
code {
	background: #e5e5e5;
}
</style>
</head>

<body>

<div class="logo">
<img src="../mods/default/images/menus/logo.png" alt="FLARE"/>
<h1>Attribute Reference</h1>
<hr/>
</div>

<div class="content">

<h3>Attribute description</h3>

<p>Attribute descriptions are in the following format: section.attributename, <code>valuetype</code>, short attribute description</p>

<p><strong>This reference is generated from in-source documentation, so please do not edit it directly.</strong></p>

<h4>Valuetype syntax</h4>

<p><code>[val1, ...]</code>, Multiple values between a set of square brackets denotes possible types/values for a single field.</p>

<p><code>"..."</code>, Anything between double quotes is a string literal. This is mostly used in conjunction with the above square brackets syntax.</p>

<p><code>list(...)</code>, Lists are a series of values that can repeat on a single line, separated by commas/semicolons. Example of list(int, bool): "1,false;2,true"</p>

<p><code>repeatable(...)</code>, Repeatable keys can be used for multiple lines. An example of this would be an item with multiple "bonus" lines.</p>

<h4>List of available valuetypes</h4>

<p><code>bool</code>, a string value of <code>true</code> or <code>false</code></p>

<p><code>int</code>, a signed integer value</p>

<p><code>string</code>, a text string value</p>

<p><code>float</code>, a floating point number</p>

<p><code>item_id</code>, specifies an integer item identifer (greater than 0)</p>

<p><code>power_id</code>, specifies an integer power identifer (greater than 0)</p>

<p><code>icon_id</code>, specifies an integer icon identifer (greater than or equal to 0)</p>

<p><code>point</code>, defined as: <code>int, int : X, Y</code></p>

<p><code>rectangle</code>, defined as: <code>int, int, int, int : X, Y, Width, Height</code></p>

<p><code>filename</code>, a string path to a file relative to the base of the mod directory (e.g. "animations/hero.txt")</p>

<p><code>color</code>, defined as: <code>int, int, int : Red, Green, Blue</code></p>

<p><code>predefined_string</code>, same as a string, but uses a value defined elsewhere</p>

<p><code>alignment</code>, defined as: <code>["topleft", "top", "topright", "left", "center", "right", "bottomleft", "bottom", "bottomright", "frame_topleft", "frame_top", "frame_topright", "frame_left", "frame_center", "frame_right", "frame_bottomleft", "frame_bottom", "frame_bottomright"]</code></p>

<p><code>direction</code>, defined as: <code>["N", "NE", "E", "SE", "S", "SW", "W", "NW", int]</code>. If defined as an integer, the value must be between 0-7 inclusive, mapping to <code>["W", "NW", "N", "NE", "E", "SE", "S", "SW"]</code> respectively.</p>

<p><code>duration</code>, durations can be specified in seconds and milliseconds with integer suffix s, ms (eg. 20s, 20000ms)</p>

<p><code>label</code>, defined as: <code>"hidden"</code> <strong>or</strong> <code>int, int, ["left", "right", "center"], ["top", "center", "bottom"], string : X, Y, Justify, Vertical Align, Font style</code>. The font style can be any style defined in engine/font_settings.txt.</p>

<p><code>loot</code>, defined as: <code>filename</code> <strong>or</strong> <code>["currency", item_id], ["fixed", float], int, int : Item, Drop chance, Min quantity, Max quantity</code>. There is a limitation when defining as part of a list(...): filenames can only be used in the first list element.</p>

<p><code>version</code>, defined as: a string of three numbers, separated by dots (e.g. "1.2.03")</p>

<p><code>raw</code>, This is plain text, including line breaks. It is used only for map layer data.</p>

<p><code>stat_id</code>, a string that can be any of the following: A base stat (e.g. <code>hp</code> or <code>avoidance</code>); A min or max damage type from <code>engine/damage_types.txt</code> (e.g. <code>dmg_melee_min</code> or <code>dmg_ment_max</code>); An elemental resistance from <code>engine/elements.txt</code>. To use an element as a resistance, <code>_resist</code> is appened to the element id (e.g. <code>fire_resist</code>)</p>
<hr />

<h4>AnimationSet</h4>

<p>Description of animations in animations/</p>

<p><strong>image</strong> | <code>filename, string : Filename, ID</code> | Filename of sprite-sheet image along with an identifier string. The identifier string may be omitted if there is only a single image.</p>

<p><strong>render_size</strong> | <code>int, int : Width, Height</code> | Width and height of animation.</p>

<p><strong>render_offset</strong> | <code>int, int : X offset, Y offset</code> | Render x/y offset.</p>

<p><strong>blend_mode</strong> | <code>["normal", "add"]</code> | The type of blending used when rendering this animation.</p>

<p><strong>alpha_mod</strong> | <code>int</code> | Changes the default alpha of this animation. 255 is fully opaque.</p>

<p><strong>color_mod</strong> | <code>color</code> | Changes the default color mod of this animation. "255,255,255" is no color mod.</p>

<p><strong>animation.position</strong> | <code>int</code> | Number of frames to the right to use as the first frame. Unpacked animations only.</p>

<p><strong>animation.frames</strong> | <code>int</code> | The total number of frames</p>

<p><strong>animation.duration</strong> | <code>duration</code> | The duration of the entire animation in 'ms' or 's'.</p>

<p><strong>animation.type</strong> | <code>["play_once", "back_forth", "looped"]</code> | How to loop (or not loop) this animation.</p>

<p><strong>animation.active_frame</strong> | <code>[list(int), "all"]</code> | A list of frames marked as "active". Also, "all" can be used to mark all frames as active.</p>

<p><strong>animation.frame</strong> | <code>int, int, int, int, int, int, int, int, string : Index, Direction, X, Y, Width, Height, X offset, Y offset, Image ID</code> | A single frame of a compressed animation. The image ID may be omitted, in which case the first available image will be used.</p>

<hr />

<h4>Avatar: Step sounds</h4>

<p>Description of items/step_sounds.txt</p>

<p><strong>id</strong> | <code>string</code> | An identifier name for a set of step sounds.</p>

<p><strong>step</strong> | <code>filename</code> | Filename of a step sound effect.</p>

<hr />

<h4>CombatText</h4>

<p>Description of engine/combat_text.txt</p>

<p><strong>duration</strong> | <code>duration</code> | Duration of the combat text in 'ms' or 's'.</p>

<p><strong>speed</strong> | <code>float</code> | Motion speed of the combat text.</p>

<p><strong>offset</strong> | <code>int</code> | The vertical offset for the combat text's starting position.</p>

<p><strong>fade_duration</strong> | <code>duration</code> | How long the combat text will spend fading out in 'ms' or 's'.</p>

<hr />

<h4>CursorManager</h4>

<p>Description of engine/mouse_cursor.txt</p>

<p><strong>normal</strong> | <code>filename</code> | Filename of an image for the normal cursor.</p>

<p><strong>interact</strong> | <code>filename</code> | Filename of an image for the object interaction cursor.</p>

<p><strong>talk</strong> | <code>filename</code> | Filename of an image for the NPC interaction cursor.</p>

<p><strong>attack</strong> | <code>filename</code> | Filename of an image for the cursor when attacking enemies.</p>

<p><strong>lowhp_normal</strong> | <code>filename</code> | Filename of an image for the normal cursor when health is low.</p>

<p><strong>lowhp_interact</strong> | <code>filename</code> | Filename of an image for the object interaction cursor when health is low.</p>

<p><strong>lowhp_talk</strong> | <code>filename</code> | Filename of an image for the NPC interaction cursor when health is low.</p>

<p><strong>lowhp_attack</strong> | <code>filename</code> | Filename of an image for the cursor when attacking enemies and health is low.</p>

<hr />

<h4>EnemyGroupManager</h4>

<p>Description of enemies in enemies/</p>

<p><strong>level</strong> | <code>int</code> | Level of the enemy</p>

<p><strong>rarity</strong> | <code>["common", "uncommon", "rare"]</code> | Enemy rarity</p>

<p><strong>categories</strong> | <code>list(predefined_string)</code> | Comma separated list of enemy categories</p>

<hr />

<h4>EngineSettings: Misc</h4>

<p>Description of engine/misc.txt</p>

<p><strong>save_hpmp</strong> | <code>bool</code> | When saving the game, keep the hero's current HP and MP.</p>

<p><strong>corpse_timeout</strong> | <code>duration</code> | Duration that a corpse can exist on the map in 'ms' or 's'. Use 0 to keep corpses indefinitely.</p>

<p><strong>sell_without_vendor</strong> | <code>bool</code> | Allows selling items when not at a vendor via CTRL-Click.</p>

<p><strong>aim_assist</strong> | <code>int</code> | The pixel offset for powers that use aim_assist.</p>

<p><strong>window_title</strong> | <code>string</code> | Sets the text in the window's titlebar.</p>

<p><strong>save_prefix</strong> | <code>string</code> | A string that's prepended to save filenames to prevent conflicts between mods.</p>

<p><strong>sound_falloff</strong> | <code>int</code> | The maximum radius in tiles that any single sound is audible.</p>

<p><strong>party_exp_percentage</strong> | <code>float</code> | The percentage of XP given to allies.</p>

<p><strong>enable_ally_collision</strong> | <code>bool</code> | Allows allies to block the player's path.</p>

<p><strong>enable_ally_collision_ai</strong> | <code>bool</code> | Allows allies to block the path of other AI creatures.</p>

<p><strong>currency_id</strong> | <code>item_id</code> | An item id that will be used as currency.</p>

<p><strong>interact_range</strong> | <code>float</code> | Distance where the player can interact with objects and NPCs.</p>

<p><strong>menus_pause</strong> | <code>bool</code> | Opening any menu will pause the game.</p>

<p><strong>save_onload</strong> | <code>bool</code> | Save the game upon changing maps.</p>

<p><strong>save_onexit</strong> | <code>bool</code> | Save the game upon quitting to the title screen or desktop.</p>

<p><strong>save_pos_onexit</strong> | <code>bool</code> | If the game gets saved on exiting, store the player's current position instead of the map spawn position.</p>

<p><strong>save_oncutscene</strong> | <code>bool</code> | Saves the game when triggering any cutscene via an Event.</p>

<p><strong>save_onstash</strong> | <code>[bool, "private", "shared"]</code> | Saves the game when changing the contents of a stash. The default is true (i.e. save when using both stash types). Use caution with the values "private" and false, since not saving shared stashes exposes an item duplication exploit.</p>

<p><strong>save_anywhere</strong> | <code>bool</code> | Saves the game when using a button.</p>

<p><strong>camera_speed</strong> | <code>float</code> | Modifies how fast the camera moves to recenter on the player. Larger values mean a slower camera. Default value is 10.</p>

<p><strong>save_buyback</strong> | <code>bool</code> | Saves the vendor buyback stock whenever the game is saved.</p>

<p><strong>keep_buyback_on_map_change</strong> | <code>bool</code> | If true, NPC buyback stocks will persist when the map changes. If false, save_buyback is disabled.</p>

<p><strong>sfx_unable_to_cast</strong> | <code>filename</code> | Sound to play when the player lacks the MP to cast a power.</p>

<p><strong>combat_aborts_npc_interact</strong> | <code>bool</code> | If true, the NPC dialog and vendor menus will be closed if the player is attacked.</p>

<p><strong>fogofwar</strong> | <code>int</code> | Set the fog of war type. 0-disabled, 1-minimap, 2-tint, 3-overlay.</p>

<p><strong>save_fogofwar</strong> | <code>bool</code> | If true, the fog of war layer keeps track of the progress.</p>

<p><strong>mouse_move_deadzone</strong> | <code>float, float : Deadzone while moving, Deadzone while not moving</code> | Adds a deadzone circle around the player to prevent erratic behavior when using mouse movement. Ideally, the deadzone when moving should be less than the deadzone when not moving. Defaults are 0.25 and 0.75 respectively.</p>

<hr />

<h4>EngineSettings: Resolution</h4>

<p>Description of engine/resolutions.txt</p>

<p><strong>menu_frame_width</strong> | <code>int</code> | Width of frame for New Game, Configuration, etc. menus.</p>

<p><strong>menu_frame_height</strong> | <code>int</code> | Height of frame for New Game, Configuration, etc. menus.</p>

<p><strong>icon_size</strong> | <code>int</code> | Size of icons.</p>

<p><strong>required_width</strong> | <code>int</code> | Minimum window/screen resolution width.</p>

<p><strong>required_height</strong> | <code>int</code> | Minimum window/screen resolution height.</p>

<p><strong>virtual_height</strong> | <code>list(int)</code> | A list of heights (in pixels) that the game can use for its actual rendering area. The virtual height chosen is based on the current window height. The width will be resized to match the window's aspect ratio, and everything will be scaled up to fill the window.</p>

<p><strong>virtual_dpi</strong> | <code>float</code> | A target diagonal screen DPI used to determine how much to scale the internal render resolution.</p>

<p><strong>ignore_texture_filter</strong> | <code>bool</code> | If true, this ignores the "Texture Filtering" video setting and uses only nearest-neighbor scaling. This is good for games that use pixel art assets.</p>

<hr />

<h4>EngineSettings: Gameplay</h4>

<p>Description of engine/gameplay.txt</p>

<p><strong>enable_playgame</strong> | <code>bool</code> | Enables the "Play Game" button on the main menu.</p>

<hr />

<h4>EngineSettings: Combat</h4>

<p>Description of engine/combat.txt</p>

<p><strong>absorb_percent</strong> | <code>float, float : Minimum, Maximum</code> | Limits the percentage of damage that can be absorbed. A max value less than 100 will ensure that the target always takes at least 1 damage from non-elemental attacks.</p>

<p><strong>resist_percent</strong> | <code>float, float : Minimum, Maximum</code> | Limits the percentage of damage that can be resisted. A max value less than 100 will ensure that the target always takes at least 1 damage from elemental attacks.</p>

<p><strong>block_percent</strong> | <code>float, float : Minimum, Maximum</code> | Limits the percentage of damage that can be absorbed when the target is in the 'block' animation state. A max value less than 100 will ensure that the target always takes at least 1 damage from non-elemental attacks.</p>

<p><strong>avoidance_percent</strong> | <code>float, float : Minimum, Maximum</code> | Limits the percentage chance that damage will be avoided.</p>

<p><strong>miss_damage_percent</strong> | <code>float, float : Minimum, Maximum</code> | The percentage of damage dealt when a miss occurs.</p>

<p><strong>crit_damage_percent</strong> | <code>float, float : Minimum, Maximum</code> | The percentage of damage dealt when a critical hit occurs.</p>

<p><strong>overhit_damage_percent</strong> | <code>float, float : Minimum, Maximum</code> | The percentage of damage dealt when an overhit occurs.</p>

<p><strong>resource_round_method</strong> | <code>[none, round, floor, ceil]</code> | Rounds the numbers for most combat events that affect HP/MP. For example: damage taken, HP healed, MP consumed. Defaults to 'round'.</p>

<hr />

<h4>EngineSettings: Elements</h4>

<p>Description of engine/elements.txt</p>

<p><strong>element.id</strong> | <code>string</code> | An identifier for this element. When used as a resistance, "_resist" is appended to the id. For example, if the id is "fire", the resist id is "fire_resist".</p>

<p><strong>element.name</strong> | <code>string</code> | The displayed name of this element.</p>

<hr />

<h4>EngineSettings: Equip flags</h4>

<p>Description of engine/equip_flags.txt</p>

<p><strong>flag.id</strong> | <code>string</code> | An identifier for this equip flag.</p>

<p><strong>flag.name</strong> | <code>string</code> | The displayed name of this equip flag.</p>

<hr />

<h4>EngineSettings: Primary Stats</h4>

<p>Description of engine/primary_stats.txt</p>

<p><strong>stat.id</strong> | <code>string</code> | An identifier for this primary stat.</p>

<p><strong>stat.name</strong> | <code>string</code> | The displayed name of this primary stat.</p>

<hr />

<h4>EngineSettings: Classes</h4>

<p>Description of engine/classes.txt</p>

<p><strong>name</strong> | <code>string</code> | The displayed name of this class.</p>

<p><strong>description</strong> | <code>string</code> | A description of this class.</p>

<p><strong>currency</strong> | <code>int</code> | The amount of currency this class will start with.</p>

<p><strong>equipment</strong> | <code>list(item_id)</code> | A list of items that are equipped when starting with this class.</p>

<p><strong>carried</strong> | <code>list(item_id)</code> | A list of items that are placed in the normal inventorty when starting with this class.</p>

<p><strong>primary</strong> | <code>predefined_string, int : Primary stat name, Default value</code> | Class starts with this value for the specified stat.</p>

<p><strong>actionbar</strong> | <code>list(power_id)</code> | A list of powers to place in the action bar for the class.</p>

<p><strong>powers</strong> | <code>list(power_id)</code> | A list of powers that are unlocked when starting this class.</p>

<p><strong>campaign</strong> | <code>list(string)</code> | A list of campaign statuses that are set when starting this class.</p>

<p><strong>power_tree</strong> | <code>string</code> | Power tree that will be loaded by MenuPowers</p>

<p><strong>hero_options</strong> | <code>list(int)</code> | A list of indicies of the hero options this class can use.</p>

<p><strong>default_power_tab</strong> | <code>int</code> | Index of the tab to switch to when opening the Powers menu</p>

<hr />

<h4>EngineSettings: Damage Types</h4>

<p>Description of engine/damage_types.txt</p>

<p><strong>damage_type.id</strong> | <code>string</code> | The identifier used for Item damage_type and Power base_damage.</p>

<p><strong>damage_type.name</strong> | <code>string</code> | The displayed name for the value of this damage type.</p>

<p><strong>damage_type.name_min</strong> | <code>string</code> | The displayed name for the minimum value of this damage type.</p>

<p><strong>damage_type.name_max</strong> | <code>string</code> | The displayed name for the maximum value of this damage type.</p>

<p><strong>damage_type.description</strong> | <code>string</code> | The description that will be displayed in the Character menu tooltips.</p>

<p><strong>damage_type.min</strong> | <code>string</code> | The identifier used as a Stat type and an Effect type, for the minimum damage of this type.</p>

<p><strong>damage_type.max</strong> | <code>string</code> | The identifier used as a Stat type and an Effect type, for the maximum damage of this type.</p>

<hr />

<h4>EngineSettings: Death penalty</h4>

<p>Description of engine/death_penalty.txt</p>

<p><strong>enable</strong> | <code>bool</code> | Enable the death penalty.</p>

<p><strong>permadeath</strong> | <code>bool</code> | Force permadeath for all new saves.</p>

<p><strong>currency</strong> | <code>float</code> | Remove this percentage of currency.</p>

<p><strong>xp_total</strong> | <code>float</code> | Remove this percentage of total XP.</p>

<p><strong>xp_current_level</strong> | <code>float</code> | Remove this percentage of the XP gained since the last level.</p>

<p><strong>random_item</strong> | <code>bool</code> | Removes a random item from the player's inventory.</p>

<hr />

<h4>EngineSettings: Tooltips</h4>

<p>Description of engine/tooltips.txt</p>

<p><strong>tooltip_offset</strong> | <code>int</code> | Offset in pixels from the origin point (usually mouse cursor).</p>

<p><strong>tooltip_width</strong> | <code>int</code> | Maximum width of tooltip in pixels.</p>

<p><strong>tooltip_margin</strong> | <code>int</code> | Padding between the text and the tooltip borders.</p>

<p><strong>npc_tooltip_margin</strong> | <code>int</code> | Vertical offset for NPC labels.</p>

<p><strong>tooltip_background_border</strong> | <code>int</code> | The pixel size of the border in "images/menus/tooltips.png".</p>

<p><strong>tooltip_visible_max</strong> | <code>int</code> | The maximum number of floating tooltips on screen at once. Defaults to 3.</p>

<hr />

<h4>EngineSettings: Loot</h4>

<p>Description of engine/loot.txt</p>

<p><strong>tooltip_margin</strong> | <code>int</code> | Vertical offset of the loot tooltip from the loot itself.</p>

<p><strong>autopickup_currency</strong> | <code>bool</code> | Enable autopickup for currency</p>

<p><strong>autopickup_range</strong> | <code>float</code> | Minimum distance the player must be from loot to trigger autopickup.</p>

<p><strong>currency_name</strong> | <code>string</code> | Define the name of currency in game</p>

<p><strong>vendor_ratio_buy</strong> | <code>float</code> | Global multiplier for item prices on the "Buy" tab of vendors. Defaults to 1.0.</p>

<p><strong>vendor_ratio_sell</strong> | <code>float</code> | Global multiplier for the currency gained when selling an item and the price of items on the "Sell" tab of vendors. Defaults to 0.25.</p>

<p><strong>vendor_ratio_sell_old</strong> | <code>float</code> | Global multiplier for item prices on the "Sell" tab of vendors after the player has left the map or quit the game. Falls back to the value of vendor_ratio_sell by default.</p>

<p><strong>sfx_loot</strong> | <code>filename</code> | Filename of a sound effect to play for dropping loot.</p>

<p><strong>drop_max</strong> | <code>int</code> | The maximum number of random item stacks that can drop at once</p>

<p><strong>drop_radius</strong> | <code>int</code> | The distance (in tiles) away from the origin that loot can drop</p>

<p><strong>hide_radius</strong> | <code>float</code> | If an entity is within this radius relative to a piece of loot, the label will be hidden unless highlighted with the cursor.</p>

<p><strong>vendor_ratio</strong> | <code>int</code> | (Deprecated in v1.12.85; use 'vendor_ratio_sell' instead) Percentage of item buying price to use as selling price. Also used as the buyback price until the player leaves the map.</p>

<p><strong>vendor_ratio_buyback</strong> | <code>int</code> | (Deprecated in v1.12.85; use 'vendor_ratio_sell_old' instead) Percentage of item buying price to use as the buying price for previously sold items.</p>

<hr />

<h4>EngineSettings: Tileset config</h4>

<p>Description of engine/tileset_config.txt</p>

<p><strong>tile_size</strong> | <code>int, int : Width, Height</code> | The width and height of a tile.</p>

<p><strong>orientation</strong> | <code>["isometric", "orthogonal"]</code> | The perspective of tiles; isometric or orthogonal.</p>

<hr />

<h4>EngineSettings: Widgets</h4>

<p>Description of engine/widget_settings.txt</p>

<p><strong>misc.selection_rect_color</strong> | <code>color, int : Color, Alpha</code> | Color of the selection rectangle when navigating widgets without a mouse.</p>

<p><strong>misc.selection_rect_corner_size</strong> | <code>int</code> | Size of the corners on the selection rectangle shown when navigating widgets. Set to 0 to drawn the entire rectangle instead.</p>

<p><strong>misc.colorblind_highlight_offset</strong> | <code>int, int : X offset, Y offset</code> | The pixel offset of the '*' marker on highlighted icons in colorblind mode.</p>

<p><strong>tab.padding</strong> | <code>int, int : Left/right padding, Top padding</code> | The pixel padding around tabs. Controls how the left and right edges are drawn.</p>

<p><strong>slot.quantity_label</strong> | <code>label</code> | Setting for the slot quantity text.</p>

<p><strong>slot.quantity_color</strong> | <code>color</code> | Text color for the slot quantity text.</p>

<p><strong>slot.quantity_bg_color</strong> | <code>color, int : Color, Alpha</code> | If a slot has a quantity, a rectangle filled with this color will be placed beneath the text.</p>

<p><strong>slot.hotkey_label</strong> | <code>label</code> | Setting for the slot hotkey text.</p>

<p><strong>slot.hotkey_color</strong> | <code>color</code> | Text color for the slot hotkey text.</p>

<p><strong>slot.hotkey_bg_color</strong> | <code>color, int : Color, Alpha</code> | If a slot has a hotkey, a rectangle filled with this color will be placed beneath the text.</p>

<p><strong>listbox.text_margin</strong> | <code>int, int : Left margin, Right margin</code> | The pixel margin to leave on the left and right sides of listbox element text.</p>

<p><strong>horizontal_list.text_width</strong> | <code>int</code> | The pixel width of the text area that displays the currently selected item. Default is 150 pixels;</p>

<p><strong>scrollbar.bg_color</strong> | <code>color, int : Color, Alpha</code> | The background color for the entire scrollbar.</p>

<hr />

<h4>EngineSettings: XP table</h4>

<p>Description of engine/xp_table.txt</p>

<p><strong>level</strong> | <code>int, int : Level, XP</code> | The amount of XP required for this level.</p>

<hr />

<h4>EngineSettings: Number Format</h4>

<p>Description of engine/number_format.txt</p>

<p><strong>player_statbar</strong> | <code>int</code> | Number of digits after the decimal place to display for values in the player's statbars (HP/MP).</p>

<p><strong>enemy_statbar</strong> | <code>int</code> | Number of digits after the decimal place to display for values in the enemy HP statbar.</p>

<p><strong>combat_text</strong> | <code>int</code> | Number of digits after the decimal place to display for values in combat text.</p>

<p><strong>character_menu</strong> | <code>int</code> | Number of digits after the decimal place to display for values in the 'Character' menu.</p>

<p><strong>item_tooltips</strong> | <code>int</code> | Number of digits after the decimal place to display for values in item tooltips.</p>

<p><strong>power_tooltips</strong> | <code>int</code> | Number of digits after the decimal place to display for values in power tooltips (except durations).</p>

<p><strong>durations</strong> | <code>int</code> | Number of digits after the decimal place to display for durations.</p>

<p><strong>death_penalty</strong> | <code>int</code> | Number of digits after the decimal place to display for death penalty messages.</p>

<hr />

<h4>EngineSettings: Resource Stats</h4>

<p>Description of engine/resource_stats.txt</p>

<p><strong>resource_stat.stat_base</strong> | <code>string</code> | The identifier used for the base ("Max") stat.</p>

<p><strong>resource_stat.stat_regen</strong> | <code>string</code> | The identifier used for the regeneration stat.</p>

<p><strong>resource_stat.stat_steal</strong> | <code>string</code> | The identifier used for steal stat.</p>

<p><strong>resource_stat.stat_resist_steal</strong> | <code>string</code> | The identifier used for the resistance to steal stat.</p>

<p><strong>resource_stat.stat_heal</strong> | <code>string</code> | The identifier used for heal-over-time effects.</p>

<p><strong>resource_stat.stat_heal_percent</strong> | <code>string</code> | The identifier used for percentage-based heal-over-time effects.</p>

<p><strong>resource_stat.menu_filename</strong> | <code>filename</code> | The MenuStatBar definition file to use for displaying this stat.</p>

<p><strong>resource_stat.text_base</strong> | <code>string</code> | The printed name of the base ("Max") stat as seen in-game.</p>

<p><strong>resource_stat.text_base_desc</strong> | <code>string</code> | The printed description of the base ("Max") stat as seen in-game.</p>

<p><strong>resource_stat.text_regen</strong> | <code>string</code> | The name of the regeneration stat as seen in-game.</p>

<p><strong>resource_stat.text_regen_desc</strong> | <code>string</code> | The description of the regeneration stat as seen in-game.</p>

<p><strong>resource_stat.text_steal</strong> | <code>string</code> | The name of the steal stat as seen in-game.</p>

<p><strong>resource_stat.text_steal_desc</strong> | <code>string</code> | The description of the steal stat as seen in-game.</p>

<p><strong>resource_stat.text_resist_steal</strong> | <code>string</code> | The name of the resistance to steal stat as seen in-game.</p>

<p><strong>resource_stat.text_resist_steal_desc</strong> | <code>string</code> | The description of the resistance to steal stat as seen in-game.</p>

<p><strong>resource_stat.text_combat_heal</strong> | <code>string</code> | The name of the stat in combat text as seen during heal-over-time.</p>

<p><strong>resource_stat.text_log_restore</strong> | <code>string</code> | The text in the player's log when this stat is restored via EventManager's 'restore' property.</p>

<p><strong>resource_stat.text_log_low</strong> | <code>string</code> | The text in the player's log when trying to use a Power that requires more than the available amount of this resource.</p>

<p><strong>resource_stat.text_tooltip_heal</strong> | <code>string</code> | The text in Power tooltips used for heal-over-time Effects.</p>

<p><strong>resource_stat.text_tooltip_cost</strong> | <code>string</code> | The text in Power tooltips that describes the casting cost of this resource.</p>

<hr />

<h4>EventManager</h4>

<p>Description of events in maps/ and npcs/</p>

<p><strong>event.type</strong> | <code>string</code> | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.</p>

<p><strong>event.activate</strong> | <code>["on_trigger", "on_interact", "on_load", "on_leave", "on_mapexit", "on_clear", "static"]</code> | Set the state in which the event will be activated (map events only). on_trigger = the player is standing in the event area or the player interacts with the hotspot. on_interact = the player ineracts with the hotspot. on_mapexit = as the player leaves the map. on_leave = as the player steps outside of an event area they were previously inside of. on_load = as the player enters a map. on_clear = all of the enemies on a map have been defeated. static = constantly, every frame.</p>

<p><strong>event.location</strong> | <code>rectangle</code> | Defines the location area for the event.</p>

<p><strong>event.hotspot</strong> | <code>["location", rectangle]</code> | Event uses location as hotspot or defined by rect.</p>

<p><strong>event.cooldown</strong> | <code>duration</code> | Duration for event cooldown in 'ms' or 's'.</p>

<p><strong>event.delay</strong> | <code>duration</code> | Event will execute after a specified duration.</p>

<p><strong>event.reachable_from</strong> | <code>rectangle</code> | If the hero is inside this rectangle, they can activate the event.</p>

<p><strong>event.tooltip</strong> | <code>string</code> | Tooltip for event</p>

<p><strong>event.power_path</strong> | <code>int, int, ["hero", point] : Source X, Source Y, Destination</code> | Path that an event power will take.</p>

<p><strong>event.power_damage</strong> | <code>float, float : Min, Max</code> | Range of power damage</p>

<p><strong>event.intermap</strong> | <code>filename, int, int : Map file, X, Y</code> | Jump to specific map at location specified.</p>

<p><strong>event.intermap_random</strong> | <code>filename</code> | Pick a random map from a map list file and teleport to it.</p>

<p><strong>event.intramap</strong> | <code>int, int : X, Y</code> | Jump to specific position within current map.</p>

<p><strong>event.mapmod</strong> | <code>list(predefined_string, int, int, int) : Layer, X, Y, Tile ID</code> | Modify map tiles</p>

<p><strong>event.soundfx</strong> | <code>filename, int, int, bool : Sound file, X, Y, loop</code> | Filename of a sound to play. Optionally, it can be played at a specific location and/or looped.</p>

<p><strong>event.loot</strong> | <code>list(loot)</code> | Add loot to the event.</p>

<p><strong>event.loot_count</strong> | <code>int, int : Min, Max</code> | Sets the minimum (and optionally, the maximum) amount of loot this event can drop. Overrides the global drop_max setting.</p>

<p><strong>event.msg</strong> | <code>string</code> | Adds a message to be displayed for the event.</p>

<p><strong>event.shakycam</strong> | <code>duration</code> | Makes the camera shake for this duration in 'ms' or 's'.</p>

<p><strong>event.requires_status</strong> | <code>list(string)</code> | Event requires list of statuses</p>

<p><strong>event.requires_not_status</strong> | <code>list(string)</code> | Event requires not list of statuses</p>

<p><strong>event.requires_level</strong> | <code>int</code> | Event requires hero level</p>

<p><strong>event.requires_not_level</strong> | <code>int</code> | Event requires not hero level</p>

<p><strong>event.requires_currency</strong> | <code>int</code> | Event requires atleast this much currency</p>

<p><strong>event.requires_not_currency</strong> | <code>int</code> | Event requires no more than this much currency</p>

<p><strong>event.requires_item</strong> | <code>list(item_id)</code> | Event requires specific item (not equipped). Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>event.requires_not_item</strong> | <code>list(item_id)</code> | Event requires not having a specific item (not equipped). Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>event.requires_class</strong> | <code>predefined_string</code> | Event requires this base class</p>

<p><strong>event.requires_not_class</strong> | <code>predefined_string</code> | Event requires not this base class</p>

<p><strong>event.set_status</strong> | <code>list(string)</code> | Sets specified statuses</p>

<p><strong>event.unset_status</strong> | <code>list(string)</code> | Unsets specified statuses</p>

<p><strong>event.remove_currency</strong> | <code>int</code> | Removes specified amount of currency from hero inventory</p>

<p><strong>event.remove_item</strong> | <code>list(item_id)</code> | Removes specified item from hero inventory. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>event.reward_xp</strong> | <code>int</code> | Reward hero with specified amount of experience points.</p>

<p><strong>event.reward_currency</strong> | <code>int</code> | Reward hero with specified amount of currency.</p>

<p><strong>event.reward_item</strong> | <code>(list(item_id)</code> | Reward hero with a specified item. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer. To maintain backwards compatibility, the quantity must be defined for at least the first item in the list in order to use this syntax.</p>

<p><strong>event.reward_item</strong> | <code>item_id, int : Item, Quantity</code> | Reward hero with y number of item x. NOTE: This syntax is maintained for backwards compatibility. It is recommended to use the above syntax instead.</p>

<p><strong>event.reward_loot</strong> | <code>list(loot)</code> | Reward hero with random loot.</p>

<p><strong>event.reward_loot_count</strong> | <code>int, int : Min, Max</code> | Sets the minimum (and optionally, the maximum) amount of loot that reward_loot can give the hero. Defaults to 1.</p>

<p><strong>event.restore</strong> | <code>list(["hp", "mp", "hpmp", "status", "all", predefined_string])</code> | Restore the hero's HP, MP, and/or status. Resource stat base IDs are also valid.</p>

<p><strong>event.power</strong> | <code>power_id</code> | Specify power coupled with event.</p>

<p><strong>event.spawn</strong> | <code>list(predefined_string, int, int) : Enemy category, X, Y</code> | Spawn an enemy from this category at location</p>

<p><strong>event.stash</strong> | <code>bool</code> | If true, the Stash menu if opened.</p>

<p><strong>event.npc</strong> | <code>filename</code> | Filename of an NPC to start dialog with.</p>

<p><strong>event.music</strong> | <code>filename</code> | Change background music to specified file.</p>

<p><strong>event.cutscene</strong> | <code>filename</code> | Show specified cutscene by filename.</p>

<p><strong>event.repeat</strong> | <code>bool</code> | If true, the event to be triggered again.</p>

<p><strong>event.save_game</strong> | <code>bool</code> | If true, the game is saved when the event is triggered. The respawn position is set to where the player is standing.</p>

<p><strong>event.book</strong> | <code>filename</code> | Opens a book by filename.</p>

<p><strong>event.script</strong> | <code>filename</code> | Loads and executes an Event from a file.</p>

<p><strong>event.chance_exec</strong> | <code>float</code> | Percentage chance that this event will execute when triggered.</p>

<p><strong>event.respec</strong> | <code>["xp", "stats", "powers"], bool : Respec mode, Ignore class defaults</code> | Resets various aspects of the character's progression. Resetting "xp" also resets "stats". Resetting "stats" also resets "powers".</p>

<p><strong>event.show_on_minimap</strong> | <code>bool</code> | If true, this event will be shown on the minimap if it is the appropriate type (e.g. an intermap teleport).</p>

<p><strong>event.parallax_layers</strong> | <code>filename</code> | Filename of a parallax layers definition to load.</p>

<p><strong>event.random_status</strong> | <code>repeatable(["append", "clear", "roll", "set", "unset"], list(string)) : Action, Statuses (append action only)</code> | Used to randomly pick a status from a list, and then set or unset it. Statuses are added to the list with the "append" action. The "roll" action will randomly pick from the list and set it as the current random status. The "set" and "unset" commands will function like set_status and unset_status, with the parameter being the current random status. Lastly, the "clear" action will empty the pool of random statuses. It is recommended to clear the list before you use it, as well as after you're done to prevent unintended side-effects.</p>

<hr />

<h4>EventManager: Random Map List</h4>

<p>Description of maps/random/lists/</p>

<p><strong>map</strong> | <code>filename, int, int : Map file, X, Y</code> | Adds a map and optional spawn position to the random list of maps to teleport to.</p>

<hr />

<h4>FogOfWar</h4>

<p>Description of engine/fow_mask.txt</p>

<p><strong>header.radius</strong> | <code>int</code> | Fog of war mask radius, also how far the player can see.</p>

<p><strong>header.bits_per_tile</strong> | <code>int</code> | How may bits(subdivisions) a tile is made of. In powers of two. Example: if it is set to 4 then the tile will be subdivided in 4, let's say North, South, East, West.</p>

<p><strong>header.color_dark</strong> | <code>color</code> | Tint color for dark tiles. Used by fog of war type 2-tint.</p>

<p><strong>header.color_fog</strong> | <code>color</code> | Tint color for fog tiles. Used by fog of war type 2-tint.</p>

<p><strong>header.tileset_dark</strong> | <code>filename</code> | Filename of a tileset definition to use for unvisited areas. Used by fog of war type 3-overlay.</p>

<p><strong>header.tileset_fog</strong> | <code>filename</code> | Filename of a tileset definition to use for foggy areas. Used by fog of war type 3-overlay.</p>

<p><strong>bits.bit</strong> | <code>string, int : Name, Value</code> | A fog of war bit definition can have any name. Better to keep it simple and short. There must be a bit definition that has the value 0. Example: If we have 4 bits per tile then we define: bit=BIT_0,0, bit=BIT_N,1, bit=BIT_W,2, bit=BIT_S,3, bit=BIT_E,4.</p>

<p><strong>tiles.tile</strong> | <code>string, repeatable(predefined_string) : Name, Bit definitions</code> | A fog of war tile definition can have any name. Better to keep it simple and short. There must be a tile definition that contains no bits and a tile definition that contains all bits. Example: A tile containing North and West bits will be tile=NW,BIT_N,BIT_W.</p>

<p><strong>mask.data</strong> | <code>raw</code> | The mask definition is a matrix (2*radius+1 by 2*radius+1) that contains fog of war tile definitions. All the margins of the matrix must be the tile definition that contains all bits.</p>

<hr />

<h4>FontEngine: Font colors</h4>

<p>Description of engine/font_colors.txt</p>

<p><strong>menu_normal</strong> | <code>color</code> | Basic menu text color. Recommended: white.</p>

<p><strong>menu_bonus</strong> | <code>color</code> | Positive menu text color. Recommended: green.</p>

<p><strong>menu_penalty</strong> | <code>color</code> | Negative menu text color. Recommended: red.</p>

<p><strong>widget_normal</strong> | <code>color</code> | Basic widget text color. Recommended: white.</p>

<p><strong>widget_disabled</strong> | <code>color</code> | Disabled widget text color. Recommended: grey.</p>

<p><strong>combat_givedmg</strong> | <code>color</code> | Enemy damage text color. Recommended: white.</p>

<p><strong>combat_takedmg</strong> | <code>color</code> | Player damage text color. Recommended: red.</p>

<p><strong>combat_crit</strong> | <code>color</code> | Enemy critical damage text color. Recommended: yellow.</p>

<p><strong>combat_buff</strong> | <code>color</code> | Healing/buff text color. Recommended: green.</p>

<p><strong>combat_miss</strong> | <code>color</code> | Missed attack text color. Recommended: grey.</p>

<p><strong>requirements_not_met</strong> | <code>color</code> | Unmet requirements text color. Recommended: red.</p>

<p><strong>item_bonus</strong> | <code>color</code> | Item bonus text color. Recommended: green.</p>

<p><strong>item_penalty</strong> | <code>color</code> | Item penalty text color. Recommended: red.</p>

<p><strong>item_flavor</strong> | <code>color</code> | Item flavor text color. Recommended: grey.</p>

<p><strong>hardcore_color_name</strong> | <code>color</code> | Permadeath save slot player name color. Recommended: red.</p>

<hr />

<h4>Cutscene</h4>

<p>Description of cutscenes in cutscenes/</p>

<p><strong>caption_margins</strong> | <code>float, float : X margin, Y margin</code> | Percentage-based margins for the caption text based on screen size</p>

<p><strong>caption_background</strong> | <code>color, int : Color, Alpha</code> | Color (RGBA) of the caption area background.</p>

<p><strong>vscroll_speed</strong> | <code>float</code> | The speed at which elements will scroll in 'vscroll' scenes. Defaults to 0.5.</p>

<p><strong>menu_backgrounds</strong> | <code>bool</code> | This cutscene will use a random fullscreen background image, like the title screen does</p>

<p><strong>music</strong> | <code>filename</code> | The music file that will play during this cutscene.</p>

<p><strong>scene.caption</strong> | <code>string</code> | A caption that will be shown.</p>

<p><strong>scene.image</strong> | <code>filename, int : Filename, Scaling type</code> | Filename of an image that will be shown. The scaling type is a value between 0-2, corresponding to: none, fit height, fit screen.</p>

<p><strong>scene.pause</strong> | <code>duration</code> | Pause before next component in 'ms' or 's'. A value of '-1' may be used to pause indefinitely.</p>

<p><strong>scene.soundfx</strong> | <code>filename</code> | Filename of a sound that will be played</p>

<p><strong>vscroll.text</strong> | <code>string</code> | A single, non-wrapping line of text.</p>

<p><strong>vscroll.image</strong> | <code>filename</code> | Filename of an image that will be shown.</p>

<p><strong>vscroll.separator</strong> | <code>int</code> | Places an invisible gap of a specified height between elements.</p>

<hr />

<h4>GameStateLoad</h4>

<p>Description of menus/gameload.txt</p>

<p><strong>button_new</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "New Game" button.</p>

<p><strong>button_load</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Load Game" button.</p>

<p><strong>button_delete</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Delete Save" button.</p>

<p><strong>button_exit</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Exit to Title" button.</p>

<p><strong>portrait</strong> | <code>rectangle</code> | Position and dimensions of the portrait image.</p>

<p><strong>gameslot</strong> | <code>rectangle</code> | Position and dimensions of the first game slot.</p>

<p><strong>name</strong> | <code>label</code> | The label for the hero's name. Position is relative to game slot position.</p>

<p><strong>level</strong> | <code>label</code> | The label for the hero's level. Position is relative to game slot position.</p>

<p><strong>class</strong> | <code>label</code> | The label for the hero's class. Position is relative to game slot position.</p>

<p><strong>map</strong> | <code>label</code> | The label for the hero's current location. Position is relative to game slot position.</p>

<p><strong>slot_number</strong> | <code>label</code> | The label for the save slot index. Position is relative to game slot position.</p>

<p><strong>loading_label</strong> | <code>label</code> | The label for the "Entering game world..."/"Loading saved game..." text.</p>

<p><strong>sprite</strong> | <code>point</code> | Position for the avatar preview image in each slot</p>

<p><strong>visible_slots</strong> | <code>int</code> | The maximum numbers of visible save slots.</p>

<p><strong>text_trim_boundary</strong> | <code>int</code> | The position of the right-side boundary where text will be shortened with an ellipsis. Position is relative to game slot position.</p>

<hr />

<h4>GameStateNew: Layout</h4>

<p>Description of menus/gamenew.txt</p>

<p><strong>button_prev</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of button to choose the previous preset hero.</p>

<p><strong>button_next</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of button to choose the next preset hero.</p>

<p><strong>button_exit</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of "Cancel" button.</p>

<p><strong>button_create</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of "Create" button.</p>

<p><strong>button_permadeath</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of checkbox for toggling permadeath.</p>

<p><strong>button_randomize</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Randomize" button.</p>

<p><strong>name_input</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the hero name textbox.</p>

<p><strong>portrait_label</strong> | <code>label</code> | Label for the "Choose a Portrait" text.</p>

<p><strong>name_label</strong> | <code>label</code> | Label for the "Choose a Name" text.</p>

<p><strong>permadeath_label</strong> | <code>label</code> | Label for the "Permadeath?" text.</p>

<p><strong>classlist_label</strong> | <code>label</code> | Label for the "Choose a Class" text.</p>

<p><strong>classlist_height</strong> | <code>int</code> | Number of visible rows for the class list widget.</p>

<p><strong>portrait</strong> | <code>rectangle</code> | Position and dimensions of the portrait image.</p>

<p><strong>class_list</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the class list.</p>

<p><strong>show_classlist</strong> | <code>bool</code> | Allows hiding the class list.</p>

<p><strong>show_randomize</strong> | <code>bool</code> | Toggles the visibility of the "Randomize" button.</p>

<p><strong>random_option</strong> | <code>bool</code> | Initially picks a random character option (aka portrait/name).</p>

<p><strong>random_class</strong> | <code>bool</code> | Initially picks a random character class.</p>

<hr />

<h4>GameStateNew: Hero options</h4>

<p>Description of engine/hero_options.txt</p>

<p><strong>option</strong> | <code>int, string, string, filename, string : Index, Base, Head, Portrait, Name</code> | A default body, head, portrait, and name for a hero.</p>

<hr />

<h4>GameStatePlay: Titles</h4>

<p>Description of engine/titles.txt</p>

<p><strong>title.title</strong> | <code>string</code> | The displayed title.</p>

<p><strong>title.level</strong> | <code>int</code> | Requires level.</p>

<p><strong>title.power</strong> | <code>power_id</code> | Requires power.</p>

<p><strong>title.requires_status</strong> | <code>list(string)</code> | Requires status.</p>

<p><strong>title.requires_not_status</strong> | <code>list(string)</code> | Requires not status.</p>

<p><strong>title.primary_stat</strong> | <code>predefined_string, predefined_string : Primary stat, Lesser primary stat</code> | Required primary stat(s). The lesser stat is optional.</p>

<hr />

<h4>GameStateTitle</h4>

<p>Description of menus/gametitle.txt</p>

<p><strong>logo</strong> | <code>filename, int, int, alignment : Image file, X, Y, Alignment</code> | Filename and position of the main logo image.</p>

<p><strong>play_pos</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Play Game" button.</p>

<p><strong>config_pos</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Configuration" button.</p>

<p><strong>credits_pos</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Credits" button.</p>

<p><strong>exit_pos</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Exit Game" button.</p>

<hr />

<h4>GameSwitcher: Default music</h4>

<p>Description of engine/default_music.txt</p>

<p><strong>music</strong> | <code>filename</code> | Filename of a music file to play during game states that don't already have music.</p>

<hr />

<h4>GameSwitcher: Background images</h4>

<p>Description of engine/menu_backgrounds.txt</p>

<p><strong>background</strong> | <code>repeatable(filename)</code> | Filename of a background image to be added to the pool of random menu backgrounds</p>

<hr />

<h4>GameSwitcher: FPS counter</h4>

<p>Description of menus/fps.txt</p>

<p><strong>position</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the fps counter.</p>

<p><strong>color</strong> | <code>color</code> | Color of the fps counter text.</p>

<hr />

<h4>IconManager</h4>

<p>Description of engine/icons.txt</p>

<p><strong>icon_set</strong> | <code>repeatable(icon_id, filename) : First ID, Image file</code> | Defines an icon graphics file to load, as well as the index of the first icon.</p>

<p><strong>text_offset</strong> | <code>point</code> | A pixel offset from the top-left to place item quantity text on icons.</p>

<hr />

<h4>InputState: Default Keybindings</h4>

<p>Description of engine/default_keybindings.txt. Use a bind value of '-1' to clear all bindings for an action. Type may be any of the follwing: 0 = Keyboard, 1 = Mouse, 2 = Gamepad button, 3 = Gamepad Axis. Human-readable key and gamepad mapping names may be used by prefixing the bind with "SDL:" (e.g. "SDL:space" or "SDL:leftstick"). If using the "SDL:" prefix for a gamepad axis, add ":-" to the end of the bind to get the negative direction (e.g. "SDL:leftx:-").</p>

<p><strong>default.cancel</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Cancel".</p>

<p><strong>default.accept</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Accept".</p>

<p><strong>default.up</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Up".</p>

<p><strong>default.down</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Down".</p>

<p><strong>default.left</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Left".</p>

<p><strong>default.right</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Right".</p>

<p><strong>default.bar1</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar1".</p>

<p><strong>default.bar2</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar2".</p>

<p><strong>default.bar3</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar3".</p>

<p><strong>default.bar4</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar4".</p>

<p><strong>default.bar5</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar5".</p>

<p><strong>default.bar6</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar6".</p>

<p><strong>default.bar7</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar7".</p>

<p><strong>default.bar8</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar8".</p>

<p><strong>default.bar9</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar9".</p>

<p><strong>default.bar0</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Bar0".</p>

<p><strong>default.main1</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Main1".</p>

<p><strong>default.main2</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Main2".</p>

<p><strong>default.character</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Character".</p>

<p><strong>default.inventory</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Inventory".</p>

<p><strong>default.powers</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Powers".</p>

<p><strong>default.log</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Log".</p>

<p><strong>default.equipment_swap</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Next Equip Set".</p>

<p><strong>default.equipment_swap_prev</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Previous Equip Set".</p>

<p><strong>default.minimap_mode</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Mini-map Mode".</p>

<p><strong>default.loot_tooltip_mode</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Loot Tooltip Mode".</p>

<p><strong>default.actionbar</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Action Bar".</p>

<p><strong>default.menu_page_next</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Menu: Next Page".</p>

<p><strong>default.menu_page_prev</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Menu: Previous Page".</p>

<p><strong>default.menu_activate</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Menu: Activate".</p>

<p><strong>default.pause</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Pause".</p>

<p><strong>default.aim_up</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Aim Up".</p>

<p><strong>default.aim_down</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Aim Down".</p>

<p><strong>default.aim_left</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Aim Left".</p>

<p><strong>default.aim_right</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Aim Right".</p>

<p><strong>default.developer_menu</strong> | <code>[int, string], int : Bind, Type</code> | Bindings for "Developer Menu".</p>

<hr />

<h4>ItemManager: Items</h4>

<p>Description about the class and it usage, items/items.txt...</p>

<p><strong>id</strong> | <code>item_id</code> | An uniq id of the item used as reference from other classes.</p>

<p><strong>name</strong> | <code>string</code> | Item name displayed on long and short tooltips.</p>

<p><strong>flavor</strong> | <code>string</code> | A description of the item.</p>

<p><strong>level</strong> | <code>int</code> | The item's level. Has no gameplay impact. (Deprecated?)</p>

<p><strong>icon</strong> | <code>icon_id</code> | An id for the icon to display for this item.</p>

<p><strong>book</strong> | <code>filename</code> | A book file to open when this item is activated.</p>

<p><strong>book_is_readable</strong> | <code>bool</code> | If true, "read" is displayed in the tooltip instead of "use". Defaults to true.</p>

<p><strong>quality</strong> | <code>predefined_string</code> | Item quality matching an id in items/qualities.txt</p>

<p><strong>item_type</strong> | <code>predefined_string</code> | Equipment slot matching an id in items/types.txt</p>

<p><strong>equip_flags</strong> | <code>list(predefined_string)</code> | A comma separated list of flags to set when this item is equipped. See engine/equip_flags.txt.</p>

<p><strong>dmg</strong> | <code>predefined_string, float, float : Damage type, Min, Max</code> | Defines the item's base damage type and range. Max may be ommitted and will default to Min.</p>

<p><strong>abs</strong> | <code>float, float : Min, Max</code> | Defines the item absorb value, if only min is specified the absorb value is fixed.</p>

<p><strong>requires_level</strong> | <code>int</code> | The hero's level must match or exceed this value in order to equip this item.</p>

<p><strong>requires_stat</strong> | <code>repeatable(predefined_string, int) : Primary stat name, Value</code> | Make item require specific stat level ex. requires_stat=physical,6 will require hero to have level 6 in physical stats</p>

<p><strong>requires_class</strong> | <code>predefined_string</code> | The hero's base class (engine/classes.txt) must match for this item to be equipped.</p>

<p><strong>bonus</strong> | <code>repeatable(stat_id, float) : Stat ID, Value</code> | Adds a bonus to the item by stat ID, example: bonus=hp,50</p>

<p><strong>bonus_power_level</strong> | <code>repeatable(power_id, int) : Base power, Bonus levels</code> | Grants bonus levels to a given base power.</p>

<p><strong>soundfx</strong> | <code>filename</code> | Sound effect filename to play for the specific item.</p>

<p><strong>gfx</strong> | <code>filename</code> | Filename of an animation set to display when the item is equipped.</p>

<p><strong>loot_animation</strong> | <code>repeatable(filename, int, int) : Loot image, Min quantity, Max quantity</code> | Specifies the loot animation file for the item. The max quantity, or both quantity values, may be omitted.</p>

<p><strong>power</strong> | <code>power_id</code> | Adds a specific power to the item which makes it usable as a power and can be placed in action bar.</p>

<p><strong>replace_power</strong> | <code>repeatable(int, int) : Old power, New power</code> | Replaces the old power id with the new power id in the action bar when equipped.</p>

<p><strong>power_desc</strong> | <code>string</code> | A string describing the additional power.</p>

<p><strong>price</strong> | <code>int</code> | The amount of currency the item costs, if set to 0 the item cannot be sold.</p>

<p><strong>price_per_level</strong> | <code>int</code> | Additional price for each player level above 1</p>

<p><strong>price_sell</strong> | <code>int</code> | The amount of currency the item is sold for, if set to 0 the sell prices is prices*vendor_ratio.</p>

<p><strong>max_quantity</strong> | <code>int</code> | Max item count per stack.</p>

<p><strong>pickup_status</strong> | <code>string</code> | Set a campaign status when item is picked up, this is used for quest items.</p>

<p><strong>stepfx</strong> | <code>predefined_string</code> | Sound effect when walking, this applies only to armors.</p>

<p><strong>disable_slots</strong> | <code>list(predefined_string)</code> | A comma separated list of equip slot types to disable when this item is equipped.</p>

<p><strong>quest_item</strong> | <code>bool</code> | If true, this item is a quest item and can not be dropped or sold. The item also can't be stashed, unless the no_stash property is set to something other than "all".</p>

<p><strong>no_stash</strong> | <code>["ignore", "private", "shared", "all"]</code> | If not set to 'ignore', this item will not be able to be put in the corresponding stash.</p>

<p><strong>script</strong> | <code>filename</code> | Loads and executes a script file when the item is activated from the player's inventory.</p>

<hr />

<h4>ItemManager: Types</h4>

<p>Definition of a item types, items/types.txt...</p>

<p><strong>type.id</strong> | <code>string</code> | Item type identifier.</p>

<p><strong>type.name</strong> | <code>string</code> | Item type name.</p>

<hr />

<h4>ItemManager: Qualities</h4>

<p>Definition of a item qualities, items/types.txt...</p>

<p><strong>quality.id</strong> | <code>string</code> | Item quality identifier.</p>

<p><strong>quality.name</strong> | <code>string</code> | Item quality name.</p>

<p><strong>quality.color</strong> | <code>color</code> | Item quality color.</p>

<p><strong>quality.overlay_icon</strong> | <code>icon_id</code> | The icon to be used as an overlay.</p>

<hr />

<h4>ItemManager: Sets</h4>

<p>Definition of a item sets, items/sets.txt...</p>

<p><strong>id</strong> | <code>int</code> | A uniq id for the item set.</p>

<p><strong>name</strong> | <code>string</code> | Name of the item set.</p>

<p><strong>items</strong> | <code>list(item_id)</code> | List of item id's that is part of the set.</p>

<p><strong>color</strong> | <code>color</code> | A specific of color for the set.</p>

<p><strong>bonus</strong> | <code>repeatable(int, stat_id, float) : Required set item count, Stat ID, Value</code> | Bonus to append to items in the set.</p>

<p><strong>bonus_power_level</strong> | <code>repeatable(int, power_id, int) : Required set item count, Base power, Bonus levels</code> | Grants bonus levels to a given base power.</p>

<hr />

<h4>LootManger</h4>

<p>Description of loot tables in loot/</p>

<p><strong>loot</strong> | <code>loot</code> | Compact form of defining a loot table entry.</p>

<p><strong>status_loot</strong> | <code>string, loot : Required status, Loot definition</code> | Compact form of defining a loot table entry with a required campaign status.</p>

<p><strong>loot.id</strong> | <code>[item_id, "currency"]</code> | The ID of the loot item. "currency" will use the item ID defined as currency_id in engine/misc.txt.</p>

<p><strong>loot.chance</strong> | <code>[float, "fixed"]</code> | The chance that the item will drop. "fixed" will drop the item no matter what before the random items are picked. This is different than setting a chance of 100, in which the item could be replaced with another random item.</p>

<p><strong>loot.quantity</strong> | <code>int, int : Min quantity, Max quantity (optional)</code> | The quantity of item in the dropped loot stack.</p>

<p><strong>loot.requires_status</strong> | <code>string</code> | A single campaign status that is required for the item to be able to drop.</p>

<hr />

<h4>Map</h4>

<p>Description of maps/</p>

<p><strong>title</strong> | <code>string</code> | Title of map</p>

<p><strong>width</strong> | <code>int</code> | Width of map</p>

<p><strong>height</strong> | <code>int</code> | Height of map</p>

<p><strong>tileset</strong> | <code>filename</code> | Filename of a tileset definition to use for map</p>

<p><strong>music</strong> | <code>filename</code> | Filename of background music to use for map</p>

<p><strong>hero_pos</strong> | <code>point</code> | The player will spawn in this location if no point was previously given.</p>

<p><strong>parallax_layers</strong> | <code>filename</code> | Filename of a parallax layers definition.</p>

<p><strong>background_color</strong> | <code>color, int : Color, alpha</code> | Background color for the map.</p>

<p><strong>fogofwar</strong> | <code>int</code> | Set the fog of war type. 0-disabled, 1-minimap, 2-tint, 3-overlay. Overrides engine settings.</p>

<p><strong>save_fogofwar</strong> | <code>bool</code> | If true, the fog of war layer keeps track of the progress. Overrides engine settings.</p>

<p><strong>tilewidth</strong> | <code>int</code> | Inherited from Tiled map file. Unused by engine.</p>

<p><strong>tileheight</strong> | <code>int</code> | Inherited from Tiled map file. Unused by engine.</p>

<p><strong>layer.type</strong> | <code>string</code> | Map layer type.</p>

<p><strong>layer.format</strong> | <code>string</code> | Format for map layer, must be 'dec'</p>

<p><strong>layer.data</strong> | <code>raw</code> | Raw map layer data</p>

<p><strong>enemygroup.type</strong> | <code>string</code> | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.</p>

<p><strong>enemygroup.category</strong> | <code>predefined_string</code> | The category of enemies that will spawn in this group.</p>

<p><strong>enemygroup.level</strong> | <code>int, int : Min, Max</code> | Defines the level range of enemies in group. If only one number is given, it's the exact level.</p>

<p><strong>enemygroup.location</strong> | <code>rectangle</code> | Location area for enemygroup</p>

<p><strong>enemygroup.number</strong> | <code>int, int : Min, Max</code> | Defines the range of enemies in group. If only one number is given, it's the exact amount.</p>

<p><strong>enemygroup.chance</strong> | <code>float</code> | Initial percentage chance that this enemy group will be able to spawn enemies.</p>

<p><strong>enemygroup.direction</strong> | <code>direction</code> | Direction that enemies will initially face.</p>

<p><strong>enemygroup.waypoints</strong> | <code>list(point)</code> | Enemy waypoints; single enemy only; negates wander_radius</p>

<p><strong>enemygroup.wander_radius</strong> | <code>int</code> | The radius (in tiles) that an enemy will wander around randomly; negates waypoints</p>

<p><strong>enemygroup.requires_status</strong> | <code>list(string)</code> | Statuses required to be set for enemy group to load</p>

<p><strong>enemygroup.requires_not_status</strong> | <code>list(string)</code> | Statuses required to be unset for enemy group to load</p>

<p><strong>enemygroup.requires_level</strong> | <code>int</code> | Player level must be equal or greater to load enemy group</p>

<p><strong>enemygroup.requires_not_level</strong> | <code>int</code> | Player level must be lesser to load enemy group</p>

<p><strong>enemygroup.requires_currency</strong> | <code>int</code> | Player currency must be equal or greater to load enemy group</p>

<p><strong>enemygroup.requires_not_currency</strong> | <code>int</code> | Player currency must be lesser to load enemy group</p>

<p><strong>enemygroup.requires_item</strong> | <code>list(item_id)</code> | Item required to exist in player inventory to load enemy group. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>enemygroup.requires_not_item</strong> | <code>list(item_id)</code> | Item required to not exist in player inventory to load enemy group. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>enemygroup.requires_class</strong> | <code>predefined_string</code> | Player base class required to load enemy group</p>

<p><strong>enemygroup.requires_not_class</strong> | <code>predefined_string</code> | Player base class not required to load enemy group</p>

<p><strong>enemygroup.invincible_requires_status</strong> | <code>list(string)</code> | Enemies in this group are invincible to hero attacks when these statuses are set.</p>

<p><strong>enemygroup.invincible_requires_not_status</strong> | <code>list(string)</code> | Enemies in this group are invincible to hero attacks when these statuses are not set.</p>

<p><strong>enemygroup.spawn_level</strong> | <code>["default", "fixed", "level", "stat"], int, int, predefined_string : Mode, Enemy Level, Ratio, Primary stat</code> | The level of spawned creatures. The need for the last three parameters depends on the mode being used. The "default" mode will just use the entity's normal level and doesn't require any additional parameters. The "fixed" mode only requires the enemy level as a parameter. The "stat" and "level" modes also require the ratio as a parameter. The ratio adjusts the scaling of the entity level. For example, spawn_level=stat,1,2,physical will set the spawned entity level to 1/2 the player's Physical stat. Only the "stat" mode requires the last parameter, which is simply the ID of the primary stat that should be used for scaling.</p>

<p><strong>npc.type</strong> | <code>string</code> | (IGNORED BY ENGINE) The "type" field, as used by Tiled and other mapping tools.</p>

<p><strong>npc.filename</strong> | <code>string</code> | Filename of an NPC definition.</p>

<p><strong>npc.location</strong> | <code>point</code> | Location of NPC</p>

<p><strong>npc.requires_status</strong> | <code>list(string)</code> | Statuses required to be set for NPC load</p>

<p><strong>npc.requires_not_status</strong> | <code>list(string)</code> | Statuses required to be unset for NPC load</p>

<p><strong>npc.requires_level</strong> | <code>int</code> | Player level must be equal or greater to load NPC</p>

<p><strong>npc.requires_not_level</strong> | <code>int</code> | Player level must be lesser to load NPC</p>

<p><strong>npc.requires_currency</strong> | <code>int</code> | Player currency must be equal or greater to load NPC</p>

<p><strong>npc.requires_not_currency</strong> | <code>int</code> | Player currency must be lesser to load NPC</p>

<p><strong>npc.requires_item</strong> | <code>list(item_id)</code> | Item required to exist in player inventory to load NPC. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>npc.requires_not_item</strong> | <code>list(item_id)</code> | Item required to not exist in player inventory to load NPC. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>npc.requires_class</strong> | <code>predefined_string</code> | Player base class required to load NPC</p>

<p><strong>npc.requires_not_class</strong> | <code>predefined_string</code> | Player base class not required to load NPC</p>

<p><strong>npc.direction</strong> | <code>direction</code> | Direction that NPC will initially face.</p>

<hr />

<h4>MapParallax</h4>

<p>Description of maps/parallax/</p>

<p><strong>layer.image</strong> | <code>filename</code> | Image file to use as a scrolling background.</p>

<p><strong>layer.speed</strong> | <code>float</code> | Speed at which the background will move relative to the camera.</p>

<p><strong>layer.fixed_speed</strong> | <code>float, float : X speed, Y speed</code> | Speed at which the background will move independent of the camera movement.</p>

<p><strong>layer.map_layer</strong> | <code>string</code> | The tile map layer that this parallax layer will be rendered on top of.</p>

<hr />

<h4>MenuActionBar</h4>

<p>Description of menus/actionbar.txt</p>

<p><strong>slot</strong> | <code>repeatable(int, int, int, bool) : Index, X, Y, Locked</code> | Index (max 10) and position for power slot. If a slot is locked, its Power can't be changed by the player.</p>

<p><strong>slot_M1</strong> | <code>point, bool : Position, Locked</code> | Position for the primary action slot. If the slot is locked, its Power can't be changed by the player.</p>

<p><strong>slot_M2</strong> | <code>point, bool : Position Locked</code> | Position for the secondary action slot. If the slot is locked, its Power can't be changed by the player.</p>

<p><strong>char_menu</strong> | <code>point</code> | Position for the Character menu button.</p>

<p><strong>inv_menu</strong> | <code>point</code> | Position for the Inventory menu button.</p>

<p><strong>powers_menu</strong> | <code>point</code> | Position for the Powers menu button.</p>

<p><strong>log_menu</strong> | <code>point</code> | Position for the Log menu button.</p>

<p><strong>tooltip_length</strong> | <code>["short", "long_menu", "long_all"]</code> | The length of power descriptions in tooltips. 'short' will display only the power name. 'long_menu' (the default setting) will display full tooltips, but only for powers that are in the Powers menu. 'long_all' will display full tooltips for all powers.</p>

<hr />

<h4>MenuActiveEffects</h4>

<p>Description of menus/activeeffects.txt</p>

<p><strong>vertical</strong> | <code>bool</code> | True is vertical orientation; False is horizontal orientation.</p>

<hr />

<h4>MenuBook</h4>

<p>Description of books in books/</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>image.image_pos</strong> | <code>point</code> | Position of the image.</p>

<p><strong>image.image</strong> | <code>filename</code> | Filename of the image.</p>

<p><strong>image.image_icon</strong> | <code>icon_id</code> | Use an icon as the image instead of a file.</p>

<p><strong>image.requires_status</strong> | <code>list(string)</code> | Image requires these campaign statuses in order to be visible.</p>

<p><strong>image.requires_not_status</strong> | <code>list(string)</code> | Image must not have any of these campaign statuses in order to be visible.</p>

<p><strong>text.text_pos</strong> | <code>int, int, int, ["left", "center", "right"] : X, Y, Width, Text justify</code> | Position of the text.</p>

<p><strong>text.text_font</strong> | <code>color, string : Font color, Font style</code> | Font color and style.</p>

<p><strong>text.text_shadow</strong> | <code>bool</code> | If true, the text will have a black shadow like the text labels in various menus.</p>

<p><strong>text.text</strong> | <code>string</code> | The text to be displayed.</p>

<p><strong>text.requires_status</strong> | <code>list(string)</code> | Text requires these campaign statuses in order to be visible.</p>

<p><strong>text.requires_not_status</strong> | <code>list(string)</code> | Text must not have any of these campaign statuses in order to be visible.</p>

<p><strong>button.button_pos</strong> | <code>point</code> | Position of the button.</p>

<p><strong>button.button_image</strong> | <code>filename</code> | Image file to use for this button. Default is the normal menu button.</p>

<p><strong>button.text</strong> | <code>string</code> | Optional text label for the button.</p>

<p><strong>button.${EVENT_COMPONENT}</strong> | <code>Event components to execute when the button is clicked. See the definitions in EventManager for possible attributes.</code> |</p>

<p><strong>event_open.${EVENT_COMPONENT}</strong> | <code>Event components to execute when the book is opened. See the definitions in EventManager for possible attributes.</code> |</p>

<p><strong>event_close.${EVENT_COMPONENT}</strong> | <code>Event components to execute when the book is closed. See the definitions in EventManager for possible attributes.</code> |</p>

<hr />

<h4>MenuCharacter</h4>

<p>Description of menus/character.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Character" text.</p>

<p><strong>upgrade_primary</strong> | <code>predefined_string, point : Primary stat name, Button position</code> | Position of the button used to add a stat point to this primary stat.</p>

<p><strong>statlist</strong> | <code>point</code> | Position of the scrollbox containing non-primary stats.</p>

<p><strong>statlist_rows</strong> | <code>int</code> | The height of the statlist in rows.</p>

<p><strong>statlist_scrollbar_offset</strong> | <code>int</code> | Right margin in pixels for the statlist's scrollbar.</p>

<p><strong>label_name</strong> | <code>label</code> | Position of the "Name" text.</p>

<p><strong>label_level</strong> | <code>label</code> | Position of the "Level" text.</p>

<p><strong>label_primary</strong> | <code>predefined_string, label : Primary stat name, Text positioning</code> | Position of the text label for this primary stat.</p>

<p><strong>name</strong> | <code>rectangle</code> | Position of the player's name and dimensions of the tooltip hotspot.</p>

<p><strong>level</strong> | <code>rectangle</code> | Position of the player's level and dimensions of the tooltip hotspot.</p>

<p><strong>primary</strong> | <code>predefined_string, rectangle : Primary stat name, Hotspot position</code> | Position of this primary stat value display and dimensions of its tooltip hotspot.</p>

<p><strong>unspent</strong> | <code>label</code> | Position of the label showing the number of unspent stat points.</p>

<p><strong>show_resists</strong> | <code>bool</code> | Hide the elemental "Resistance" stats in the statlist if set to false.</p>

<p><strong>show_stat</strong> | <code>stat_id, bool : Stat ID, Visible</code> | Hide the matching stat ID in the statlist if set to false.</p>

<p><strong>name_max_width</strong> | <code>int</code> | The maxiumum width, in pixels, that the character name can occupy until it is abbreviated.</p>

<hr />

<h4>MenuConfig</h4>

<p>Description of menus/config.txt</p>

<p><strong>button_ok</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "OK" button. Not used in the pause menu.</p>

<p><strong>button_defaults</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Defaults" button. Not used in the pause menu.</p>

<p><strong>button_cancel</strong> | <code>int, int, alignment : X, Y, Alignment</code> | Position of the "Cancel" button. Not used in the pause menu.</p>

<p><strong>listbox_scrollbar_offset</strong> | <code>int</code> | Horizontal offset from the right of listboxes (mods, languages, etc) to place the scrollbar.</p>

<p><strong>frame_offset</strong> | <code>point</code> | Offset for all the widgets contained under each tab.</p>

<p><strong>tab_offset</strong> | <code>point</code> | Offset for the row of tabs.</p>

<p><strong>activemods</strong> | <code>int, int, int, int : Label X, Label Y, Widget X, Widget Y</code> | Position of the "Active Mods" list box relative to the frame.</p>

<p><strong>activemods_height</strong> | <code>int</code> | Number of visible rows for the "Active Mods" list box.</p>

<p><strong>inactivemods</strong> | <code>int, int, int, int : Label X, Label Y, Widget X, Widget Y</code> | Position of the "Available Mods" list box relative to the frame.</p>

<p><strong>inactivemods_height</strong> | <code>int</code> | Number of visible rows for the "Available Mods" list box.</p>

<p><strong>activemods_shiftup</strong> | <code>point</code> | Position of the button to shift mods up in "Active Mods" relative to the frame.</p>

<p><strong>activemods_shiftdown</strong> | <code>point</code> | Position of the button to shift mods down in "Active Mods" relative to the frame.</p>

<p><strong>activemods_deactivate</strong> | <code>point</code> | Position of the "Disable" button relative to the frame.</p>

<p><strong>inactivemods_activate</strong> | <code>point</code> | Position of the "Enable" button relative to the frame.</p>

<p><strong>scrollpane</strong> | <code>rectangle</code> | Position of the keybinding scrollbox relative to the frame.</p>

<p><strong>scrollpane_padding</strong> | <code>int, int : Horizontal padding, Vertical padding</code> | Pixel padding for each item listed in a tab's scroll box.</p>

<p><strong>scrollpane_separator_color</strong> | <code>color</code> | Color of the separator line in between scroll box items.</p>

<p><strong>keybinds_bg_color</strong> | <code>color, int : Color, Alpha</code> | Background color and alpha for the keybindings scrollbox.</p>

<hr />

<h4>MenuConfirm</h4>

<p>Description of menus/confirm.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the title text.</p>

<p><strong>action_list</strong> | <code>point</code> | Position of the action selector widget.</p>

<hr />

<h4>Menu</h4>

<p>Description of menus in menus/</p>

<p><strong>pos</strong> | <code>rectangle</code> | Menu position and dimensions</p>

<p><strong>align</strong> | <code>alignment</code> | Position relative to screen edges</p>

<p><strong>soundfx_open</strong> | <code>filename</code> | Filename of a sound to play when opening this menu.</p>

<p><strong>soundfx_close</strong> | <code>filename</code> | Filename of a sound to play when closing this menu.</p>

<p><strong>background</strong> | <code>filename</code> | Filename of the background image for this menu.</p>

<hr />

<h4>MenuDevConsole</h4>

<p>Description of menus/devconsole.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Developer Console" label.</p>

<p><strong>confirm</strong> | <code>point</code> | Position of the "Execute" button.</p>

<p><strong>input</strong> | <code>point</code> | Position of the command entry widget.</p>

<p><strong>history</strong> | <code>rectangle</code> | Position and dimensions of the command history.</p>

<hr />

<h4>MenuEnemy</h4>

<p>Description of menus/enemy.txt</p>

<p><strong>bar_pos</strong> | <code>rectangle</code> | Position and dimensions of the health bar.</p>

<p><strong>text_pos</strong> | <code>label</code> | Position of the text displaying the enemy's name and level.</p>

<p><strong>bar_fill_offset</strong> | <code>point</code> | Offset of the bar's fill graphics relative to the bar_pos X/Y.</p>

<p><strong>bar_fill_size</strong> | <code>int, int : Width, Height</code> | Size of the bar's fill graphics. If not defined, the width/height of bar_pos is used.</p>

<p><strong>bar_gfx</strong> | <code>filename</code> | Filename of the image to use for the "fill" of the bar.</p>

<hr />

<h4>MenuGameOver</h4>

<p>Description of menus/game_over.txt</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Game Over" text.</p>

<p><strong>button_continue</strong> | <code>point</code> | Position of the "Continue" button.</p>

<p><strong>button_exit</strong> | <code>point</code> | Position of the "Exit" button.</p>

<hr />

<h4>MenuHUDLog</h4>

<p>Description of menus/hudlog.txt</p>

<p><strong>enable_overlay</strong> | <code>bool</code> | If true, shows an overlay of the last message on top of other menus.</p>

<p><strong>start_at_bottom</strong> | <code>bool</code> | If true, messages start at the bottom and get pushed up. If false, messages start at the top and get pushed down.</p>

<p><strong>overlay_at_bottom</strong> | <code>bool</code> | If true, the overlay message will be at the bottom of the HUD log area. If false, it will be at the top.</p>

<hr />

<h4>MenuInventory</h4>

<p>Description of menus/inventory.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>set_button</strong> | <code>int, int, int, filename : ID, Widget X, Widget Y, Image file</code> | Set number, position and image filename for an equipment swap set button.</p>

<p><strong>set_previous</strong> | <code>int, int, filename : Widget X, Widget Y, Image file</code> | Position and image filename for an equipment swap set previous button.</p>

<p><strong>set_next</strong> | <code>int, int, filename : Widget X, Widget Y, Image file</code> | Position and image filename for an equipment swap set next button.</p>

<p><strong>label_equipment_set</strong> | <code>label</code> | Label showing the active equipment set.</p>

<p><strong>equipment_slot</strong> | <code>repeatable(int, int, string, int) : X, Y, Slot Type, Equipment set</code> | Position, item type and equipment set number of an equipment slot. Equipment set number is "0" for shared items."</p>

<p><strong>carried_area</strong> | <code>point</code> | Position of the first normal inventory slot.</p>

<p><strong>carried_cols</strong> | <code>int</code> | The number of columns for the normal inventory.</p>

<p><strong>carried_rows</strong> | <code>int</code> | The number of rows for the normal inventory.</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Inventory" label.</p>

<p><strong>currency</strong> | <code>label</code> | Position of the label that displays the total currency being carried.</p>

<p><strong>help</strong> | <code>rectangle</code> | A mouse-over area that displays some help text for inventory shortcuts.</p>

<hr />

<h4>MenuLog</h4>

<p>Description of menus/log.txt</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Log" text.</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>tab_area</strong> | <code>rectangle</code> | The position of the row of tabs, followed by the dimensions of the log text area.</p>

<hr />

<h4>MenuMiniMap</h4>

<p>Description of menus/minimap.txt</p>

<p><strong>map_pos</strong> | <code>rectangle</code> | Position and dimensions of the map.</p>

<p><strong>text_pos</strong> | <code>label</code> | Position of the text label with the map name.</p>

<p><strong>color_wall</strong> | <code>color, int : Color, Alpha</code> | Color used for walls.</p>

<p><strong>color_obst</strong> | <code>color, int : Color, Alpha</code> | Color used for small obstacles and pits.</p>

<p><strong>color_hero</strong> | <code>color, int : Color, Alpha</code> | Color used for the player character.</p>

<p><strong>color_enemy</strong> | <code>color, int : Color, Alpha</code> | Color used for enemies engaged in combat.</p>

<p><strong>color_ally</strong> | <code>color, int : Color, Alpha</code> | Color used for allies.</p>

<p><strong>color_npc</strong> | <code>color, int : Color, Alpha</code> | Color used for NPCs.</p>

<p><strong>color_teleport</strong> | <code>color, int : Color, Alpha</code> | Color used for intermap teleports.</p>

<p><strong>button_config</strong> | <code>point</code> | Position of the 'Configuration' button. The button will be hidden if not defined.</p>

<hr />

<h4>MenuMovementType</h4>

<p>Description of menus/movement_type.txt</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Select a Movement Type" text.</p>

<p><strong>label_config_hint</strong> | <code>label</code> | Position of the "Can be changed later in the Configuration menu" text.</p>

<p><strong>button_keyboard</strong> | <code>point</code> | Position of the "Keyboard" button.</p>

<p><strong>button_mouse</strong> | <code>point</code> | Position of the "Mouse" button.</p>

<p><strong>button_joystick</strong> | <code>point</code> | Position of the "Joystick" button.</p>

<p><strong>icon_keyboard</strong> | <code>point</code> | Position of the keyboard icon.</p>

<p><strong>icon_mouse</strong> | <code>point</code> | Position of the mouse icon.</p>

<p><strong>icon_joystick</strong> | <code>point</code> | Position of the joystick icon.</p>

<hr />

<h4>MenuNumPicker</h4>

<p>Description of menus/num_picker.txt</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Enter amount:" text.</p>

<p><strong>confirm</strong> | <code>point</code> | Position of the "OK" button.</p>

<p><strong>increase</strong> | <code>point</code> | Position of the button used to increase the value.</p>

<p><strong>decrease</strong> | <code>point</code> | Position of the button used to decrease the value.</p>

<p><strong>close</strong> | <code>point</code> | Position of the button used to close the number picker window.</p>

<p><strong>input</strong> | <code>point</code> | Position of the text input box.</p>

<hr />

<h4>MenuPowers: Menu layout</h4>

<p>Description of menus/powers.txt</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Powers" text.</p>

<p><strong>unspent_points</strong> | <code>label</code> | Position of the text that displays the amount of unused power points.</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>tab_area</strong> | <code>rectangle</code> | Position and dimensions of the tree pages.</p>

<hr />

<h4>MenuPowers: Power tree layout</h4>

<p>Description of powers/trees/</p>

<p><strong>background</strong> | <code>filename</code> | Filename of the default background image</p>

<p><strong>tab.title</strong> | <code>string</code> | The name of this power tree tab</p>

<p><strong>tab.background</strong> | <code>filename</code> | Filename of the background image for this tab's power tree</p>

<p><strong>power.id</strong> | <code>int</code> | A power id from powers/powers.txt for this slot.</p>

<p><strong>power.tab</strong> | <code>int</code> | Tab index to place this power on, starting from 0.</p>

<p><strong>power.position</strong> | <code>point</code> | Position of this power icon; relative to MenuPowers "pos".</p>

<p><strong>power.requires_point</strong> | <code>bool</code> | Power requires a power point to unlock.</p>

<p><strong>power.requires_primary</strong> | <code>predefined_string, int : Primary stat name, Required value</code> | Power requires this primary stat to be at least the specificed value.</p>

<p><strong>power.requires_level</strong> | <code>int</code> | Power requires at least this level for the hero.</p>

<p><strong>power.requires_power</strong> | <code>power_id</code> | Power requires another power id.</p>

<p><strong>power.requires_status</strong> | <code>repeatable(string)</code> | Power requires this campaign status.</p>

<p><strong>power.requires_not_status</strong> | <code>repeatable(string)</code> | Power requires not having this campaign status.</p>

<p><strong>power.visible_requires_status</strong> | <code>repeatable(string)</code> | (Deprecated as of v1.11.75) Hide the power if we don't have this campaign status.</p>

<p><strong>power.visible_requires_not_status</strong> | <code>repeatable(string)</code> | (Deprecated as of v1.11.75) Hide the power if we have this campaign status.</p>

<p><strong>power.upgrades</strong> | <code>list(power_id)</code> | A list of upgrade power ids that this power slot can upgrade to. Each of these powers should have a matching upgrade section.</p>

<p><strong>power.visible</strong> | <code>bool</code> | Controls whether or not a power is visible or hidden regardless of unlocked state. Defaults to true.</p>

<p><strong>power.visible_check_locked</strong> | <code>bool</code> | When set to true, the power will be hidden if it is locked. Defaults to false.</p>

<p><strong>power.visible_check_status</strong> | <code>bool</code> | When set to true, the power will be hidden if its status requirements are not met. Defaults to false.</p>

<p><strong>upgrade.id</strong> | <code>int</code> | A power id from powers/powers.txt for this upgrade.</p>

<p><strong>upgrade.requires_primary</strong> | <code>predefined_string, int : Primary stat name, Required value</code> | Upgrade requires this primary stat to be at least the specificed value.</p>

<p><strong>upgrade.requires_point</strong> | <code>bool</code> | Upgrade requires a power point to unlock.</p>

<p><strong>upgrade.requires_level</strong> | <code>int</code> | Upgrade requires at least this level for the hero.</p>

<p><strong>upgrade.requires_power</strong> | <code>int</code> | Upgrade requires another power id.</p>

<p><strong>upgrade.requires_status</strong> | <code>repeatable(string)</code> | Upgrade requires this campaign status.</p>

<p><strong>upgrade.requires_not_status</strong> | <code>repeatable(string)</code> | Upgrade requires not having this campaign status.</p>

<p><strong>upgrade.visible_requires_status</strong> | <code>repeatable(string)</code> | (Deprecated as of v1.11.75) Hide the upgrade if we don't have this campaign status.</p>

<p><strong>upgrade.visible_requires_not_status</strong> | <code>repeatable(string)</code> | (Deprecated as of v1.11.75) Hide the upgrade if we have this campaign status.</p>

<p><strong>upgrade.visible</strong> | <code>bool</code> | Controls whether or not a power is visible or hidden regardless of unlocked state. Defaults to true.</p>

<p><strong>upgrade.visible_check_locked</strong> | <code>bool</code> | When set to true, the power will be hidden if it is locked. Defaults to false.</p>

<p><strong>upgrade.visible_check_status</strong> | <code>bool</code> | When set to true, the power will be hidden if its status requirements are not met. Defaults to false.</p>

<hr />

<h4>MenuStash</h4>

<p>Description of menus/stash.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>slots_area</strong> | <code>point</code> | Position of the top-left slot.</p>

<p><strong>stash_cols</strong> | <code>int</code> | The number of columns for the grid of slots.</p>

<p><strong>stash_rows</strong> | <code>int</code> | The number of rows for the grid of slots.</p>

<p><strong>label_title</strong> | <code>label</code> | Position of the "Stash" label.</p>

<p><strong>currency</strong> | <code>label</code> | Position of the label displaying the amount of currency stored in the stash.</p>

<p><strong>tab.name</strong> | <code>["Private", "Shared", string]</code> | The displayed name of this tab. It is also used to determine the filename of the stash file that the engine will create. 'Private' and 'Shared' will use their legacy filenames for compatibility.</p>

<p><strong>tab.is_private</strong> | <code>bool</code> | If true, this stash will not be shared across other saves.</p>

<hr />

<h4>MenuStatBar</h4>

<p>Description of menus/hp.txt, menus/mp.txt, menus/xp.txt</p>

<p><strong>bar_pos</strong> | <code>rectangle</code> | Position and dimensions of the bar graphics.</p>

<p><strong>text_pos</strong> | <code>label</code> | Position of the text displaying the current value of the relevant stat.</p>

<p><strong>orientation</strong> | <code>bool</code> | True is vertical orientation; false is horizontal.</p>

<p><strong>bar_gfx</strong> | <code>filename</code> | Filename of the image to use for the "fill" of the bar.</p>

<p><strong>bar_gfx_background</strong> | <code>filename</code> | Filename of the image to use for the base of the bar.</p>

<p><strong>hide_timeout</strong> | <code>duration</code> | Hide HP and MP bar if full mana or health, after given amount of seconds; Hide XP bar if no changes in XP points for given amount of seconds. 0 disable hiding.</p>

<p><strong>bar_fill_offset</strong> | <code>point</code> | Offset of the bar's fill graphics relative to the bar_pos X/Y.</p>

<p><strong>bar_fill_size</strong> | <code>int, int : Width, Height</code> | Size of the bar's fill graphics. If not defined, the width/height of bar_pos is used.</p>

<p><strong>enabled</strong> | <code>bool</code> | Determines if the bar will be rendered. Disable the bar completely by setting this to false.</p>

<hr />

<h4>MenuTalker</h4>

<p>Description of menus/talker.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>advance</strong> | <code>point</code> | Position of the button to advance dialog.</p>

<p><strong>dialogbox</strong> | <code>rectangle</code> | Position and dimensions of the text box graphics.</p>

<p><strong>dialogtext</strong> | <code>rectangle</code> | Rectangle where the dialog text is placed.</p>

<p><strong>text_offset</strong> | <code>point</code> | Margins for the left/right and top/bottom of the dialog text.</p>

<p><strong>portrait_he</strong> | <code>rectangle</code> | Position and dimensions of the NPC portrait graphics.</p>

<p><strong>portrait_you</strong> | <code>rectangle</code> | Position and dimensions of the player's portrait graphics.</p>

<p><strong>font_who</strong> | <code>predefined_string</code> | Font style to use for the name of the currently talking person.</p>

<p><strong>font_dialog</strong> | <code>predefined_string</code> | Font style to use for the dialog text.</p>

<p><strong>topic_color_normal</strong> | <code>color</code> | The normal color for topic text.</p>

<p><strong>topic_color_hover</strong> | <code>color</code> | The color for topic text when highlighted.</p>

<p><strong>topic_color_normal</strong> | <code>color</code> | The color for topic text when clicked.</p>

<p><strong>trade_color_normal</strong> | <code>color</code> | The normal color for the "Trade" text.</p>

<p><strong>trade_color_hover</strong> | <code>color</code> | The color for the "Trade" text when highlighted.</p>

<p><strong>trade_color_normal</strong> | <code>color</code> | The color for the "Trade" text when clicked.</p>

<hr />

<h4>MenuVendor</h4>

<p>Description of menus/vendor.txt</p>

<p><strong>close</strong> | <code>point</code> | Position of the close button.</p>

<p><strong>slots_area</strong> | <code>point</code> | Position of the top-left slot.</p>

<p><strong>vendor_cols</strong> | <code>int</code> | The number of columns in the grid of slots.</p>

<p><strong>vendor_rows</strong> | <code>int</code> | The number of rows in the grid of slots.</p>

<p><strong>label_title</strong> | <code>label</code> | The position of the text that displays the NPC's name.</p>

<hr />

<h4>ModManager</h4>

<p>Description of mod settings.txt</p>

<p><strong>description</strong> | <code>string</code> | Some text describing the mod.</p>

<p><strong>description_locale</strong> | <code>string, string : Language, Translated description</code> | A translated description for a language (specified by 2-letter code).</p>

<p><strong>version</strong> | <code>version</code> | The version number of this mod.</p>

<p><strong>requires</strong> | <code>list(string)</code> | A comma-separated list of the mods that are required in order to use this mod. The dependency version requirements can also be specified and separated by colons (e.g. fantasycore:0.1:2.0).</p>

<p><strong>game</strong> | <code>string</code> | The game which this mod belongs to (e.g. flare-game).</p>

<p><strong>engine_version_min</strong> | <code>version</code> | The minimum engine version required to use this mod.</p>

<p><strong>engine_version_max</strong> | <code>version</code> | The maximum engine version required to use this mod.</p>

<hr />

<h4>NPC</h4>

<p>Description of NPCs in npcs/</p>

<p><strong>dialog.id</strong> | <code>string</code> | A unique identifer used to reference this dialog.</p>

<p><strong>dialog.him</strong> | <code>repeatable(string)</code> | A line of dialog from the NPC.</p>

<p><strong>dialog.her</strong> | <code>repeatable(string)</code> | A line of dialog from the NPC.</p>

<p><strong>dialog.you</strong> | <code>repeatable(string)</code> | A line of dialog from the player.</p>

<p><strong>dialog.voice</strong> | <code>repeatable(string)</code> | Filename of a voice sound file to play.</p>

<p><strong>dialog.topic</strong> | <code>string</code> | The name of this dialog topic. Displayed when picking a dialog tree.</p>

<p><strong>dialog.group</strong> | <code>string</code> | Dialog group.</p>

<p><strong>dialog.allow_movement</strong> | <code>bool</code> | Restrict the player's mvoement during dialog.</p>

<p><strong>dialog.portrait_him</strong> | <code>repeatable(filename)</code> | Filename of a portrait to display for the NPC during this dialog.</p>

<p><strong>dialog.portrait_her</strong> | <code>repeatable(filename)</code> | Filename of a portrait to display for the NPC during this dialog.</p>

<p><strong>dialog.portrait_you</strong> | <code>repeatable(filename)</code> | Filename of a portrait to display for the player during this dialog.</p>

<p><strong>dialog.take_a_party</strong> | <code>bool</code> | Start/stop taking a party with player.</p>

<p><strong>dialog.response</strong> | <code>repeatable(string)</code> | A dialog ID to present as a selectable response. This key must precede the dialog text line.</p>

<p><strong>dialog.response_only</strong> | <code>bool</code> | If true, this dialog topic will only appear when explicitly referenced with the "response" key.</p>

<p><strong>npc.name</strong> | <code>string</code> | NPC's name.</p>

<p><strong>npc.direction</strong> | <code>direction</code> | The direction to use for this NPC's stance animation.</p>

<p><strong>npc.show_on_minimap</strong> | <code>bool</code> | If true, this NPC will be shown on the minimap. The default is true.</p>

<p><strong>npc.talker</strong> | <code>bool</code> | Allows this NPC to be talked to.</p>

<p><strong>npc.portrait</strong> | <code>filename</code> | Filename of the default portrait image.</p>

<p><strong>npc.vendor</strong> | <code>bool</code> | Allows this NPC to buy/sell items.</p>

<p><strong>npc.vendor_requires_status</strong> | <code>list(string)</code> | The player must have these statuses in order to use this NPC as a vendor.</p>

<p><strong>npc.vendor_requires_not_status</strong> | <code>list(string)</code> | The player must not have these statuses in order to use this NPC as a vendor.</p>

<p><strong>npc.constant_stock</strong> | <code>repeatable(list(item_id))</code> | A list of items this vendor has for sale. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>npc.status_stock</strong> | <code>repeatable(string, list(item_id)) : Required status, Item(s)</code> | A list of items this vendor will have for sale if the required status is met. Quantity can be specified by appending ":Q" to the item_id, where Q is an integer.</p>

<p><strong>npc.random_stock</strong> | <code>list(loot)</code> | Use a loot table to add random items to the stock; either a filename or an inline definition.</p>

<p><strong>npc.random_stock_count</strong> | <code>int, int : Min, Max</code> | Sets the minimum (and optionally, the maximum) amount of random items this npc can have.</p>

<p><strong>npc.vendor_ratio_buy</strong> | <code>float</code> | NPC-specific version of vendor_ratio_buy from engine/loot.txt. Uses the global setting when set to 0.</p>

<p><strong>npc.vendor_ratio_sell</strong> | <code>float</code> | NPC-specific version of vendor_ratio_sell from engine/loot.txt. Uses the global setting when set to 0.</p>

<p><strong>npc.vendor_ratio_sell_old</strong> | <code>float</code> | NPC-specific version of vendor_ratio_sell_old from engine/loot.txt. Uses the global setting when set to 0.</p>

<p><strong>npc.vox_intro</strong> | <code>repeatable(filename)</code> | Filename of a sound file to play when initially interacting with the NPC.</p>

<hr />

<h4>PowerManager: Effects</h4>

<p>Description of powers/effects.txt</p>

<p><strong>effect.id</strong> | <code>string</code> | Unique identifier for the effect definition.</p>

<p><strong>effect.type</strong> | <code>string</code> | Defines the type of effect</p>

<p><strong>effect.name</strong> | <code>string</code> | A displayed name that is shown when hovering the mouse over the effect icon.</p>

<p><strong>effect.icon</strong> | <code>icon_id</code> | The icon to visually represent the effect in the status area</p>

<p><strong>effect.animation</strong> | <code>filename</code> | The filename of effect animation.</p>

<p><strong>effect.can_stack</strong> | <code>bool</code> | Allows multiple instances of this effect</p>

<p><strong>effect.max_stacks</strong> | <code>int</code> | Maximum allowed instances of this effect, -1 for no limits</p>

<p><strong>effect.group_stack</strong> | <code>bool</code> | For effects that can stack, setting this to true will combine those effects into a single status icon.</p>

<p><strong>effect.render_above</strong> | <code>bool</code> | Effect is rendered above</p>

<p><strong>effect.color_mod</strong> | <code>color</code> | Changes the color of the afflicted entity.</p>

<p><strong>effect.alpha_mod</strong> | <code>int</code> | Changes the alpha of the afflicted entity.</p>

<p><strong>effect.attack_speed_anim</strong> | <code>string</code> | If the type of Effect is attack_speed, this defines the attack animation that will have its speed changed.</p>

<hr />

<h4>PowerManager: Powers</h4>

<p>Description of powers/powers.txt</p>

<p><strong>power.id</strong> | <code>power_id</code> | Uniq identifier for the power definition.</p>

<p><strong>power.type</strong> | <code>["fixed", "missile", "repeater", "spawn", "transform", "block"]</code> | Defines the type of power definiton</p>

<p><strong>power.name</strong> | <code>string</code> | The name of the power</p>

<p><strong>power.description</strong> | <code>string</code> | Description of the power</p>

<p><strong>power.icon</strong> | <code>icon_id</code> | The icon to visually represent the power eg. in skill tree or action bar.</p>

<p><strong>power.new_state</strong> | <code>predefined_string</code> | When power is used, hero or enemy will change to this state. Must be one of the states ["instant", user defined]</p>

<p><strong>power.state_duration</strong> | <code>duration</code> | Sets the length of time the caster is in their state animation. A time longer than the animation length will cause the animation to pause on the last frame. Times shorter than the state animation length will have no effect.</p>

<p><strong>power.prevent_interrupt</strong> | <code>bool</code> | Prevents the caster from being interrupted by a hit when casting this power.</p>

<p><strong>power.face</strong> | <code>bool</code> | Power will make hero or enemy to face the target location.</p>

<p><strong>power.source_type</strong> | <code>["hero", "neutral", "enemy"]</code> | Determines which entities the power can effect.</p>

<p><strong>power.beacon</strong> | <code>bool</code> | True if enemy is calling its allies.</p>

<p><strong>power.count</strong> | <code>int</code> | The count of hazards/effect or spawns to be created by this power.</p>

<p><strong>power.passive</strong> | <code>bool</code> | If power is unlocked when the hero or enemy spawns it will be automatically activated.</p>

<p><strong>power.passive_trigger</strong> | <code>["on_block", "on_hit", "on_halfdeath", "on_joincombat", "on_death"]</code> | This will only activate a passive power under a certain condition.</p>

<p><strong>power.meta_power</strong> | <code>bool</code> | If true, this power can not be used on it's own. Instead, it should be replaced via an item with a replace_power entry.</p>

<p><strong>power.no_actionbar</strong> | <code>bool</code> | If true, this power is prevented from being placed on the actionbar.</p>

<p><strong>power.requires_flags</strong> | <code>list(predefined_string)</code> | A comma separated list of equip flags that are required to use this power. See engine/equip_flags.txt</p>

<p><strong>power.requires_mp</strong> | <code>float</code> | Require an amount of MP to use the power. The amount will be consumed on usage.</p>

<p><strong>power.requires_hp</strong> | <code>float</code> | Require an amount of HP to use the power. The amount will be consumed on usage.</p>

<p><strong>power.requires_resource_stat</strong> | <code>repeatable(predefined_string, float) : Resource stat ID, Required amount</code> | Requires an amount of a given resource to use the power. The amount will be consumed on usage.</p>

<p><strong>power.sacrifice</strong> | <code>bool</code> | If the power has requires_hp, allow it to kill the caster.</p>

<p><strong>power.requires_los</strong> | <code>bool</code> | Requires a line-of-sight to target.</p>

<p><strong>power.requires_empty_target</strong> | <code>bool</code> | The power can only be cast when target tile is empty.</p>

<p><strong>power.requires_item</strong> | <code>repeatable(item_id, int) : Item, Quantity</code> | Requires a specific item of a specific quantity in inventory. If quantity &gt; 0, then the item will be removed.</p>

<p><strong>power.requires_equipped_item</strong> | <code>repeatable(item_id, int) : Item, Quantity</code> | Requires a specific item of a specific quantity to be equipped on hero. If quantity &gt; 0, then the item will be removed.</p>

<p><strong>power.requires_targeting</strong> | <code>bool</code> | Power is only used when targeting using click-to-target.</p>

<p><strong>power.requires_spawns</strong> | <code>int</code> | The caster must have at least this many summoned creatures to use this power.</p>

<p><strong>power.cooldown</strong> | <code>duration</code> | Specify the duration for cooldown of the power in 'ms' or 's'.</p>

<p><strong>power.requires_hpmp_state</strong> | <code>["all", "any"], ["percent", "not_percent", "ignore"], float , ["percent", "not_percent", "ignore"], float : Mode, HP state, HP Percentage value, MP state, MP Percentage value</code> | Power can only be used when HP/MP matches the specified state. In 'all' mode, both HP and MP must meet the requirements, where as only one must in 'any' mode. To check a single stat, use 'all' mode and set the 'ignore' state for the other stat.</p>

<p><strong>power.requires_resource_stat_state</strong> | <code>predefined_string, ["percent", "not_percent", "ignore"], float : Resource stat ID, State, Percentage value</code> | Power can only be used when the resource stat matches the specified state. See 'requires_resource_stat_state_mode' for combining multiple resource states and, optionally, HP/MP state.</p>

<p><strong>power.requires_resource_stat_state_mode</strong> | <code>["all", "any", "any_hpmp"]</code> | Determines how required resource state is handled for multiple resources. "all" means that HP/MP state AND all resource stat states must pass. "any" means that HP/MP state must pass AND at least one resource stat state must pass. "any_hpmp" means that HP/MP state OR at least one resource stat state is required to pass.</p>

<p><strong>power.animation</strong> | <code>filename</code> | The filename of the power animation.</p>

<p><strong>power.soundfx</strong> | <code>filename</code> | Filename of a sound effect to play when the power is used.</p>

<p><strong>power.soundfx_hit</strong> | <code>filename</code> | Filename of a sound effect to play when the power's hazard hits a valid target.</p>

<p><strong>power.directional</strong> | <code>bool</code> | The animation sprite sheet contains 8 directions, one per row.</p>

<p><strong>power.visual_random</strong> | <code>int</code> | The animation sprite sheet contains rows of random options</p>

<p><strong>power.visual_option</strong> | <code>int</code> | The animation sprite sheet containers rows of similar effects, use a specific option. If using visual_random, this serves as an offset for the lowest random index.</p>

<p><strong>power.aim_assist</strong> | <code>bool</code> | If true, power targeting will be offset vertically by the number of pixels set with "aim_assist" in engine/misc.txt.</p>

<p><strong>power.speed</strong> | <code>float</code> | The speed of missile hazard, the unit is defined as map units per frame.</p>

<p><strong>power.lifespan</strong> | <code>duration</code> | How long the hazard/animation lasts in 'ms' or 's'.</p>

<p><strong>power.floor</strong> | <code>bool</code> | The hazard is drawn between the background and the object layer.</p>

<p><strong>power.complete_animation</strong> | <code>bool</code> | For hazards; Play the entire animation, even if the hazard has hit a target.</p>

<p><strong>power.charge_speed</strong> | <code>float</code> | Moves the caster at this speed in the direction they are facing until the state animation is finished.</p>

<p><strong>power.attack_speed</strong> | <code>float</code> | Changes attack animation speed for this Power. A value of 100 is 100% speed (aka normal speed).</p>

<p><strong>power.use_hazard</strong> | <code>bool</code> | Power uses hazard.</p>

<p><strong>power.no_attack</strong> | <code>bool</code> | Hazard won't affect other entities.</p>

<p><strong>power.no_aggro</strong> | <code>bool</code> | If true, the Hazard won't put its target in a combat state.</p>

<p><strong>power.radius</strong> | <code>float</code> | Radius in map units</p>

<p><strong>power.base_damage</strong> | <code>predefined_string : Damage type ID</code> | Determines which damage stat will be used to calculate damage.</p>

<p><strong>power.starting_pos</strong> | <code>["source", "target", "melee"]</code> | Start position for hazard</p>

<p><strong>power.relative_pos</strong> | <code>bool</code> | Hazard will move relative to the caster's position.</p>

<p><strong>power.multitarget</strong> | <code>bool</code> | Allows a hazard power to hit more than one entity.</p>

<p><strong>power.multihit</strong> | <code>bool</code> | Allows a hazard power to hit the same entity more than once.</p>

<p><strong>power.expire_with_caster</strong> | <code>bool</code> | If true, hazard will disappear when the caster dies.</p>

<p><strong>power.ignore_zero_damage</strong> | <code>bool</code> | If true, hazard can still hit the player when damage is 0, triggering post_power and post_effects.</p>

<p><strong>power.lock_target_to_direction</strong> | <code>bool</code> | If true, the target is "snapped" to one of the 8 directions.</p>

<p><strong>power.movement_type</strong> | <code>["ground", "flying", "intangible"]</code> | For moving hazards (missile/repeater), this defines which parts of the map it can collide with. The default is "flying".</p>

<p><strong>power.trait_armor_penetration</strong> | <code>bool</code> | Ignores the target's Absorbtion stat</p>

<p><strong>power.trait_avoidance_ignore</strong> | <code>bool</code> | Ignores the target's Avoidance stat</p>

<p><strong>power.trait_crits_impaired</strong> | <code>int</code> | Increases critical hit percentage for slowed/immobile targets</p>

<p><strong>power.trait_elemental</strong> | <code>predefined_string</code> | Damage done is elemental. See engine/elements.txt</p>

<p><strong>power.target_range</strong> | <code>float</code> | The distance from the caster that the power can be activated</p>

<p><strong>power.hp_steal</strong> | <code>float</code> | Percentage of damage to steal into HP</p>

<p><strong>power.mp_steal</strong> | <code>float</code> | Percentage of damage to steal into MP</p>

<p><strong>power.resource_steal</strong> | <code>repeatable(predefined_string, float) : Resource stat ID, Steal amount</code> | Percentage of damage to steal into the specified resource</p>

<p><strong>power.missile_angle</strong> | <code>float</code> | Angle of missile</p>

<p><strong>power.angle_variance</strong> | <code>float</code> | Percentage of variance added to missile angle</p>

<p><strong>power.speed_variance</strong> | <code>float</code> | Percentage of variance added to missile speed</p>

<p><strong>power.delay</strong> | <code>duration</code> | Delay between repeats in 'ms' or 's'.</p>

<p><strong>power.transform_duration</strong> | <code>duration</code> | Duration for transform in 'ms' or 's'.</p>

<p><strong>power.manual_untransform</strong> | <code>bool</code> | Force manual untranform</p>

<p><strong>power.keep_equipment</strong> | <code>bool</code> | Keep equipment while transformed</p>

<p><strong>power.untransform_on_hit</strong> | <code>bool</code> | Force untransform when the player is hit</p>

<p><strong>power.buff</strong> | <code>bool</code> | Power is cast upon the caster.</p>

<p><strong>power.buff_teleport</strong> | <code>bool</code> | Power is a teleportation power.</p>

<p><strong>power.buff_party</strong> | <code>bool</code> | Power is cast upon party members</p>

<p><strong>power.buff_party_power_id</strong> | <code>power_id</code> | Only party members that were spawned with this power ID are affected by "buff_party=true". Setting this to 0 will affect all party members.</p>

<p><strong>power.post_effect</strong> | <code>predefined_string, float, duration , float : Effect ID, Magnitude, Duration, Chance to apply</code> | Post effect to apply to target. Duration is in 'ms' or 's'.</p>

<p><strong>power.post_effect_src</strong> | <code>predefined_string, float, duration , float : Effect ID, Magnitude, Duration, Chance to apply</code> | Post effect to apply to caster. Duration is in 'ms' or 's'.</p>

<p><strong>power.pre_power</strong> | <code>power_id, float : Power, Chance to cast</code> | Trigger a power immediately when casting this one.</p>

<p><strong>power.post_power</strong> | <code>power_id, int : Power, Chance to cast</code> | Trigger a power if the hazard did damage. For 'block' type powers, this power will be triggered when the blocker takes damage.</p>

<p><strong>power.wall_power</strong> | <code>power_id, int : Power, Chance to cast</code> | Trigger a power if the hazard hit a wall.</p>

<p><strong>power.wall_reflect</strong> | <code>bool</code> | Moving power will bounce off walls and keep going</p>

<p><strong>power.spawn_type</strong> | <code>predefined_string</code> | For non-transform powers, an enemy is spawned from this category. For transform powers, the caster will transform into a creature from this category.</p>

<p><strong>power.target_neighbor</strong> | <code>int</code> | Target is changed to an adjacent tile within a radius.</p>

<p><strong>power.spawn_limit</strong> | <code>["unlimited", "fixed", "stat"], int, float, predefined_string : Mode, Entity Level, Ratio, Primary stat</code> | The maximum number of creatures that can be spawned and alive from this power. The need for the last three parameters depends on the mode being used. The "unlimited" mode requires no parameters and will remove any spawn limit requirements. The "fixed" mode takes one parameter as the spawn limit. The "stat" mode also requires the ratio and primary stat ID as parameters. The ratio adjusts the scaling of the spawn limit. For example, spawn_limit=stat,1,2,physical will set the spawn limit to 1/2 the summoner's Physical stat.</p>

<p><strong>power.spawn_level</strong> | <code>["default", "fixed", "level", "stat"], int, float, predefined_string : Mode, Entity Level, Ratio, Primary stat</code> | The level of spawned creatures. The need for the last three parameters depends on the mode being used. The "default" mode will just use the entity's normal level and doesn't require any additional parameters. The "fixed" mode only requires the entity level as a parameter. The "stat" and "level" modes also require the ratio as a parameter. The ratio adjusts the scaling of the entity level. For example, spawn_level=stat,1,2,physical will set the spawned entity level to 1/2 the summoner's Physical stat. Only the "stat" mode requires the last parameter, which is simply the ID of the primary stat that should be used for scaling.</p>

<p><strong>power.target_party</strong> | <code>bool</code> | Hazard will only affect party members.</p>

<p><strong>power.target_categories</strong> | <code>list(predefined_string)</code> | Hazard will only affect enemies in these categories.</p>

<p><strong>power.modifier_accuracy</strong> | <code>["multiply", "add", "absolute"], float : Mode, Value</code> | Changes this power's accuracy.</p>

<p><strong>power.modifier_damage</strong> | <code>["multiply", "add", "absolute"], float, float : Mode, Min, Max</code> | Changes this power's damage. The "Max" value is ignored, except in the case of "absolute" modifiers.</p>

<p><strong>power.modifier_critical</strong> | <code>["multiply", "add", "absolute"], float : Mode, Value</code> | Changes the chance that this power will land a critical hit.</p>

<p><strong>power.target_movement_normal</strong> | <code>bool</code> | Power can affect entities with normal movement (aka walking on ground)</p>

<p><strong>power.target_movement_flying</strong> | <code>bool</code> | Power can affect flying entities</p>

<p><strong>power.target_movement_intangible</strong> | <code>bool</code> | Power can affect intangible entities</p>

<p><strong>power.walls_block_aoe</strong> | <code>bool</code> | When true, prevents hazard aoe from hitting targets that are behind walls/pits.</p>

<p><strong>power.script</strong> | <code>["on_cast", "on_hit", "on_wall"], filename : Trigger, Filename</code> | Loads and executes a script file when the trigger is activated.</p>

<p><strong>power.remove_effect</strong> | <code>repeatable(predefined_string, int) : Effect ID, Number of Effect instances</code> | Removes a number of instances of a specific Effect ID. Omitting the number of instances, or setting it to zero, will remove all instances/stacks.</p>

<p><strong>power.replace_by_effect</strong> | <code>repeatable(int, predefined_string, int) : Power ID, Effect ID, Number of Effect instances</code> | If the caster has at least the number of instances of the Effect ID, the defined Power ID will be cast instead.</p>

<p><strong>power.requires_corpse</strong> | <code>["consume", bool]</code> | If true, a corpse must be targeted for this power to be used. If "consume", then the corpse is also consumed on Power use.</p>

<p><strong>power.target_nearest</strong> | <code>float</code> | Will automatically target the nearest enemy within the specified range.</p>

<p><strong>power.disable_equip_slots</strong> | <code>list(predefined_string)</code> | Passive powers only. A comma separated list of equip slot types to disable when this power is active.</p>

<hr />

<h4>QuestLog</h4>

<p>Description of quest files in quests/</p>

<p><strong>name</strong> | <code>string</code> | A displayed name for this quest.</p>

<p><strong>complete_status</strong> | <code>string</code> | If this status is set, the quest will be displayed as completed.</p>

<p><strong>quest.requires_status</strong> | <code>list(string)</code> | Quest requires this campaign status</p>

<p><strong>quest.requires_not_status</strong> | <code>list(string)</code> | Quest requires not having this campaign status.</p>

<p><strong>quest.requires_level</strong> | <code>int</code> | Quest requires hero level</p>

<p><strong>quest.requires_not_level</strong> | <code>int</code> | Quest requires not hero level</p>

<p><strong>quest.requires_currency</strong> | <code>int</code> | Quest requires atleast this much currency</p>

<p><strong>quest.requires_not_currency</strong> | <code>int</code> | Quest requires no more than this much currency</p>

<p><strong>quest.requires_item</strong> | <code>list(item_id)</code> | Quest requires specific item (not equipped)</p>

<p><strong>quest.requires_not_item</strong> | <code>list(item_id)</code> | Quest requires not having a specific item (not equipped)</p>

<p><strong>quest.requires_class</strong> | <code>predefined_string</code> | Quest requires this base class</p>

<p><strong>quest.requires_not_class</strong> | <code>predefined_string</code> | Quest requires not this base class</p>

<p><strong>quest.quest_text</strong> | <code>string</code> | Text that gets displayed in the Quest log when this quest is active.</p>

<hr />

<h4>SDLFontEngine: Font settings</h4>

<p>Description of engine/font_settings.txt</p>

<p><strong>font.id</strong> | <code>string</code> | An identifier used to reference this font.</p>

<p><strong>font.style</strong> | <code>repeatable(["default", predefined_string], filename, int, bool) : Language, Font file, Point size, Blending</code> | Filename, point size, and blend mode of the font to use for this language. Language can be "default" or a 2-letter region code.</p>

<hr />

<h4>StatBlock: Core stats</h4>

<p>Description of engine/stats.txt, enemies/..., and npcs/...</p>

<p><strong>speed</strong> | <code>float</code> | Movement speed</p>

<p><strong>cooldown</strong> | <code>duration</code> | Cooldown between attacks in 'ms' or 's'.</p>

<p><strong>cooldown_hit</strong> | <code>duration</code> | Duration of cooldown after being hit in 'ms' or 's'.</p>

<p><strong>stat</strong> | <code>stat_id, float : Stat ID, Value</code> | The starting value for this stat.</p>

<p><strong>stat_per_level</strong> | <code>stat_id, float : Stat ID, Value</code> | The value for this stat added per level.</p>

<p><strong>stat_per_primary</strong> | <code>predefined_string, stat_id, float : Primary Stat, Stat ID, Value</code> | The value for this stat added for every point allocated to this primary stat.</p>

<p><strong>vulnerable</strong> | <code>predefined_string, float : Element, Value</code> | (Deprecated in v1.12.91; use a '..._resist' value with 'stat' instead) Percentage weakness to this element.</p>

<p><strong>power_filter</strong> | <code>list(power_id)</code> | Only these powers are allowed to hit this entity.</p>

<p><strong>categories</strong> | <code>list(string)</code> | Categories that this entity belongs to.</p>

<p><strong>melee_range</strong> | <code>float</code> | Determines the distance from the caster that some powers will be placed. For AI entities, it also means the minimum distance from target required to use melee powers.</p>

<hr />

<h4>StatBlock: Sound effects</h4>

<p>Description of sound effect properties in engine/stats.txt, enemies/..., and npcs/...</p>

<p><strong>sfx_attack</strong> | <code>repeatable(predefined_string, filename) : Animation name, Sound file</code> | Filename of sound effect for the specified attack animation.</p>

<p><strong>sfx_hit</strong> | <code>repeatable(filename)</code> | Filename of sound effect for being hit.</p>

<p><strong>sfx_die</strong> | <code>repeatable(filename)</code> | Filename of sound effect for dying.</p>

<p><strong>sfx_critdie</strong> | <code>repeatable(filename)</code> | Filename of sound effect for dying to a critical hit.</p>

<p><strong>sfx_block</strong> | <code>repeatable(filename)</code> | Filename of sound effect for blocking an incoming hit.</p>

<p><strong>sfx_levelup</strong> | <code>filename</code> | Filename of sound effect for leveling up.</p>

<p><strong>sfx_lowhp</strong> | <code>filename, bool : Sound file, loop</code> | Filename of sound effect for low health warning. Optionally, it can be looped.</p>

<hr />

<h4>StatBlock: Render layers</h4>

<p>Description of 'render_layers' section in engine/stats.txt, enemies/..., and npcs/...</p>

<p><strong>render_layers.layer</strong> | <code>direction, list(string) : Direction, Layer name(s)</code> | Defines the layer order of slots for a given direction.</p>

<hr />

<h4>StatBlock: Animation slots</h4>

<p>Description of 'animation_slots' section in enemies/... and npcs/...</p>

<p><strong>animation_slots.slot</strong> | <code>string, filename : Slot name, Animation filename</code> | Assigns an animation to one of the slots defined in the render_layers section.</p>

<hr />

<h4>StatBlock: Enemies</h4>

<p>Description of enemies in enemies/</p>

<p><strong>name</strong> | <code>string</code> | Name</p>

<p><strong>humanoid</strong> | <code>bool</code> | This creature gives human traits when transformed into, such as the ability to talk with NPCs.</p>

<p><strong>lifeform</strong> | <code>bool</code> | Determines whether or not this entity is referred to as a living thing, such as displaying "Dead" vs "Destroyed" when their HP is 0.</p>

<p><strong>level</strong> | <code>int</code> | Level</p>

<p><strong>xp</strong> | <code>int</code> | XP awarded upon death.</p>

<p><strong>xp_scaling</strong> | <code>filename</code> | XP multiplier table file. See: "XPScaling".</p>

<p><strong>loot</strong> | <code>repeatable(loot)</code> | Possible loot that can be dropped on death.</p>

<p><strong>loot_count</strong> | <code>int, int : Min, Max</code> | Sets the minimum (and optionally, the maximum) amount of loot this creature can drop. Overrides the global drop_max setting.</p>

<p><strong>defeat_status</strong> | <code>string</code> | Campaign status to set upon death.</p>

<p><strong>convert_status</strong> | <code>string</code> | Campaign status to set upon being converted to a player ally.</p>

<p><strong>first_defeat_loot</strong> | <code>item_id</code> | Drops this item upon first death.</p>

<p><strong>quest_loot</strong> | <code>string, string, item_id : Required status, Required not status, Item</code> | Drops this item when campaign status is met.</p>

<p><strong>flying</strong> | <code>bool</code> | Creature can move over gaps/water.</p>

<p><strong>intangible</strong> | <code>bool</code> | Creature can move through walls.</p>

<p><strong>facing</strong> | <code>bool</code> | Creature can turn to face their target.</p>

<p><strong>waypoint_pause</strong> | <code>duration</code> | Duration to wait at each waypoint in 'ms' or 's'.</p>

<p><strong>turn_delay</strong> | <code>duration</code> | Duration it takes for this creature to turn and face their target in 'ms' or 's'.</p>

<p><strong>chance_pursue</strong> | <code>float</code> | Percentage change that the creature will chase their target.</p>

<p><strong>chance_flee</strong> | <code>float</code> | Percentage chance that the creature will run away from their target.</p>

<p><strong>power</strong> | <code>["melee", "ranged", "beacon", "on_hit", "on_death", "on_half_dead", "on_join_combat", "on_debuff"], power_id, int : State, Power, Chance</code> | A power that has a chance of being triggered in a certain state.</p>

<p><strong>passive_powers</strong> | <code>list(power_id)</code> | A list of passive powers this creature has.</p>

<p><strong>threat_range</strong> | <code>float, float : Engage distance, Stop distance</code> | The first value is the radius of the area this creature will be able to start chasing the hero. The second, optional, value is the radius at which this creature will stop pursuing their target and defaults to double the first value.</p>

<p><strong>flee_range</strong> | <code>float</code> | The radius at which this creature will start moving to a safe distance. Defaults to half of the threat_range.</p>

<p><strong>combat_style</strong> | <code>["default", "aggressive", "passive"]</code> | How the creature will enter combat. Default is within range of the hero; Aggressive is always in combat; Passive must be attacked to enter combat.</p>

<p><strong>animations</strong> | <code>filename</code> | Filename of an animation definition.</p>

<p><strong>suppress_hp</strong> | <code>bool</code> | Hides the enemy HP bar for this creature.</p>

<p><strong>flee_duration</strong> | <code>duration</code> | The minimum amount of time that this creature will flee. They may flee longer than the specified time.</p>

<p><strong>flee_cooldown</strong> | <code>duration</code> | The amount of time this creature must wait before they can start fleeing again.</p>

<hr />

<h4>StatBlock: Hero stats</h4>

<p>Description of engine/stats.txt</p>

<p><strong>max_points_per_stat</strong> | <code>int</code> | Maximum points for each primary stat.</p>

<p><strong>sfx_step</strong> | <code>string</code> | An id for a set of step sound effects. See items/step_sounds.txt.</p>

<p><strong>stat_points_per_level</strong> | <code>int</code> | The amount of stat points awarded each level.</p>

<p><strong>power_points_per_level</strong> | <code>int</code> | The amount of power points awarded each level.</p>

<hr />

<h4>Subtitles</h4>

<p>Description of soundfx/subtitles.txt</p>

<p><strong>style.text_pos</strong> | <code>label</code> | Position and style of the subtitle text.</p>

<p><strong>style.pos</strong> | <code>point</code> | Position of the subtitle text relative to alignment.</p>

<p><strong>style.align</strong> | <code>alignment</code> | Alignment of the subtitle text.</p>

<p><strong>style.background_color</strong> | <code>color, int : Color, Alpha</code> | Color and alpha of the subtitle background rectangle.</p>

<p><strong>subtitle.id</strong> | <code>filename</code> | Filename of the sound file that will trigger this subtitle.</p>

<p><strong>subtitle.text</strong> | <code>string</code> | The subtitle text that will be displayed.</p>

<hr />

<h4>TileSet</h4>

<p>Description of tilesets in tilesets/</p>

<p><strong>tileset.img</strong> | <code>filename</code> | Filename of a tile sheet image.</p>

<p><strong>tileset.tile</strong> | <code>int, int, int, int, int, int, int : Index, X, Y, Width, Height, X offset, Y offset</code> | A single tile definition.</p>

<p><strong>tileset.animation</strong> | <code>list(int, int, int, duration) : Tile index, X, Y, duration</code> | An animation for a tile. Durations are in 'ms' or 's'.</p>

<hr />

<h4>XPScaling</h4>

<p>Description of enemies/xp_scaling/</p>

<p><strong>absolute.level</strong> | <code>int, float : Level, Multiplier</code> | The multiplier that will be applied to the rewarded XP when an enemy is at a specific level. If the enemy's level is outside the defined scaling levels, the min or max level is used (whichever is closer).</p>

<p><strong>relative.level</strong> | <code>int, float : Level, Multiplier</code> | The multiplier that will be applied to the rewarded XP when an enemy's level is X levels apart from the player's level. If the enemy's level is outside the defined scaling levels, the min or max level is used (whichever is closer).</p>

<hr />

<h3>Predefined Strings</h3>

<p>Below are some strings that are used in various attributes.</p>

<hr />

<h4>EffectManager</h4>

<p>Description of "type" in powers/effects.txt</p>

<p><strong>death_sentence</strong> | Causes sudden death at the end of the effect duration.</p>

<p><strong>damage</strong> | Damage per second</p>

<p><strong>damage_percent</strong> | Damage per second (percentage of max HP)</p>

<p><strong>hpot</strong> | HP restored per second</p>

<p><strong>hpot_percent</strong> | HP restored per second (percentage of max HP)</p>

<p><strong>mpot</strong> | MP restored per second</p>

<p><strong>mpot_percent</strong> | MP restored per second (percentage of max MP)</p>

<p><strong>speed</strong> | Changes movement speed. A magnitude of 100 is 100% speed (aka normal speed).</p>

<p><strong>attack_speed</strong> | Changes attack speed. A magnitude of 100 is 100% speed (aka normal speed).</p>

<p><strong>resist_all</strong> | Applies a bonus to all of the non-elemental resistance stats.</p>

<p><strong>stun</strong> | Can't move or attack. Being attacked breaks stun.</p>

<p><strong>revive</strong> | Revives the player. Typically attached to a power that triggers when the player dies.</p>

<p><strong>convert</strong> | Causes an enemy or an ally to switch allegiance</p>

<p><strong>fear</strong> | Causes enemies to run away</p>

<p><strong>knockback</strong> | Pushes the target away from the source caster. Speed is the given value divided by the framerate cap.</p>

<p><strong>${STAT}</strong> | Increases ${STAT}, where ${STAT} is any valid stat_id.</p>

<p><strong>${PRIMARYSTAT}</strong> | Increases ${PRIMARYSTAT}, where ${PRIMARYSTAT} is any of the primary stats defined in engine/primary_stats.txt. Example: physical</p>

<p><strong>shield</strong> | Create a damage absorbing barrier based on Mental damage stat. Duration is ignored.</p>

<p><strong>heal</strong> | Restore HP based on Mental damage stat.</p>

<hr />

<h4>ItemManager</h4>

<p>Description of "bonus" attribute in items/items.txt</p>

<p><strong>speed</strong> | Movement speed. A value of 100 is 100% speed (aka normal speed).</p>

<p><strong>attack_speed</strong> | Attack animation speed. A value of 100 is 100% speed (aka normal speed).</p>

<p><strong>${STAT}</strong> | Increases ${STAT}, where ${STAT} is any valid stat_id.</p>

<p><strong>${PRIMARYSTAT}</strong> | Increases ${PRIMARYSTAT}, where ${PRIMARYSTAT} is any of the primary stats defined in engine/primary_stats.txt. Example: physical</p>

<hr />

<h4>Stats</h4>

<p>Description of the base stats which may be used wherever a stat_id is required.</p>

<p><strong>hp</strong> | Hit points</p>

<p><strong>hp_regen</strong> | HP restored per minute</p>

<p><strong>mp</strong> | Magic points</p>

<p><strong>mp_regen</strong> | MP restored per minute</p>

<p><strong>accuracy</strong> | Accuracy %. Higher values mean less likely to miss.</p>

<p><strong>avoidance</strong> | Avoidance %. Higher values means more likely to not get hit.</p>

<p><strong>absorb_min</strong> | Minimum damage absorption</p>

<p><strong>absorb_max</strong> | Maximum damage absorption</p>

<p><strong>crit</strong> | Critical hit chance %</p>

<p><strong>xp_gain</strong> | Percentage boost to the amount of experience points gained per kill.</p>

<p><strong>currency_find</strong> | Percentage boost to the amount of gold dropped per loot event.</p>

<p><strong>item_find</strong> | Increases the chance of finding items in loot.</p>

<p><strong>stealth</strong> | Decrease the distance required to alert enemies by %</p>

<p><strong>poise</strong> | Reduced % chance of entering "hit" animation when damaged</p>

<p><strong>reflect_chance</strong> | Percentage chance to reflect missiles</p>

<p><strong>return_damage</strong> | Deals a percentage of the damage taken back to the attacker</p>

<p><strong>hp_steal</strong> | Percentage of HP stolen when damaging a target</p>

<p><strong>mp_steal</strong> | Percentage of MP stolen when damaging a target</p>

<p><strong>resist_damage_over_time</strong> | Percentage chance that damage-over-time effects will be negated</p>

<p><strong>resist_slow</strong> | Percentage chance that slow effects will be negated</p>

<p><strong>resist_stun</strong> | Percentage chance that stun effects will be negated</p>

<p><strong>resist_knockback</strong> | Percentage chance that knockback effects will be negated</p>

<p><strong>resist_stat_debuff</strong> | Percentage chance that stat debuff effects will be negated</p>

<p><strong>resist_damage_reflect</strong> | Percentage chance that damage reflection will be negated</p>

<p><strong>resist_hp_steal</strong> | Percentage chance that HP steal will be negated</p>

<p><strong>resist_mp_steal</strong> | Percentage chance that MP steal will be negated</p>

</div>

<div class="footer">
<hr/>
<p>
<a href="http://flarerpg.org/">FLARE Website</a>
</p>
</div>

</body>

</html>