1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>Sirenix.OdinInspector.Attributes</name>
</assembly>
<members>
<member name="T:Sirenix.OdinInspector.AssetListAttribute">
<summary>
<para>AssetLists is used on lists and arrays and single elements of unity types, and replaces the default list drawer with a list of all possible assets with the specified filter.</para>
<para>Use this to both filter and include or exclude assets from a list or an array, without navigating the project window.</para>
</summary>
<remarks>
<para>Asset lists works on all asset types such as materials, scriptable objects, prefabs, custom components, audio, textures etc, and does also show inherited types.</para>
</remarks>
<example>
<para>The following example will display an asset list of all prefabs located in the project window.</para>
<code>
public class AssetListExamples : MonoBehaviour
{
[InfoBox("The AssetList attribute work on both lists of UnityEngine.Object types and UnityEngine.Object types, but have different behaviour.")]
[AssetList]
[InlineEditor(InlineEditorModes.LargePreview)]
public GameObject Prefab;
[AssetList]
public List<PlaceableObject> PlaceableObjects;
[AssetList(Path = "Plugins/Sirenix/")]
[InlineEditor(InlineEditorModes.LargePreview)]
public UnityEngine.Object Object;
[AssetList(AutoPopulate = true)]
public List<PlaceableObject> PlaceableObjectsAutoPopulated;
[AssetList(LayerNames = "MyLayerName")]
public GameObject[] AllPrefabsWithLayerName;
[AssetList(AssetNamePrefix = "Rock")]
public List<GameObject> PrefabsStartingWithRock;
[AssetList(Path = "/Plugins/Sirenix/")]
public List<GameObject> AllPrefabsLocatedInFolder;
[AssetList(Tags = "MyTagA, MyTabB", Path = "/Plugins/Sirenix/")]
public List<GameObject> GameObjectsWithTag;
[AssetList(Path = "/Plugins/Sirenix/")]
public List<Material> AllMaterialsInSirenix;
[AssetList(Path = "/Plugins/Sirenix/")]
public List<ScriptableObject> AllScriptableObjects;
[InfoBox("Use a method as a custom filter for the asset list.")]
[AssetList(CustomFilterMethod = "HasRigidbodyComponent")]
public List<GameObject> MyRigidbodyPrefabs;
private bool HasRigidbodyComponent(GameObject obj)
{
return obj.GetComponent<Rigidbody>() != null;
}
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.AutoPopulate">
<summary>
<para>If <c>true</c>, all assets found and displayed by the asset list, will automatically be added to the list when inspected.</para>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.Tags">
<summary>
<para>Comma separated list of tags to filter the asset list.</para>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.LayerNames">
<summary>
<para>Filter the asset list to only include assets with a specified layer.</para>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.AssetNamePrefix">
<summary>
<para>Filter the asset list to only include assets which name begins with.</para>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.Path">
<summary>
<para>Filter the asset list to only include assets which is located at the specified path.</para>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetListAttribute.CustomFilterMethod">
<summary>
<para>Filter the asset list to only include assets for which the given filter method returns true.</para>
</summary>
</member>
<member name="M:Sirenix.OdinInspector.AssetListAttribute.#ctor">
<summary>
<para>Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.AssetListAttribute"/> class.</para>
</summary>
</member>
<member name="T:Sirenix.OdinInspector.AssetSelectorAttribute">
<summary>
The AssetSelector attribute can be used on all Unity types and will prepend a small button next to the object field that when clicked,
will present the user with a dropdown of assets to select from which can be customized from the attribute.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.IsUniqueList">
<summary>
True by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.DrawDropdownForListElements">
<summary>
True by default. If the ValueDropdown attribute is applied to a list, then disabling this,
will render all child elements normally without using the ValueDropdown. The ValueDropdown will
still show up when you click the add button on the list drawer, unless <see cref="F:Sirenix.OdinInspector.AssetSelectorAttribute.DisableListAddButtonBehaviour"/> is true.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.DisableListAddButtonBehaviour">
<summary>
False by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.ExcludeExistingValuesInList">
<summary>
If the ValueDropdown attribute is applied to a list, and <see cref="F:Sirenix.OdinInspector.AssetSelectorAttribute.IsUniqueList"/> is set to true, then enabling this,
will exclude existing values, instead of rendering a checkbox indicating whether the item is already included or not.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.ExpandAllMenuItems">
<summary>
If the dropdown renders a tree-view, then setting this to true will ensure everything is expanded by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.FlattenTreeView">
<summary>
By default, the dropdown will create a tree view.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.DropdownWidth">
<summary>
Gets or sets the width of the dropdown. Default is zero.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.DropdownHeight">
<summary>
Gets or sets the height of the dropdown. Default is zero.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.DropdownTitle">
<summary>
Gets or sets the title for the dropdown. Null by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.SearchInFolders">
<summary>
Specify which folders to search in. Specifying no folders will make it search in your entire project.
Use the <see cref="P:Sirenix.OdinInspector.AssetSelectorAttribute.Paths"/> property for a more clean way of populating this array through attributes.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AssetSelectorAttribute.Filter">
<summary>
The filters we should use when calling AssetDatabase.FindAssets.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.AssetSelectorAttribute.Paths">
<summary>
<para>
Specify which folders to search in. Specifying no folders will make it search in your entire project.
You can decalir multiple paths using '|' as the seperator.
Example: <code>[AssetList(Paths = "Assets/Textures|Assets/Other/Textures")]</code>
</para>
<para>
This property is simply a more clean way of populating the <see cref="F:Sirenix.OdinInspector.AssetSelectorAttribute.SearchInFolders"/> array.
</para>
</summary>
</member>
<member name="T:Sirenix.OdinInspector.AssetsOnlyAttribute">
<summary>
<para>AssetsOnly is used on object properties, and restricts the property to project assets, and not scene objects.</para>
<para>Use this when you want to ensure an object is from the project, and not from the scene.</para>
</summary>
<example>
<para>The following example shows a component with a game object property, that must be a prefab from the project, and not a scene object.</para>
<code>
public MyComponent : MonoBehaviour
{
[AssetsOnly]
public GameObject MyPrefab;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.SceneObjectsOnlyAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.BoxGroupAttribute">
<summary>
<para>BoxGroup is used on any property and organizes the property in a boxed group.</para>
<para>Use this to cleanly organize relevant values together in the inspector.</para>
</summary>
<example>
<para>The following example shows how BoxGroup is used to organize properties together into a box.</para>
<code>
public class BoxGroupExamples : MonoBehaviour
{
// Box with a centered title.
[BoxGroup("Centered Title", centerLabel: true)]
public int A;
[BoxGroup("Centered Title", centerLabel: true)]
public int B;
[BoxGroup("Centered Title", centerLabel: true)]
public int C;
// Box with a title.
[BoxGroup("Left Oriented Title")]
public int D;
[BoxGroup("Left Oriented Title")]
public int E;
// Box with a title recieved from a field.
[BoxGroup("$DynamicTitle1"), LabelText("Dynamic Title")]
public string DynamicTitle1 = "Dynamic box title";
[BoxGroup("$DynamicTitle1")]
public int F;
// Box with a title recieved from a property.
[BoxGroup("$DynamicTitle2")]
public int G;
[BoxGroup("$DynamicTitle2")]
public int H;
// Box without a title.
[InfoBox("You can also hide the label of a box group.")]
[BoxGroup("NoTitle", false)]
public int I;
[BoxGroup("NoTitle")]
public int J;
[BoxGroup("NoTitle")]
public int K;
#if UNITY_EDITOR
public string DynamicTitle2
{
get { return UnityEditor.PlayerSettings.productName; }
}
#endif
[BoxGroup("Boxed Struct"), HideLabel]
public SomeStruct BoxedStruct;
public SomeStruct DefaultStruct;
[Serializable]
public struct SomeStruct
{
public int One;
public int Two;
public int Three;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.FoldoutGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HorizontalGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.BoxGroupAttribute.ShowLabel">
<summary>
If <c>true</c> a label for the group will be drawn on top.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.BoxGroupAttribute.CenterLabel">
<summary>
If <c>true</c> the header label will be places in the center of the group header. Otherwise it will be in left side.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.BoxGroupAttribute.LabelText">
<summary>
If non-null, this is used instead of the group's name as the title label.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.BoxGroupAttribute.#ctor(System.String,System.Boolean,System.Boolean,System.Single)">
<summary>
Adds the property to the specified box group.
</summary>
<param name="group">The box group.</param>
<param name="showLabel">If <c>true</c> a label will be drawn for the group.</param>
<param name="centerLabel">If set to <c>true</c> the header label will be centered.</param>
<param name="order">The order of the group in the inspector.</param>
</member>
<member name="M:Sirenix.OdinInspector.BoxGroupAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/> class. Use the other constructor overloads in order to show a header-label on the box group.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.BoxGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines the box group with another group.
</summary>
<param name="other">The other group.</param>
</member>
<member name="T:Sirenix.OdinInspector.ButtonAttribute">
<summary>
<para>Buttons are used on functions, and allows for clickable buttons in the inspector.</para>
</summary>
<example>
<para>The following example shows a component that has an initialize method, that can be called from the inspector.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Button]
private void Init()
{
// ...
}
}
</code>
</example>
<example>
<para>The following example show how a Button could be used to test a function.</para>
<code>
public class MyBot : MonoBehaviour
{
[Button]
private void Jump()
{
// ...
}
}
</code>
</example>
<example>
<para>The following example show how a Button can named differently than the function it's been attached to.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Button("Function")]
private void MyFunction()
{
// ...
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.InlineButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.ButtonAttribute.ButtonHeight">
<summary>
Gets the height of the button. If it's zero or below then use default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonAttribute.Name">
<summary>
Use this to override the label on the button.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonAttribute.Style">
<summary>
The style in which to draw the button.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonAttribute.Expanded">
<summary>
If the button contains parameters, you can disable the foldout it creates by setting this to true.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonAttribute.DisplayParameters">
<summary>
<para>Whether to display the button method's parameters (if any) as values in the inspector. True by default.</para>
<para>If this is set to false, the button method will instead be invoked through an ActionResolver or ValueResolver (based on whether it returns a value), giving access to contextual named parameter values like "InspectorProperty property" that can be passed to the button method.</para>
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ButtonAttribute.DrawResult">
<summary>
If the button has a return type, set this to false to not draw the result. Default value is true.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor">
<summary>
Creates a button in the inspector named after the method.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(Sirenix.OdinInspector.ButtonSizes)">
<summary>
Creates a button in the inspector named after the method.
</summary>
<param name="size">The size of the button.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.Int32)">
<summary>
Creates a button in the inspector named after the method.
</summary>
<param name="buttonSize">The size of the button.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String,Sirenix.OdinInspector.ButtonSizes)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
<param name="buttonSize">Size of the button.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String,System.Int32)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
<param name="buttonSize">Size of the button in pixels.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector named after the method.
</summary>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.Int32,Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector named after the method.
</summary>
<param name="buttonSize">The size of the button.</param>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(Sirenix.OdinInspector.ButtonSizes,Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector named after the method.
</summary>
<param name="size">The size of the button.</param>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String,Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String,Sirenix.OdinInspector.ButtonSizes,Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
<param name="buttonSize">Size of the button.</param>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="M:Sirenix.OdinInspector.ButtonAttribute.#ctor(System.String,System.Int32,Sirenix.OdinInspector.ButtonStyle)">
<summary>
Creates a button in the inspector with a custom name.
</summary>
<param name="name">Custom name for the button.</param>
<param name="buttonSize">Size of the button in pixels.</param>
<param name="parameterBtnStyle">Button style for methods with parameters.</param>
</member>
<member name="T:Sirenix.OdinInspector.ButtonGroupAttribute">
<summary>
<para>ButtonGroup is used on any instance function, and adds buttons to the inspector organized into horizontal groups.</para>
<para>Use this to organize multiple button in a tidy horizontal group.</para>
</summary>
<example>
<para>The following example shows how ButtonGroup is used to organize two buttons into one group.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ButtonGroup("MyGroup")]
private void A()
{
// ..
}
[ButtonGroup("MyGroup")]
private void B()
{
// ..
}
}
</code>
</example>
<example>
<para>The following example shows how ButtonGroup can be used to create multiple groups of buttons.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ButtonGroup("First")]
private void A()
{ }
[ButtonGroup("First")]
private void B()
{ }
[ButtonGroup("")]
private void One()
{ }
[ButtonGroup("")]
private void Two()
{ }
[ButtonGroup("")]
private void Three()
{ }
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.InlineButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.FoldoutGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HorizontalGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
</member>
<member name="M:Sirenix.OdinInspector.ButtonGroupAttribute.#ctor(System.String,System.Single)">
<summary>
Organizes the button into the specified button group.
</summary>
<param name="group">The group to organize the button into.</param>
<param name="order">The order of the group in the inspector..</param>
</member>
<member name="T:Sirenix.OdinInspector.ButtonStyle">
<summary>
Button style for methods with parameters.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonStyle.CompactBox">
<summary>
Draws a foldout box around the parameters of the method with the button on the box header itself.
This is the default style of a method with parameters.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonStyle.FoldoutButton">
<summary>
Draws a button with a foldout to expose the parameters of the method.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonStyle.Box">
<summary>
Draws a foldout box around the parameters of the method with the button at the bottom of the box.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ChildGameObjectsOnlyAttribute">
<summary>
The ChildGameObjectsOnly attribute can be used on Components and GameObject fields and will prepend a small button next to the object-field that
will search through all child gameobjects for assignable objects and present them in a dropdown for the user to choose from.
</summary>
<seealso cref="T:System.Attribute" />
</member>
<member name="T:Sirenix.OdinInspector.CustomValueDrawerAttribute">
<summary>
Instead of making a new attribute, and a new drawer, for a one-time thing, you can with this attribute, make a method that acts as a custom property drawer.
These drawers will out of the box have support for undo/redo and multi-selection.
</summary>
<example>
Usage:
<code>
public class CustomDrawerExamples : MonoBehaviour
{
public float From = 2, To = 7;
[CustomValueDrawer("MyStaticCustomDrawerStatic")]
public float CustomDrawerStatic;
[CustomValueDrawer("MyStaticCustomDrawerInstance")]
public float CustomDrawerInstance;
[CustomValueDrawer("MyStaticCustomDrawerArray")]
public float[] CustomDrawerArray;
#if UNITY_EDITOR
private static float MyStaticCustomDrawerStatic(float value, GUIContent label)
{
return EditorGUILayout.Slider(value, 0f, 10f);
}
private float MyStaticCustomDrawerInstance(float value, GUIContent label)
{
return EditorGUILayout.Slider(value, this.From, this.To);
}
private float MyStaticCustomDrawerArray(float value, GUIContent label)
{
return EditorGUILayout.Slider(value, this.From, this.To);
}
#endif
}
</code>
</example>
</member>
<member name="P:Sirenix.OdinInspector.CustomValueDrawerAttribute.MethodName">
<summary>
Name of the custom drawer method. Obsolete; use the Action member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.CustomValueDrawerAttribute.Action">
<summary>
A resolved string that defines the custom drawer action to take, such as an expression or method invocation.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.CustomValueDrawerAttribute.#ctor(System.String)">
<summary>
Instead of making a new attribute, and a new drawer, for a one-time thing, you can with this attribute, make a method that acts as a custom property drawer.
These drawers will out of the box have support for undo/redo and multi-selection.
</summary>
<param name="action">A resolved string that defines the custom drawer action to take, such as an expression or method invocation.</param>
</member>
<member name="T:Sirenix.OdinInspector.DisableInInlineEditorsAttribute">
<summary>
Disables a property if it is drawn within an <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute"/>.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DisableInNonPrefabsAttribute">
<summary>
Disables a property if it is drawn from a non-prefab asset or instance.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DisableInPrefabAssetsAttribute">
<summary>
Disables a property if it is drawn from a prefab asset.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DisableInPrefabInstancesAttribute">
<summary>
Disables a property if it is drawn from a prefab instance.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DisableInPrefabsAttribute">
<summary>
Disables a property if it is drawn from a prefab asset or a prefab instance.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DoNotDrawAsReferenceAttribute">
<summary>
Indicates that the member should not be drawn as a value reference, if it becomes a reference to another value in the tree. Beware, and use with care! This may lead to infinite draw loops!
</summary>
</member>
<member name="T:Sirenix.OdinInspector.EnableGUIAttribute">
<summary>
<para>An attribute that enables GUI.</para>
</summary>
<example>
<code>
public class InlineEditorExamples : MonoBehaviour
{
[EnableGUI]
public string SomeReadonlyProperty { get { return "My GUI is usually disabled." } }
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ReadOnlyAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.EnumPagingAttribute">
<summary>
<para>Draws an enum selector in the inspector with next and previous buttons to let you cycle through the available values for the enum property.</para>
</summary>
<example>
<code>
public enum MyEnum
{
One,
Two,
Three,
}
public class MyMonoBehaviour : MonoBehaviour
{
[EnumPaging]
public MyEnum Value;
}
</code>
</example>
<seealso cref="T:System.Attribute" />
</member>
<member name="T:Sirenix.OdinInspector.FilePathAttribute">
<summary>
<para>FilePath is used on string properties, and provides an interface for file paths.</para>
</summary>
<example>
<para>The following example demonstrates how FilePath is used.</para>
<code>
public class FilePathExamples : MonoBehaviour
{
// By default, FilePath provides a path relative to the Unity project.
[FilePath]
public string UnityProjectPath;
// It is possible to provide custom parent path. Parent paths can be relative to the Unity project, or absolute.
[FilePath(ParentFolder = "Assets/Plugins/Sirenix")]
public string RelativeToParentPath;
// Using parent path, FilePath can also provide a path relative to a resources folder.
[FilePath(ParentFolder = "Assets/Resources")]
public string ResourcePath;
// Provide a comma seperated list of allowed extensions. Dots are optional.
[FilePath(Extensions = "cs")]
public string ScriptFiles;
// By setting AbsolutePath to true, the FilePath will provide an absolute path instead.
[FilePath(AbsolutePath = true)]
[BoxGroup("Conditions")]
public string AbsolutePath;
// FilePath can also be configured to show an error, if the provided path is invalid.
[FilePath(RequireValidPath = true)]
public string ValidPath;
// By default, FilePath will enforce the use of forward slashes. It can also be configured to use backslashes instead.
[FilePath(UseBackslashes = true)]
public string Backslashes;
// FilePath also supports member references with the $ symbol.
[FilePath(ParentFolder = "$DynamicParent", Extensions = "$DynamicExtensions")]
public string DynamicFilePath;
public string DynamicParent = "Assets/Plugin/Sirenix";
public string DynamicExtensions = "cs, unity, jpg";
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.FolderPathAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisplayAsStringAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.AbsolutePath">
<summary>
If <c>true</c> the FilePath will provide an absolute path, instead of a relative one.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.Extensions">
<summary>
Comma separated list of allowed file extensions. Dots are optional.
Supports member referencing with $.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.ParentFolder">
<summary>
ParentFolder provides an override for where the path is relative to. ParentFolder can be relative to the Unity project, or an absolute path.
Supports member referencing with $.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.RequireValidPath">
<summary>
If <c>true</c> an error will be displayed for invalid, or missing paths.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.RequireExistingPath">
<summary>
If <c>true</c> an error will be displayed for non-existing paths.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FilePathAttribute.UseBackslashes">
<summary>
By default FilePath enforces forward slashes. Set UseBackslashes to <c>true</c> if you want backslashes instead.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.FilePathAttribute.ReadOnly">
<summary>
Gets or sets a value indicating whether the path should be read only.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.FolderPathAttribute">
<summary>
<para>FolderPath is used on string properties, and provides an interface for directory paths.</para>
</summary>
<example>
<para>The following example demonstrates how FolderPath is used.</para>
<code>
public class FolderPathExamples : MonoBehaviour
{
// By default, FolderPath provides a path relative to the Unity project.
[FolderPath]
public string UnityProjectPath;
// It is possible to provide custom parent patn. ParentFolder paths can be relative to the Unity project, or absolute.
[FolderPath(ParentFolder = "Assets/Plugins/Sirenix")]
public string RelativeToParentPath;
// Using ParentFolder, FolderPath can also provide a path relative to a resources folder.
[FolderPath(ParentFolder = "Assets/Resources")]
public string ResourcePath;
// By setting AbsolutePath to true, the FolderPath will provide an absolute path instead.
[FolderPath(AbsolutePath = true)]
public string AbsolutePath;
// FolderPath can also be configured to show an error, if the provided path is invalid.
[FolderPath(RequireValidPath = true)]
public string ValidPath;
// By default, FolderPath will enforce the use of forward slashes. It can also be configured to use backslashes instead.
[FolderPath(UseBackslashes = true)]
public string Backslashes;
// FolderPath also supports member references with the $ symbol.
[FolderPath(ParentFolder = "$DynamicParent")]
public string DynamicFolderPath;
public string DynamicParent = "Assets/Plugins/Sirenix";
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.FilePathAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisplayAsStringAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.FolderPathAttribute.AbsolutePath">
<summary>
If <c>true</c> the FolderPath will provide an absolute path, instead of a relative one.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FolderPathAttribute.ParentFolder">
<summary>
ParentFolder provides an override for where the path is relative to. ParentFolder can be relative to the Unity project, or an absolute path.
Supports member referencing with $.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FolderPathAttribute.RequireValidPath">
<summary>
If <c>true</c> an error will be displayed for invalid, or missing paths.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FolderPathAttribute.RequireExistingPath">
<summary>
If <c>true</c> an error will be displayed for non-existing paths.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.FolderPathAttribute.UseBackslashes">
<summary>
By default FolderPath enforces forward slashes. Set UseBackslashes to <c>true</c> if you want backslashes instead.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideDuplicateReferenceBoxAttribute">
<summary>
Indicates that Odin should hide the reference box, if this property would otherwise be drawn as a reference to another property, due to duplicate reference values being encountered.
Note that if the value is referencing itself recursively, then the reference box will be drawn regardless of this attribute in all recursive draw calls.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideIfGroupAttribute">
<summary>
<p>HideIfGroup allows for showing or hiding a group of properties based on a condition.</p>
<p>The attribute is a group attribute and can therefore be combined with other group attributes, and even be used to show or hide entire groups.</p>
<p>Note that in the vast majority of cases where you simply want to be able to control the visibility of a single group, it is better to use the VisibleIf parameter that *all* group attributes have.</p>
</summary>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
<seealso cref="T:UnityEngine.HideInInspector"/>
</member>
<member name="P:Sirenix.OdinInspector.HideIfGroupAttribute.Animate">
<summary>
Whether or not to visually animate group visibility changes.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HideIfGroupAttribute.Value">
<summary>
The optional member value.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.HideIfGroupAttribute.MemberName">
<summary>
Name of member to use when to hide the group. Defaults to the name of the group, by can be overriden by setting this property.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.HideIfGroupAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.HideIfGroupAttribute.#ctor(System.String,System.Boolean)">
<summary>
Makes a group that can be shown or hidden based on a condition.
</summary>
<param name="path">The group path.</param>
<param name="animate">If <c>true</c> then a fade animation will be played when the group is hidden or shown.</param>
</member>
<member name="M:Sirenix.OdinInspector.HideIfGroupAttribute.#ctor(System.String,System.Object,System.Boolean)">
<summary>
Makes a group that can be shown or hidden based on a condition.
</summary>
<param name="path">The group path.</param>
<param name="value">The value the member should equal for the property to shown.</param>
<param name="animate">If <c>true</c> then a fade animation will be played when the group is hidden or shown.</param>
</member>
<member name="M:Sirenix.OdinInspector.HideIfGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines HideIfGroup attributes.
</summary>
<param name="other">Another ShowIfGroup attribute.</param>
</member>
<member name="T:Sirenix.OdinInspector.HideInInlineEditorsAttribute">
<summary>
Hides a property if it is drawn within an <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute"/>.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideInNonPrefabsAttribute">
<summary>
Hides a property if it is drawn from a non prefab instance or asset.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideInPrefabAssetsAttribute">
<summary>
Hides a property if it is drawn from a prefab asset.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideInPrefabInstancesAttribute">
<summary>
Hides a property if it is drawn from a prefab instance.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideInPrefabsAttribute">
<summary>
Hides a property if it is drawn from a prefab instance or a prefab asset.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideInTablesAttribute">
<summary>
The HideInTables attribute is used to prevent members from showing up as columns in tables drawn using the <see cref="T:Sirenix.OdinInspector.TableListAttribute"/>.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.HideNetworkBehaviourFieldsAttribute">
<summary>
Apply HideNetworkBehaviourFields to your class to prevent the special "Network Channel" and "Network Send Interval" properties from being shown in the inspector for a NetworkBehaviour.
This attribute has no effect on classes that are not derived from NetworkBehaviour.
</summary>
<example>
<para>The following example shows how to use this attribute.</para>
<code>
[HideNetworkBehaviourFields]
public class MyComponent : NetworkBehaviour
{
// The "Network Channel" and "Network Send Interval" properties will not be shown for this component in the inspector
}
</code>
</example>
<seealso cref="T:System.Attribute" />
</member>
<member name="T:Sirenix.OdinInspector.InlinePropertyAttribute">
<summary>
The Inline Property is used to place the contents of a type next to the label, instead of being rendered in a foldout.
</summary>
<example>
<code>
public class InlinePropertyExamples : MonoBehaviour
{
public Vector3 Vector3;
public Vector3Int Vector3Int;
[InlineProperty(LabelWidth = 12)] // It can be placed on classes as well as members
public Vector2Int Vector2Int;
}
[Serializable]
[InlineProperty(LabelWidth = 12)] // It can be placed on classes as well as members
public struct Vector3Int
{
[HorizontalGroup]
public int X;
[HorizontalGroup]
public int Y;
[HorizontalGroup]
public int Z;
}
[Serializable]
public struct Vector2Int
{
[HorizontalGroup]
public int X;
[HorizontalGroup]
public int Y;
}
</code>
</example>
<seealso cref="T:System.Attribute" />
</member>
<member name="F:Sirenix.OdinInspector.InlinePropertyAttribute.LabelWidth">
<summary>
Specify a label width for all child properties.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.LabelWidthAttribute">
<summary>
<para>LabelWidth is used to change the width of labels for properties.</para>
</summary>
<example>
<para>The following example shows how LabelText is applied to a few property fields.</para>
<code>
public MyComponent : MonoBehaviour
{
[LabelWidth("3")]
public int MyInt3;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.TitleAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.LabelWidthAttribute.Width">
<summary>
The new text of the label.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.LabelWidthAttribute.#ctor(System.Single)">
<summary>
Give a property a custom label.
</summary>
<param name="width">The width of the label.</param>
</member>
<member name="T:Sirenix.OdinInspector.OnCollectionChangedAttribute">
<summary>
<para>
OnCollectionChanged can be put on collections, and provides an event callback when the collection is about to be changed through the inspector,
and when the collection has been changed through the inspector. Additionally, it provides a CollectionChangeInfo struct containing information
about the exact changes made to the collection. This attribute works for all collections with a collection resolver, amongst them arrays, lists,
dictionaries, hashsets, stacks and linked lists.
</para>
</summary>
<remarks>
<note type="note">Note that this attribute only works in the editor! Collections changed by script will not trigger change events!</note>
</remarks>
<example>
<para>The following example shows how OnCollectionChanged can be used to get callbacks when a collection is being changed.</para>
<code>
[OnCollectionChanged("Before", "After")]
public List<string> list;
public void Before(CollectionChangeInfo info)
{
if (info.ChangeType == CollectionChangeType.Add || info.ChangeType == CollectionChangeType.Insert)
{
Debug.Log("Adding to the list!");
}
else if (info.ChangeType == CollectionChangeType.RemoveIndex || info.ChangeType == CollectionChangeType.RemoveValue)
{
Debug.Log("Removing from the list!");
}
}
public void After(CollectionChangeInfo info)
{
if (info.ChangeType == CollectionChangeType.Add || info.ChangeType == CollectionChangeType.Insert)
{
Debug.Log("Finished adding to the list!");
}
else if (info.ChangeType == CollectionChangeType.RemoveIndex || info.ChangeType == CollectionChangeType.RemoveValue)
{
Debug.Log("Finished removing from the list!");
}
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.OnInspectorDisposeAttribute">
<summary>
<para>The OnInspectorDispose attribute takes in an action string as an argument (typically the name of a method to be invoked, or an expression to be executed), and executes that action when the property's drawers are disposed in the inspector.</para>
<para>Disposing will happen at least once, when the inspector changes selection or the property tree is collected by the garbage collector, but may also happen several times before that, most often when the type of a polymorphic property changes and it refreshes its drawer setup and recreates all its children, disposing of the old setup and children.</para>
</summary>
<example>
<para>The following example demonstrates how OnInspectorDispose works.</para>
<code>
public class MyComponent : MonoBehaviour
{
[OnInspectorDispose(@"@UnityEngine.Debug.Log(""Dispose event invoked!"")")]
[ShowInInspector, InfoBox("When you change the type of this field, or set it to null, the former property setup is disposed. The property setup will also be disposed when you deselect this example."), DisplayAsString]
public BaseClass PolymorphicField;
public abstract class BaseClass { public override string ToString() { return this.GetType().Name; } }
public class A : BaseClass { }
public class B : BaseClass { }
public class C : BaseClass { }
}
</code>
</example>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorDisposeAttribute.#ctor">
<summary>
This constructor should be used when the attribute is placed directly on a method.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorDisposeAttribute.#ctor(System.String)">
<summary>
This constructor should be used when the attribute is placed on a non-method member.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.OnInspectorInitAttribute">
<summary>
<para>The OnInspectorInit attribute takes in an action string as an argument (typically the name of a method to be invoked, or an expression to be executed), and executes that action when the property's drawers are initialized in the inspector.</para>
<para>Initialization will happen at least once during the first drawn frame of any given property, but may also happen several times later, most often when the type of a polymorphic property changes and it refreshes its drawer setup and recreates all its children.</para>
</summary>
<example>
<para>The following example demonstrates how OnInspectorInit works.</para>
<code>
public class MyComponent : MonoBehaviour
{
// Display current time for reference.
[ShowInInspector, DisplayAsString, PropertyOrder(-1)]
public string CurrentTime { get { GUIHelper.RequestRepaint(); return DateTime.Now.ToString(); } }
// OnInspectorInit executes the first time this string is about to be drawn in the inspector.
// It will execute again when the example is reselected.
[OnInspectorInit("@TimeWhenExampleWasOpened = DateTime.Now.ToString()")]
public string TimeWhenExampleWasOpened;
// OnInspectorInit will not execute before the property is actually "resolved" in the inspector.
// Remember, Odin's property system is lazily evaluated, and so a property does not actually exist
// and is not initialized before something is actually asking for it.
//
// Therefore, this OnInspectorInit attribute won't execute until the foldout is expanded.
[FoldoutGroup("Delayed Initialization", Expanded = false, HideWhenChildrenAreInvisible = false)]
[OnInspectorInit("@TimeFoldoutWasOpened = DateTime.Now.ToString()")]
public string TimeFoldoutWasOpened;
}
</code>
</example>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorInitAttribute.#ctor">
<summary>
This constructor should be used when the attribute is placed directly on a method.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorInitAttribute.#ctor(System.String)">
<summary>
This constructor should be used when the attribute is placed on a non-method member.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.OnStateUpdateAttribute">
<summary>
<para>
OnStateUpdate provides an event callback when the property's state should be updated, when the StateUpdaters run on the property instance.
This generally happens at least once per frame, and the callback will be invoked even when the property is not visible. This can be used to
approximate custom StateUpdaters like [ShowIf] without needing to make entire attributes and StateUpdaters for one-off cases.
</para>
</summary>
<example>
<para>The following example shows how OnStateUpdate can be used to control the visible state of a property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[OnStateUpdate("@$property.State.Visible = ToggleMyInt")]
public int MyInt;
public bool ToggleMyInt;
}
</code>
</example>
<example>
<para>The following example shows how OnStateUpdate can be used to control the expanded state of a list.</para>
<code>
public class MyComponent : MonoBehaviour
{
[OnStateUpdate("@$property.State.Expanded = ExpandList")]
public List<string> list;
public bool ExpandList;
}
</code>
<para>The following example shows how OnStateUpdate can be used to control the state of another property.</para>
<code>
public class MyComponent : MonoBehaviour
{
public List>string< list;
[OnStateUpdate("@#(list).State.Expanded = $value")]
public bool ExpandList;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.PreviewFieldAttribute">
<summary>
<para>
Draws a square ObjectField which renders a preview for UnityEngine.Object types.
This object field also adds support for drag and drop, dragging an object to another square object field, swaps the values.
If you hold down control while letting go it will replace the value, And you can control + click the object field to quickly delete the value it holds.
</para>
<para>
These object fields can also be selectively enabled and customized globally from the Odin preferences window.
</para>
</summary>
<example>
<para>The following example shows how PreviewField is applied to a few property fields.</para>
<code>
public MyComponent : MonoBehaviour
{
[PreviewField]
public UnityEngine.Object SomeObject;
[PreviewField]
public Texture SomeTexture;
[HorizontalGroup, HideLabel, PreviewField(30)]
public Material A, B, C, D, F;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.TitleAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.PreviewFieldAttribute.Height">
<summary>
The height of the object field
</summary>
</member>
<member name="P:Sirenix.OdinInspector.PreviewFieldAttribute.Alignment">
<summary>
Left aligned.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.PreviewFieldAttribute.AlignmentHasValue">
<summary>
Whether an alignment value is specified.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PreviewFieldAttribute.#ctor">
<summary>
Draws a square object field which renders a preview for UnityEngine.Object type objects.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PreviewFieldAttribute.#ctor(System.Single)">
<summary>
Draws a square object field which renders a preview for UnityEngine.Object type objects.
</summary>
<param name="height">The height of the preview field.</param>
</member>
<member name="M:Sirenix.OdinInspector.PreviewFieldAttribute.#ctor(System.Single,Sirenix.OdinInspector.ObjectFieldAlignment)">
<summary>
Draws a square object field which renders a preview for UnityEngine.Object type objects.
</summary>
<param name="height">The height of the preview field.</param>
<param name="alignment">The alignment of the preview field.</param>
</member>
<member name="M:Sirenix.OdinInspector.PreviewFieldAttribute.#ctor(Sirenix.OdinInspector.ObjectFieldAlignment)">
<summary>
Draws a square object field which renders a preview for UnityEngine.Object type objects.
</summary>
<param name="alignment">The alignment of the preview field.</param>
</member>
<member name="T:Sirenix.OdinInspector.ProgressBarAttribute">
<summary>
<para>Draws a horizontal progress bar based on the value of the property.</para>
<para>Use it for displaying a meter to indicate how full an inventory is, or to make a visual indication of a health bar.</para>
</summary>
<example>
<para>The following example shows how ProgressBar can be used.</para>
<code>
public class ProgressBarExample : MonoBehaviour
{
// Default progress bar.
[ProgressBar(0, 100)]
public int ProgressBar;
// Health bar.
[ProgressBar(0, 100, ColorMember = "GetHealthBarColor")]
public float HealthBar = 50;
private Color GetHealthBarColor(float value)
{
// Blends between red, and yellow color for when the health is below 30,
// and blends between yellow and green color for when the health is above 30.
return Color.Lerp(Color.Lerp(
Color.red, Color.yellow, MathUtilities.LinearStep(0f, 30f, value)),
Color.green, MathUtilities.LinearStep(0f, 100f, value));
}
// Stacked health bar.
// The ProgressBar attribute is placed on property, without a set method, so it can't be edited directly.
// So instead we have this Range attribute on a float to change the value.
[Range(0, 300)]
public float StackedHealth;
[ProgressBar(0, 100, ColorMember = "GetStackedHealthColor", BackgroundColorMember = "GetStackHealthBackgroundColor")]
private float StackedHealthProgressBar
{
// Loops the stacked health value between 0, and 100.
get { return this.StackedHealth - 100 * (int)((this.StackedHealth - 1) / 100); }
}
private Color GetStackedHealthColor()
{
return
this.StackedHealth > 200 ? Color.cyan :
this.StackedHealth > 100 ? Color.green :
Color.red;
}
private Color GetStackHealthBackgroundColor()
{
return
this.StackedHealth > 200 ? Color.green :
this.StackedHealth > 100 ? Color.red :
new Color(0.16f, 0.16f, 0.16f, 1f);
}
// Custom color and height.
[ProgressBar(-100, 100, r: 1, g: 1, b: 1, Height = 30)]
public short BigProgressBar = 50;
// You can also reference members by name to dynamically assign the min and max progress bar values.
[ProgressBar("DynamicMin", "DynamicMax")]
public float DynamicProgressBar;
public float DynamicMin, DynamicMax;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.HideLabelAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyRangeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.MinMaxSliderAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.Min">
<summary>
The minimum value.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.Max">
<summary>
The maximum value.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.MinMember">
<summary>
The name of a field, property or method to get the min values from. Obsolete; use the MinGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.MinGetter">
<summary>
A resolved string that should evaluate to a float value, and will be used as the min bounds.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.MaxMember">
<summary>
The name of a field, property or method to get the max values from. Obsolete; use the MaxGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.MaxGetter">
<summary>
A resolved string that should evaluate to a float value, and will be used as the max bounds.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.R">
<summary>
The red channel of the color of the progress bar.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.G">
<summary>
The green channel of the color of the progress bar.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.B">
<summary>
The blue channel of the color of the progress bar.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.Height">
<summary>
The height of the progress bar in pixels. Defaults to 12 pixels.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.ColorMember">
<summary>
Optional reference to a Color field, property or method, to dynamically change the color of the progress bar. Obsolete; use the ColorGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.ColorGetter">
<summary>
Optional resolved string that should evaluate to a Color value, to dynamically change the color of the progress bar.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.BackgroundColorMember">
<summary>
Optional reference to a Color field, property or method, to dynamically change the background color of the progress bar.
Default background color is (0.16, 0.16, 0.16, 1).
Obsolete; use the BackgroundColorGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.BackgroundColorGetter">
<summary>
Optional resolved string that should evaluate to a Color value, to dynamically change the background color of the progress bar.
Default background color is (0.16, 0.16, 0.16, 1).
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.Segmented">
<summary>
If <c>true</c> then the progress bar will be drawn in tiles.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.CustomValueStringMember">
<summary>
References a member by name to get a custom value label string from. Obsolete; use the CustomValueStringGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ProgressBarAttribute.CustomValueStringGetter">
<summary>
A resolved string to get a custom value label string from.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ProgressBarAttribute.#ctor(System.Double,System.Double,System.Single,System.Single,System.Single)">
<summary>
Draws a progress bar for the value.
</summary>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
<param name="r">The red channel of the color of the progress bar.</param>
<param name="g">The green channel of the color of the progress bar.</param>
<param name="b">The blue channel of the color of the progress bar.</param>
</member>
<member name="M:Sirenix.OdinInspector.ProgressBarAttribute.#ctor(System.String,System.Double,System.Single,System.Single,System.Single)">
<summary>
Draws a progress bar for the value.
</summary>
<param name="minGetter">A resolved string that should evaluate to a float value, and will be used as the min bounds.</param>
<param name="max">The maximum value.</param>
<param name="r">The red channel of the color of the progress bar.</param>
<param name="g">The green channel of the color of the progress bar.</param>
<param name="b">The blue channel of the color of the progress bar.</param>
</member>
<member name="M:Sirenix.OdinInspector.ProgressBarAttribute.#ctor(System.Double,System.String,System.Single,System.Single,System.Single)">
<summary>
Draws a progress bar for the value.
</summary>
<param name="min">The minimum value.</param>
<param name="maxGetter">A resolved string that should evaluate to a float value, and will be used as the max bounds.</param>
<param name="r">The red channel of the color of the progress bar.</param>
<param name="g">The green channel of the color of the progress bar.</param>
<param name="b">The blue channel of the color of the progress bar.</param>
</member>
<member name="M:Sirenix.OdinInspector.ProgressBarAttribute.#ctor(System.String,System.String,System.Single,System.Single,System.Single)">
<summary>
Draws a progress bar for the value.
</summary>
<param name="minGetter">A resolved string that should evaluate to a float value, and will be used as the min bounds.</param>
<param name="maxGetter">A resolved string that should evaluate to a float value, and will be used as the max bounds.</param>
<param name="r">The red channel of the color of the progress bar.</param>
<param name="g">The green channel of the color of the progress bar.</param>
<param name="b">The blue channel of the color of the progress bar.</param>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.DrawValueLabel">
<summary>
If <c>true</c> then there will be drawn a value label on top of the progress bar.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.DrawValueLabelHasValue">
<summary>
Gets a value indicating if the user has set a custom DrawValueLabel value.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.ValueLabelAlignment">
<summary>
The alignment of the value label on top of the progress bar. Defaults to center.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ProgressBarAttribute.ValueLabelAlignmentHasValue">
<summary>
Gets a value indicating if the user has set a custom ValueLabelAlignment value.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.PropertyRangeAttribute">
<summary>
<para>PropertyRange attribute creates a slider control to set the value of a property to between the specified range.</para>
<para>This is equivalent to Unity's Range attribute, but this attribute can be applied to both fields and property.</para>
</summary>
<example>The following example demonstrates how PropertyRange is used.</example>
<code>
public class MyComponent : MonoBehaviour
{
[PropertyRange(0, 100)]
public int MyInt;
[PropertyRange(-100, 100)]
public float MyFloat;
[PropertyRange(-100, -50)]
public decimal MyDouble;
// This attribute also supports dynamically referencing members by name to assign the min and max values for the range field.
[PropertyRange("DynamicMin", "DynamicMax"]
public float MyDynamicValue;
public float DynamicMin, DynamicMax;
}
</code>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertySpaceAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyTooltipAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyOrderAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.PropertyRangeAttribute.Min">
<summary>
The minimum value.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyRangeAttribute.Max">
<summary>
The maximum value.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.PropertyRangeAttribute.MinMember">
<summary>
The name of a field, property or method to get the min value from. Obsolete; use the MinGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyRangeAttribute.MinGetter">
<summary>
A resolved string that should evaluate to a float value, and will be used as the min bounds.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.PropertyRangeAttribute.MaxMember">
<summary>
The name of a field, property or method to get the max value from. Obsolete; use the MaxGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyRangeAttribute.MaxGetter">
<summary>
A resolved string that should evaluate to a float value, and will be used as the max bounds.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertyRangeAttribute.#ctor(System.Double,System.Double)">
<summary>
Creates a slider control to set the value of the property to between the specified range..
</summary>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
</member>
<member name="M:Sirenix.OdinInspector.PropertyRangeAttribute.#ctor(System.String,System.Double)">
<summary>
Creates a slider control to set the value of the property to between the specified range..
</summary>
<param name="minGetter">A resolved string that should evaluate to a float value, and will be used as the min bounds.</param>
<param name="max">The maximum value.</param>
</member>
<member name="M:Sirenix.OdinInspector.PropertyRangeAttribute.#ctor(System.Double,System.String)">
<summary>
Creates a slider control to set the value of the property to between the specified range..
</summary>
<param name="min">The minimum value.</param>
<param name="maxGetter">A resolved string that should evaluate to a float value, and will be used as the max bounds.</param>
</member>
<member name="M:Sirenix.OdinInspector.PropertyRangeAttribute.#ctor(System.String,System.String)">
<summary>
Creates a slider control to set the value of the property to between the specified range..
</summary>
<param name="minGetter">A resolved string that should evaluate to a float value, and will be used as the min bounds.</param>
<param name="maxGetter">A resolved string that should evaluate to a float value, and will be used as the max bounds.</param>
</member>
<member name="T:Sirenix.OdinInspector.PropertySpaceAttribute">
<summary>
<para>The PropertySpace attribute have the same function as Unity's existing Space attribute, but can be applied anywhere as opposed to just fields.</para>
</summary>
<example>
<para>The following example demonstrates the usage of the PropertySpace attribute.</para>
<code>
[PropertySpace] // Defaults to a space of 8 pixels just like Unity's Space attribute.
public int MyField;
[ShowInInspector, PropertySpace(16)]
public int MyProperty { get; set; }
[ShowInInspector, PropertySpace(16, 16)]
public int MyProperty { get; set; }
[Button, PropertySpace(32)]
public void MyMethod()
{
...
}
[PropertySpace(-8)] // A negative space can also be remove existing space between properties.
public int MovedUp;
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyRangeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyTooltipAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyOrderAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.PropertySpaceAttribute.SpaceBefore">
<summary>
The space between properties in pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertySpaceAttribute.SpaceAfter">
<summary>
The space between properties in pixels.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertySpaceAttribute.#ctor">
<summary>
Adds a space of 8 pixels between properties.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertySpaceAttribute.#ctor(System.Single)">
<summary>
Adds a space between properties.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertySpaceAttribute.#ctor(System.Single,System.Single)">
<summary>
Adds a space between properties.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ResponsiveButtonGroupAttribute">
<summary>
Groups buttons into a group that will position and resize the buttons based on the amount of available layout space.
</summary>
<example>
<code>
[ResponsiveButtonGroup]
public void Foo() { }
[ResponsiveButtonGroup]
public void Bar() { }
[ResponsiveButtonGroup]
public void Baz() { }
</code>
</example>
<example>
<code>
[ResponsiveButtonGroup(UniformLayout = true)]
public void Foo() { }
[ResponsiveButtonGroup]
public void Bar() { }
[ResponsiveButtonGroup]
public void Baz() { }
</code>
</example>
<example>
<code>
[ResponsiveButtonGroupAttribute(UniformLayout = true, DefaultButtonSize = ButtonSizes.Large)]
public void Foo() { }
[GUIColor(0, 1, 0))]
[Button(ButtonSizes.Large)]
[ResponsiveButtonGroup]
public void Bar() { }
[ResponsiveButtonGroup]
public void Baz() { }
</code>
</example>
<example>
<code>
[TabGroup("SomeTabGroup", "SomeTab")]
[ResponsiveButtonGroup("SomeTabGroup/SomeTab/SomeBtnGroup")]
public void Foo() { }
[ResponsiveButtonGroup("SomeTabGroup/SomeTab/SomeBtnGroup")]
public void Bar() { }
[ResponsiveButtonGroup("SomeTabGroup/SomeTab/SomeBtnGroup")]
public void Baz() { }
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.ResponsiveButtonGroupAttribute.DefaultButtonSize">
<summary>
The default size of the button.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ResponsiveButtonGroupAttribute.UniformLayout">
<summary>
If <c>true</c> then the widths of a line of buttons will be the same.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ResponsiveButtonGroupAttribute.#ctor(System.String)">
<summary>
Draws a button that will be placed in a group that will respond to the horizontal space available to the group.
</summary>
<param name="group">The name of the group to place the button in.</param>
</member>
<member name="M:Sirenix.OdinInspector.ResponsiveButtonGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Merges the values of this group with another ResponsiveButtonGroupAttribute.
</summary>
<param name="other">The attribute to combine with.</param>
</member>
<member name="T:Sirenix.OdinInspector.ShowIfGroupAttribute">
<summary>
<p>ShowIfGroup allows for showing or hiding a group of properties based on a condition.</p>
<p>The attribute is a group attribute and can therefore be combined with other group attributes, and even be used to show or hide entire groups.</p>
<p>Note that in the vast majority of cases where you simply want to be able to control the visibility of a single group, it is better to use the VisibleIf parameter that *all* group attributes have.</p>
</summary>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
<seealso cref="T:UnityEngine.HideInInspector"/>
</member>
<member name="P:Sirenix.OdinInspector.ShowIfGroupAttribute.Animate">
<summary>
Whether or not to visually animate group visibility changes. Alias for AnimateVisibility.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ShowIfGroupAttribute.Value">
<summary>
The optional member value.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ShowIfGroupAttribute.MemberName">
<summary>
Name of member to use when to hide the group. Defaults to the name of the group, by can be overriden by setting this property.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ShowIfGroupAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ShowIfGroupAttribute.#ctor(System.String,System.Boolean)">
<summary>
Makes a group that can be shown or hidden based on a condition.
</summary>
<param name="path">The group path.</param>
<param name="animate">If <c>true</c> then a fade animation will be played when the group is hidden or shown.</param>
</member>
<member name="M:Sirenix.OdinInspector.ShowIfGroupAttribute.#ctor(System.String,System.Object,System.Boolean)">
<summary>
Makes a group that can be shown or hidden based on a condition.
</summary>
<param name="path">The group path.</param>
<param name="value">The value the member should equal for the property to shown.</param>
<param name="animate">If <c>true</c> then a fade animation will be played when the group is hidden or shown.</param>
</member>
<member name="M:Sirenix.OdinInspector.ShowIfGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines ShowIfGroup attributes.
</summary>
<param name="other">Another ShowIfGroup attribute.</param>
</member>
<member name="T:Sirenix.OdinInspector.ShowInInlineEditorsAttribute">
<summary>
Only shows a property if it is drawn within an <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute"/>.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ShowPropertyResolverAttribute">
<summary>
<para>
ShowPropertyResolver shows the property resolver responsible for bringing the member into the property tree.
This is useful in situations where you want to debug why a particular member that is normally not shown in the inspector suddenly is.
</para>
</summary>
<example>
<code>
public class MyComponent : MonoBehaviour
{
[ShowPropertyResolver]
public int IndentedInt;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.SuffixLabelAttribute">
<summary>
<para>The SuffixLabel attribute draws a label at the end of a property.</para>
<para>Use this for conveying intend about a property. Is the distance measured in meters, kilometers, or in light years?.
Is the angle measured in degrees or radians?
Using SuffixLabel, you can place a neat label at the end of a property, to clearly show how the the property is used.</para>
</summary>
<example>
<para>The following example demonstrates how SuffixLabel is used.</para>
<code>
public class MyComponent : MonoBehaviour
{
// The SuffixLabel attribute draws a label at the end of a property.
// It's useful for conveying intend about a property.
// Fx, this field is supposed to have a prefab assigned.
[SuffixLabel("Prefab")]
public GameObject GameObject;
// Using the Overlay property, the suffix label will be drawn on top of the property instead of behind it.
// Use this for a neat inline look.
[SuffixLabel("ms", Overlay = true)]
public float Speed;
[SuffixLabel("radians", Overlay = true)]
public float Angle;
// The SuffixLabel attribute also supports string member references by using $.
[SuffixLabel("$Suffix", Overlay = true)]
public string Suffix = "Dynamic suffix label";
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.LabelTextAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideLabelAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.InlineButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.LabelWidthAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.SuffixLabelAttribute.Label">
<summary>
The label displayed at the end of the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.SuffixLabelAttribute.Overlay">
<summary>
If <c>true</c> the suffix label will be drawn on top of the property, instead of after.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.SuffixLabelAttribute.#ctor(System.String,System.Boolean)">
<summary>
Draws a label at the end of the property.
</summary>
<param name="label">The text of the label.</param>
<param name="overlay">If <c>true</c> the suffix label will be drawn on top of the property, instead of after.</param>
</member>
<member name="T:Sirenix.OdinInspector.TableColumnWidthAttribute">
<summary>
The TableColumnWidth attribute is used to further customize the width of a column in tables drawn using the <see cref="T:Sirenix.OdinInspector.TableListAttribute"/>.
</summary>
<example>
<code>
[TableList]
public List<SomeType> TableList = new List<SomeType>();
[Serializable]
public class SomeType
{
[LabelWidth(30)]
[TableColumnWidth(130, false)]
[VerticalGroup("Combined")]
public string A;
[LabelWidth(30)]
[VerticalGroup("Combined")]
public string B;
[Multiline(2), Space(3)]
public string fields;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.TableListAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TableColumnWidthAttribute.Width">
<summary>
The width of the column.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableColumnWidthAttribute.Resizable">
<summary>
Whether the column should be resizable. True by default.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TableColumnWidthAttribute.#ctor(System.Int32,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.TableColumnWidthAttribute"/> class.
</summary>
<param name="width">The width of the column in pixels.</param>
<param name="resizable">If <c>true</c> then the column can be resized in the inspector.</param>
</member>
<member name="T:Sirenix.OdinInspector.TableListAttribute">
<summary>
Renders lists and arrays in the inspector as tables.
</summary>
<seealso cref="T:Sirenix.OdinInspector.TableColumnWidthAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TableColumnWidthAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.NumberOfItemsPerPage">
<summary>
If ShowPaging is enabled, this will override the default setting specified in the Odin Preferences window.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.IsReadOnly">
<summary>
Mark the table as read-only. This removes all editing capabilities from the list such as Add and delete,
but without disabling GUI for each element drawn as otherwise would be the case if the <see cref="T:Sirenix.OdinInspector.ReadOnlyAttribute"/> was used.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.DefaultMinColumnWidth">
<summary>
The default minimum column width - 40 by default. This can be overwriten by individual columns using the <see cref="T:Sirenix.OdinInspector.TableColumnWidthAttribute"/>.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.ShowIndexLabels">
<summary>
If true, a label is drawn for each element which shows the index of the element.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.DrawScrollView">
<summary>
Whether to draw all rows in a scroll-view.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.MinScrollViewHeight">
<summary>
The number of pixels before a scroll view appears. 350 by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.MaxScrollViewHeight">
<summary>
The number of pixels before a scroll view appears. 0 by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.AlwaysExpanded">
<summary>
If true, expanding and collapsing the table from the table title-bar is no longer an option.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.HideToolbar">
<summary>
Whether to hide the toolbar containing the add button and pagin etc.s
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableListAttribute.CellPadding">
<summary>
The cell padding.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.TableListAttribute.ShowPaging">
<summary>
Whether paging buttons should be added to the title bar. The default value of this, can be customized from the Odin Preferences window.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.TableListAttribute.ShowPagingHasValue">
<summary>
Whether the ShowPaging property has been set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.TableListAttribute.ScrollViewHeight">
<summary>
Sets the Min and Max ScrollViewHeight.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.TableMatrixAttribute">
<summary>
The TableMatrix attribute is used to further specify how Odin should draw two-dimensional arrays.
</summary>
<example>
<code>
// Inheriting from SerializedMonoBehaviour is only needed if you want Odin to serialize the multi-dimensional arrays for you.
// If you prefer doing that yourself, you can still make Odin show them in the inspector using the ShowInInspector attribute.
public class TableMatrixExamples : SerializedMonoBehaviour
{
[InfoBox("Right-click and drag column and row labels in order to modify the tables."), PropertyOrder(-10), OnInspectorGUI]
private void ShowMessageAtOP() { }
[BoxGroup("Two Dimensional array without the TableMatrix attribute.")]
public bool[,] BooleanTable = new bool[15, 6];
[BoxGroup("ReadOnly table")]
[TableMatrix(IsReadOnly = true)]
public int[,] ReadOnlyTable = new int[5, 5];
[BoxGroup("Labled table")]
[TableMatrix(HorizontalTitle = "X axis", VerticalTitle = "Y axis")]
public GameObject[,] LabledTable = new GameObject[15, 10];
[BoxGroup("Enum table")]
[TableMatrix(HorizontalTitle = "X axis")]
public InfoMessageType[,] EnumTable = new InfoMessageType[4,4];
[BoxGroup("Custom table")]
[TableMatrix(DrawElementMethod = "DrawColoredEnumElement", ResizableColumns = false)]
public bool[,] CustomCellDrawing = new bool[30,30];
#if UNITY_EDITOR
private static bool DrawColoredEnumElement(Rect rect, bool value)
{
if (Event.current.type == EventType.MouseDown && rect.Contains(Event.current.mousePosition))
{
value = !value;
GUI.changed = true;
Event.current.Use();
}
UnityEditor.EditorGUI.DrawRect(rect.Padding(1), value ? new Color(0.1f, 0.8f, 0.2f) : new Color(0, 0, 0, 0.5f));
return value;
}
#endif
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.IsReadOnly">
<summary>
If true, inserting, removing and dragging columns and rows will become unavailable. But the cells themselves will remain modifiable.
If you want to disable everything, you can use the <see cref="!:ReadOnly"/> attribute.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.ResizableColumns">
<summary>
Whether or not columns are resizable.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.VerticalTitle">
<summary>
The vertical title label.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.HorizontalTitle">
<summary>
The horizontal title label.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.DrawElementMethod">
<summary>
Override how Odin draws each cell. <para />
[TableMatrix(DrawElementMethod='DrawMyElement')] <para />
public MyType[,] myArray; <para />
private static MyType DrawElement(Rect rect, MyType value) { return GUI.DrawMyType(rect, value); }
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.RowHeight">
<summary>
The height for all rows. 0 = default row height.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.SquareCells">
<summary>
If true, the height of each row will be the same as the width of the first cell.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.HideColumnIndices">
<summary>
If true, no column indices drawn.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.HideRowIndices">
<summary>
If true, no row indices drawn.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.RespectIndentLevel">
<summary>
Whether the drawn table should respect the current GUI indent level.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TableMatrixAttribute.Transpose">
<summary>
If true, tables are drawn with rows/columns reversed (C# initialization order).
</summary>
</member>
<member name="P:Sirenix.OdinInspector.TypeFilterAttribute.MemberName">
<summary>
Name of any field, property or method member that implements IList. E.g. arrays or Lists. Obsolete; use the FilterGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TypeFilterAttribute.FilterGetter">
<summary>
A resolved string that should evaluate to a value that is assignable to IList; e.g, arrays and lists are compatible.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TypeFilterAttribute.DropdownTitle">
<summary>
Gets or sets the title for the dropdown. Null by default.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TypeFilterAttribute.#ctor(System.String)">
<summary>
Creates a dropdown menu for a property.
</summary>
<param name="filterGetter">A resolved string that should evaluate to a value that is assignable to IList; e.g, arrays and lists are compatible.</param>
</member>
<member name="T:Sirenix.OdinInspector.TypeInfoBoxAttribute">
<summary>
<para>The TypeInfoBox attribute adds an info box to the very top of a type in the inspector.</para>
<para>Use this to add an info box to the top of a class in the inspector, without having to use neither the PropertyOrder nor the OnInspectorGUI attribute.</para>
</summary>
<example>
<para>The following example demonstrates the use of the TypeInfoBox attribute.</para>
<code>
[TypeInfoBox("This is my component and it is mine.")]
public class MyComponent : MonoBehaviour
{
// Class implementation.
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.InfoBoxAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DetailedInfoBoxAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TypeInfoBoxAttribute.Message">
<summary>
The message to display in the info box.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TypeInfoBoxAttribute.#ctor(System.String)">
<summary>
Draws an info box at the top of a type in the inspector.
</summary>
<param name="message">The message to display in the info box.</param>
</member>
<member name="T:Sirenix.OdinInspector.VerticalGroupAttribute">
<summary>
<para>VerticalGroup is used to gather properties together in a vertical group in the inspector.</para>
<para>This doesn't do much in and of itself, but in combination with other groups, such as <see cref="T:Sirenix.OdinInspector.HorizontalGroupAttribute"/> it can be very useful.</para>
</summary>
<example>
<para>The following example demonstrates how VerticalGroup can be used in conjunction with <see cref="T:Sirenix.OdinInspector.HorizontalGroupAttribute"/></para>
<code>
public class MyComponent : MonoBehaviour
{
[HorizontalGroup("Split")]
[VerticalGroup("Split/Left")]
public Vector3 Vector;
[VerticalGroup("Split/Left")]
public GameObject First;
[VerticalGroup("Split/Left")]
public GameObject Second;
[VerticalGroup("Split/Right", PaddingTop = 18f)]
public int A;
[VerticalGroup("Split/Right")]
public int B;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.HorizontalGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.VerticalGroupAttribute.PaddingTop">
<summary>
Space in pixels at the top of the group.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.VerticalGroupAttribute.PaddingBottom">
<summary>
Space in pixels at the bottom of the group.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.VerticalGroupAttribute.#ctor(System.String,System.Single)">
<summary>
Groups properties vertically.
</summary>
<param name="groupId">The group ID.</param>
<param name="order">The group order.</param>
</member>
<member name="M:Sirenix.OdinInspector.VerticalGroupAttribute.#ctor(System.Single)">
<summary>
<para>Groups properties vertically.</para>
<para>GroupId: _DefaultVerticalGroup</para>
</summary>
<param name="order">The group order.</param>
</member>
<member name="M:Sirenix.OdinInspector.VerticalGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines properties that have been group vertically.
</summary>
<param name="other">The group attribute to combine with.</param>
</member>
<member name="T:Sirenix.OdinInspector.AttributeTargetFlags">
<summary>
Not yet documented.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.AttributeTargetFlags.Default">
<summary>
Not yet documented.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.SearchableAttribute">
<summary>
Adds a search filter that can search the children of the field or type on
which it is applied. Note that this does not currently work when directly
applied to dictionaries, though a search field "above" the dictionary will
still search the dictionary's properties if it is searching recursively.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.SearchableAttribute.FuzzySearch">
<summary>
Whether to use fuzzy string matching for the search.
Default value: true.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.SearchableAttribute.FilterOptions">
<summary>
The options for which things to use to filter the search.
Default value: All.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.SearchableAttribute.Recursive">
<summary>
Whether to search recursively, or only search the top level properties.
Default value: true.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.IncludeMyAttributesAttribute">
<summary>
When this attribute is added is added to another attribute, then attributes from that attribute
will also be added to the property in the attribute processing step.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.InlineEditorObjectFieldModes">
<summary>
How the InlineEditor attribute drawer should draw the object field.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorObjectFieldModes.Boxed">
<summary>
Draws the object field in a box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorObjectFieldModes.Foldout">
<summary>
Draws the object field with a foldout.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorObjectFieldModes.Hidden">
<summary>
Hides the object field unless it's null.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorObjectFieldModes.CompletelyHidden">
<summary>
Hidden the object field also when the object is null.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ISearchFilterable">
<summary>
Implement this interface to create custom matching
logic for search filtering in the inspector.
</summary>
<example>
<para>The following example shows how you might do this:</para>
<code>
public class MyCustomClass : ISearchFilterable
{
public bool SearchEnabled;
public string MyStr;
public bool IsMatch(string searchString)
{
if (SearchEnabled)
{
return MyStr.Contains(searchString);
}
return false;
}
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.ObjectFieldAlignment">
<summary>
How the square object field should be aligned.
</summary>
<seealso cref="T:Sirenix.OdinInspector.PreviewFieldAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.ObjectFieldAlignment.Left">
<summary>
Left aligned.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ObjectFieldAlignment.Center">
<summary>
Aligned to the center.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ObjectFieldAlignment.Right">
<summary>
Right aligned.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.SearchFilterOptions">
<summary>
Options for filtering search.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.TitleAlignments">
<summary>
Title alignment enum used by various attributes.
</summary>
<seealso cref="T:Sirenix.OdinInspector.TitleGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TitleAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TitleAlignments.Left">
<summary>
Title and subtitle left aligned.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAlignments.Centered">
<summary>
Title and subtitle centered aligned.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAlignments.Right">
<summary>
Title and subtitle right aligned.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAlignments.Split">
<summary>
Title on the left, subtitle on the right.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.TitleGroupAttribute">
<summary>
Groups properties vertically together with a title, an optional subtitle, and an optional horizontal line.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleGroupAttribute.Subtitle">
<summary>
Optional subtitle.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleGroupAttribute.Alignment">
<summary>
Title alignment.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleGroupAttribute.HorizontalLine">
<summary>
Gets a value indicating whether or not to draw a horizontal line below the title.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleGroupAttribute.BoldTitle">
<summary>
If <c>true</c> the title will be displayed with a bold font.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleGroupAttribute.Indent">
<summary>
Gets a value indicating whether or not to indent all group members.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TitleGroupAttribute.#ctor(System.String,System.String,Sirenix.OdinInspector.TitleAlignments,System.Boolean,System.Boolean,System.Boolean,System.Single)">
<summary>
Groups properties vertically together with a title, an optional subtitle, and an optional horizontal line.
</summary>
<param name="title">The title-</param>
<param name="subtitle">Optional subtitle.</param>
<param name="alignment">The text alignment.</param>
<param name="horizontalLine">Horizontal line.</param>
<param name="boldTitle">Bold text.</param>
<param name="indent">Whether or not to indent all group members.</param>
<param name="order">The group order.</param>
</member>
<member name="M:Sirenix.OdinInspector.TitleGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines TitleGroup attributes.
</summary>
<param name="other">The other group attribute to combine with.</param>
</member>
<member name="T:Sirenix.OdinInspector.ButtonSizes">
<summary>
Various built-in button sizes.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonSizes.Small">
<summary>
Small button size, fits well with properties in the inspector.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonSizes.Medium">
<summary>
A larger button.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonSizes.Large">
<summary>
A very large button.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ButtonSizes.Gigantic">
<summary>
A gigantic button. Twice as big as Large
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ColorPaletteAttribute">
<summary>
<para>ColorPalette is used on any Color property, and allows for choosing colors from different definable palettes.</para>
<para>Use this to allow the user to choose from a set of predefined color options.</para>
</summary>
<remarks>
<para>See and edit the color palettes in Tools > Odin Inspector > Drawers > Color Palettes.</para>
<note type="note">The color property is not tied to the color palette, and can be edited. Therefore the color will also not update if the ColorPalette is edited.</note>
</remarks>
<example>
<para>The following example shows how ColorPalette is applied to a property. The user can freely choose between all available ColorPalettes.</para>
<code>
public class ColorPaletteExamples : MonoBehaviour
{
[ColorPalette]
public Color ColorOptions;
[ColorPalette("Underwater")]
public Color UnderwaterColor;
[ColorPalette("Fall"), HideLabel]
public Color WideColorPalette;
[ColorPalette("My Palette")]
public Color MyColor;
[ColorPalette("Clovers")]
public Color[] ColorArray;
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.ColorPaletteAttribute.PaletteName">
<summary>
Gets the name of the palette.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ColorPaletteAttribute.ShowAlpha">
<summary>
Indicates if the color palette should show alpha values or not.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ColorPaletteAttribute.#ctor">
<summary>
Adds a color palette options to a Color property.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ColorPaletteAttribute.#ctor(System.String)">
<summary>
Adds color options to a Color property from a specific palette.
</summary>
<param name="paletteName">Name of the palette.</param>
</member>
<member name="T:Sirenix.OdinInspector.CustomContextMenuAttribute">
<summary>
<para>CustomContextMenu is used on any property, and adds a custom options to the context menu for the property.</para>
<para>Use this for when you want to add custom actions to the context menu of a property.</para>
</summary>
<remarks>
<note type="note">CustomContextMenu currently does not support static functions.</note>
</remarks>
<example>
<para>The following example shows how CustomContextMenu is used to add a custom option to a property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[CustomContextMenu("My custom option", "MyAction")]
public Vector3 MyVector;
private void MyAction()
{
MyVector = Random.onUnitSphere;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.DisableContextMenuAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.CustomContextMenuAttribute.MenuItem">
<summary>
The name of the menu item.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.CustomContextMenuAttribute.MethodName">
<summary>
The name of the callback method. Obsolete; use the Action member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.CustomContextMenuAttribute.Action">
<summary>
A resolved string defining the action to take when the context menu is clicked.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.CustomContextMenuAttribute.#ctor(System.String,System.String)">
<summary>
Adds a custom option to the context menu of the property.
</summary>
<param name="menuItem">The name of the menu item.</param>
<param name="action">A resolved string defining the action to take when the context menu is clicked.</param>
</member>
<member name="T:Sirenix.OdinInspector.DelayedPropertyAttribute">
<summary>
Delays applying changes to properties while they still being edited in the inspector.
Similar to Unity's built-in Delayed attribute, but this attribute can also be applied to properties.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DetailedInfoBoxAttribute">
<summary>
<para>DetailedInfoBox is used on any property, and displays a message box that can be expanded to show more details.</para>
<para>Use this to convey a message to a user, and give them the option to see more details.</para>
</summary>
<example>
<para>The following example shows how DetailedInfoBox is used on a field.</para>
<code>
public class MyComponent : MonoBehaviour
{
[DetailedInfoBox("This is a message", "Here is some more details about that message")]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.InfoBoxAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.DetailedInfoBoxAttribute.Message">
<summary>
The message for the message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DetailedInfoBoxAttribute.Details">
<summary>
The hideable details of the message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DetailedInfoBoxAttribute.InfoMessageType">
<summary>
Type of the message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DetailedInfoBoxAttribute.VisibleIf">
<summary>
Optional name of a member to hide or show the message box.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.DetailedInfoBoxAttribute.#ctor(System.String,System.String,Sirenix.OdinInspector.InfoMessageType,System.String)">
<summary>
Displays a message box with hideable details.
</summary>
<param name="message">The message for the message box.</param>
<param name="details">The hideable details of the message box.</param>
<param name="infoMessageType">Type of the message box.</param>
<param name="visibleIf">Optional name of a member to hide or show the message box.</param>
</member>
<member name="T:Sirenix.OdinInspector.DictionaryDisplayOptions">
<summary>
Various display modes for the dictionary to draw its items.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDisplayOptions.OneLine">
<summary>
Draws all dictionary items in two columns. The left column contains all key values, the right column displays all values.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDisplayOptions.Foldout">
<summary>
Draws each dictionary item in a box with the key in the header and the value inside the box.
Whether or not the box is expanded or collapsed by default, is determined by the
"Expand Foldout By Default" setting found in the preferences window "Tools > Odin Inspector > Preferences > Drawers > Settings".
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDisplayOptions.CollapsedFoldout">
<summary>
Draws each dictionary item in a collapsed foldout with the key in the header and the value inside the box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDisplayOptions.ExpandedFoldout">
<summary>
Draws each dictionary item in an expanded foldout with the key in the header and the value inside the box.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DictionaryDrawerSettings">
<summary>
Customize the behavior for dictionaries in the inspector.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDrawerSettings.KeyLabel">
<summary>
Specify an alternative key label for the dictionary drawer.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDrawerSettings.ValueLabel">
<summary>
Specify an alternative value label for the dictionary drawer.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDrawerSettings.DisplayMode">
<summary>
Specify how the dictionary should draw its items.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DictionaryDrawerSettings.IsReadOnly">
<summary>
Gets or sets a value indicating whether this instance is read only.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.DisableContextMenuAttribute">
<summary>
<para>DisableContextMenu is used on any property and disables the context menu for that property.</para>
<para>Use this if you do not want the context menu to be available for a property.</para>
</summary>
<example>
<para>The following example shows how DisableContextMenu is used on a property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[DisableContextMenu]
public Vector3 MyVector;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.CustomContextMenuAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.DisableContextMenuAttribute.DisableForMember">
<summary>
Whether to disable the context menu for the member itself.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DisableContextMenuAttribute.DisableForCollectionElements">
<summary>
Whether to disable the context menu for collection elements.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.DisableContextMenuAttribute.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.DisableContextMenuAttribute" /> class.
</summary>
<param name="disableForMember">Whether to disable the context menu for the member itself.</param>
<param name="disableCollectionElements">Whether to also disable the context menu of collection elements.</param>
</member>
<member name="T:Sirenix.OdinInspector.DisableIfAttribute">
<summary>
<para>DisableIf is used on any property, and can disable or enable the property in the inspector.</para>
<para>Use this to disable properties when they are irrelevant.</para>
</summary>
<example>
<para>The following example shows how a property can be disabled by the state of a field.</para>
<code>
public class MyComponent : MonoBehaviour
{
public bool DisableProperty;
[DisableIf("DisableProperty")]
public int MyInt;
public SomeEnum SomeEnumField;
[DisableIf("SomeEnumField", SomeEnum.SomeEnumMember)]
public string SomeString;
}
</code>
</example>
<example>
<para>The following examples show how a property can be disabled by a function.</para>
<code>
public class MyComponent : MonoBehaviour
{
[EnableIf("MyDisableFunction")]
public int MyInt;
private bool MyDisableFunction()
{
// ...
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.DisableIfAttribute.MemberName">
<summary>
The name of a bool member field, property or method. Obsolete; use the Condition member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DisableIfAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.DisableIfAttribute.Value">
<summary>
The optional condition value.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.DisableIfAttribute.#ctor(System.String)">
<summary>
Disables a property in the inspector, based on the value of a resolved string.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
</member>
<member name="M:Sirenix.OdinInspector.DisableIfAttribute.#ctor(System.String,System.Object)">
<summary>
Disables a property in the inspector, if the resolved string evaluates to the specified value.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="optionalValue">Value to check against.</param>
</member>
<member name="T:Sirenix.OdinInspector.DisableInEditorModeAttribute">
<summary>
<para>DisableInEditorMode is used on any property, and disables the property when not in play mode.</para>
<para>Use this when you only want a property to be editable when in play mode.</para>
</summary>
<example>
<para>The following example shows how DisableInEditorMode is used to disable a property when in the editor.</para>
<code>
public class MyComponent : MonoBehaviour
{
[DisableInEditorMode]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.DisableInPlayModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.DisableInPlayModeAttribute">
<summary>
<para>DisableInPlayMode is used on any property, and disables the property when in play mode.</para>
<para>Use this to prevent users from editing a property when in play mode.</para>
</summary>
<example>
<para>The following example shows how DisableInPlayMode is used to disable a property when in play mode.</para>
<code>
public class MyComponent : MonoBehaviour
{
[DisableInPlayMode]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.HideInPlayModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableInEditorModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideInEditorModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.DisplayAsStringAttribute">
<summary>
<para>DisplayAsString is used on any property, and displays a string in the inspector as text.</para>
<para>Use this for when you want to show a string in the inspector, but not allow for any editing.</para>
</summary>
<remarks>
<para>DisplayAsString uses the property's ToString method to display the property as a string.</para>
</remarks>
<example>
<para>The following example shows how DisplayAsString is used to display a string property as text in the inspector.</para>
<code>
public class MyComponent : MonoBehaviour
{
[DisplayAsString]
public string MyInt = 5;
// You can combine with <see cref="T:Sirenix.OdinInspector.HideLabelAttribute"/> to display a message in the inspector.
[DisplayAsString, HideLabel]
public string MyMessage = "This string will be displayed as text in the inspector";
[DisplayAsString(false)]
public string InlineMessage = "This string is very long, but has been configured to not overflow.";
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.TitleAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.MultiLinePropertyAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.DisplayAsStringAttribute.Overflow">
<summary>
If <c>true</c>, the string will overflow past the drawn space and be clipped when there's not enough space for the text.
If <c>false</c> the string will expand to multiple lines, if there's not enough space when drawn.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.DisplayAsStringAttribute.#ctor">
<summary>
Displays the property as a string in the inspector.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.DisplayAsStringAttribute.#ctor(System.Boolean)">
<summary>
Displays the property as a string in the inspector.
</summary>
<param name="overflow">Value indicating if the string should overflow past the available space, or expand to multiple lines when there's not enough horizontal space.</param>
</member>
<member name="T:Sirenix.OdinInspector.DontApplyToListElementsAttribute">
<summary>
<para>DontApplyToListElements is used on other attributes, and indicates that those attributes should be applied only to the list, and not to the elements of the list.</para>
<para>Use this on attributes that should only work on a list or array property as a whole, and not on each element of the list.</para>
</summary>
<example>
<para>The following example shows how DontApplyToListElements is used on <see cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>.</para>
<code>
[DontApplyToListElements]
[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = true)]
public sealed class VisibleIfAttribute : Attribute
{
public string MemberName { get; private set; }
public VisibleIfAttribute(string memberName)
{
this.MemberName = memberName;
}
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.DrawWithUnityAttribute">
<summary>
<para>DrawWithUnity can be applied to a field or property to make Odin draw it using Unity's old drawing system. Use it if you want to selectively disable Odin drawing for a particular member.</para>
</summary>
<remarks>
<para>Note that this attribute does not mean "disable Odin completely for this property"; it is visual only in nature, and in fact represents an Odin drawer which calls into Unity's old property drawing system. As Odin is still ultimately responsible for arranging the drawing of the property, and since other attributes exist with a higher priority than this attribute, and it is not guaranteed that Unity will draw the property if another attribute is present to override this one.</para>
</remarks>
</member>
<member name="T:Sirenix.OdinInspector.InlineButtonAttribute">
<summary>
<para>The inline button adds a button to the end of a property.</para>
</summary>
<remarks>
<note type="note">Due to a bug, multiple inline buttons are currently not supported.</note>
</remarks>
<example>
<para>The following examples demonstrates how InlineButton can be used.</para>
<code>
public class MyComponent : MonoBehaviour
{
// Adds a button to the end of the A property.
[InlineButton("MyFunction")]
public int A;
// This is example demonstrates how you can change the label of the button.
// InlineButton also supports refering to string members with $.
[InlineButton("MyFunction", "Button")]
public int B;
private void MyFunction()
{
// ...
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.InlineButtonAttribute.MemberMethod">
<summary>
Name of member method to call when the button is clicked. Obsolete; use the Action member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineButtonAttribute.Action">
<summary>
A resolved string that defines the action to perform when the button is clicked, such as an expression or method invocation.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineButtonAttribute.Label">
<summary>
Optional label of the button.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.InlineButtonAttribute.#ctor(System.String,System.String)">
<summary>
Draws a button to the right of the property.
</summary>
<param name="action">A resolved string that defines the action to perform when the button is clicked, such as an expression or method invocation.</param>
<param name="label">Optional label of the button.</param>
</member>
<member name="T:Sirenix.OdinInspector.Internal.ISubGroupProviderAttribute">
<summary>
Not yet documented.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.Internal.ISubGroupProviderAttribute.GetSubGroupAttributes">
<summary>
Not yet documented.
</summary>
<returns>Not yet documented.</returns>
</member>
<member name="M:Sirenix.OdinInspector.Internal.ISubGroupProviderAttribute.RepathMemberAttribute(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Not yet documented.
</summary>
<param name="attr">Not yet documented.</param>
<returns>Not yet documented.</returns>
</member>
<member name="T:Sirenix.OdinInspector.ShowForPrefabOnlyAttribute">
<summary>
<para>ShowForPrefabOnlyAttribute is used on any field or property, and only shows properties from prefab assets inspector.</para>
<para>Use this to ensure the same value on a property, across all instances of a prefab.</para>
</summary>
<remarks>
<para>On non-prefab objects or instances, this attribute does nothing, and allows properties to be edited as normal.</para>
</remarks>
<example>
<para>The following example shows how ShowForPrefabOnlyAttribute is used on properties.</para>
<code>
public class MyComponent
{
[ShowForPrefabOnlyAttribute]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.EnableForPrefabOnlyAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.EnableForPrefabOnlyAttribute">
<summary>
<para>EnableForPrefabOnly is used on any field or property, and only allows editing of values from prefab assets inspector.</para>
<para>Use this to ensure the same value on a property, across all instances of a prefab.</para>
</summary>
<remarks>
<para>On non-prefab objects or instances, this attribute does nothing, and allows properties to be edited as normal.</para>
</remarks>
<example>
<para>The following example shows how EnableForPrefabOnly is used on properties.</para>
<code>
public class MyComponent
{
[EnableForPrefabOnly]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.EnableForPrefabOnlyAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.EnableIfAttribute">
<summary>
<para>EnableIf is used on any property, and can enable or disable the property in the inspector.</para>
<para>Use this to enable properties when they are relevant.</para>
</summary>
<example>
<para>The following example shows how a property can be enabled by the state of a field.</para>
<code>
public class MyComponent : MonoBehaviour
{
public bool EnableProperty;
[EnableIf("EnableProperty")]
public int MyInt;
public SomeEnum SomeEnumField;
[EnableIf("SomeEnumField", SomeEnum.SomeEnumMember)]
public string SomeString;
}
</code>
</example>
<example>
<para>The following examples show how a property can be enabled by a function.</para>
<code>
public class MyComponent : MonoBehaviour
{
[EnableIf("MyEnableFunction")]
public int MyInt;
private bool MyEnableFunction()
{
// ...
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableInEditorModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableInPlayModeAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.EnableIfAttribute.MemberName">
<summary>
The name of a bool member field, property or method. Obsolete; use the Condition member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.EnableIfAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.EnableIfAttribute.Value">
<summary>
The optional condition value.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.EnableIfAttribute.#ctor(System.String)">
<summary>
Enables a property in the inspector, based on the value of a resolved string.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
</member>
<member name="M:Sirenix.OdinInspector.EnableIfAttribute.#ctor(System.String,System.Object)">
<summary>
Enables a property in the inspector, if the resolved string evaluates to the specified value.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="optionalValue">Value to check against.</param>
</member>
<member name="T:Sirenix.OdinInspector.EnumToggleButtonsAttribute">
<summary>
<para>Draws an enum in a horizontal button group instead of a dropdown.</para>
</summary>
<example>
<code>
public class MyComponent : MonoBehvaiour
{
[EnumToggleButtons]
public MyBitmaskEnum MyBitmaskEnum;
[EnumToggleButtons]
public MyEnum MyEnum;
}
[Flags]
public enum MyBitmaskEnum
{
A = 1 << 1, // 1
B = 1 << 2, // 2
C = 1 << 3, // 4
ALL = A | B | C
}
public enum MyEnum
{
A,
B,
C
}
</code>
</example>
<seealso cref="T:System.Attribute" />
</member>
<member name="T:Sirenix.OdinInspector.HideIfAttribute">
<summary>
<para>HideIf is used on any property and can hide the property in the inspector.</para>
<para>Use this to hide irrelevant properties based on the current state of the object.</para>
</summary>
<example>
<para>This example shows a component with fields hidden by the state of another field.</para>
<code>
public class MyComponent : MonoBehaviour
{
public bool HideProperties;
[HideIf("HideProperties")]
public int MyInt;
[HideIf("HideProperties", false)]
public string MyString;
public SomeEnum SomeEnumField;
[HideIf("SomeEnumField", SomeEnum.SomeEnumMember)]
public string SomeString;
}
</code>
</example>
<example>
<para>This example shows a component with a field that is hidden when the game object is inactive.</para>
<code>
public class MyComponent : MonoBehaviour
{
[HideIf("MyVisibleFunction")]
public int MyHideableField;
private bool MyVisibleFunction()
{
return !this.gameObject.activeInHierarchy;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowIfAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.HideIfAttribute.MemberName">
<summary>
The name of a bool member field, property or method. Obsolete; use the Condition member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HideIfAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HideIfAttribute.Value">
<summary>
The optional condition value.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HideIfAttribute.Animate">
<summary>
Whether or not to slide the property in and out when the state changes.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.HideIfAttribute.#ctor(System.String,System.Boolean)">
<summary>
Hides a property in the inspector, based on the value of a resolved string.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="animate">Whether or not to slide the property in and out when the state changes.</param>
</member>
<member name="M:Sirenix.OdinInspector.HideIfAttribute.#ctor(System.String,System.Object,System.Boolean)">
<summary>
Hides a property in the inspector, if the resolved string evaluates to the specified value.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="optionalValue">Value to check against.</param>
<param name="animate">Whether or not to slide the property in and out when the state changes.</param>
</member>
<member name="T:Sirenix.OdinInspector.HideInPlayModeAttribute">
<summary>
<para>HideInPlayMode is used on any property, and hides the property when not in editor mode.</para>
<para>Use this when you only want a property to only be visible the editor.</para>
</summary>
<example>
<para>The following example shows how HideInPlayMode is used to hide a property when in play mode.</para>
<code>
public class MyComponent : MonoBehaviour
{
[HideInPlayMode]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.HideInEditorModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableInPlayModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.HideInEditorModeAttribute">
<summary>
<para>HideInEditorMode is used on any property, and hides the property when not in play mode.</para>
<para>Use this when you only want a property to only be visible play mode.</para>
</summary>
<example>
<para>The following example shows how HideInEditorMode is used to hide a property when in the editor.</para>
<code>
public class MyComponent : MonoBehaviour
{
[HideInEditorMode]
public int MyInt;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.HideInPlayModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableInPlayModeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.HideMonoScriptAttribute">
<summary>
Apply HideMonoScript to your class to prevent the Script property from being shown in the inspector.
<remarks>
<para>This attribute has the same effect on a single type that the global configuration option "Show Mono Script In Editor" in "Preferences -> Odin Inspector -> General -> Drawers" has globally when disabled.</para>
</remarks>
</summary>
<example>
<para>The following example shows how to use this attribute.</para>
<code>
[HideMonoScript]
public class MyComponent : MonoBehaviour
{
// The Script property will not be shown for this component in the inspector
}
</code>
</example>
<seealso cref="T:System.Attribute" />
</member>
<member name="T:Sirenix.OdinInspector.HideReferenceObjectPickerAttribute">
<summary>
Hides the polymorphic object-picker shown above the properties of non-Unity serialized reference types.
</summary>
<remarks>
When the object picker is hidden, you can right click and set the instance to null, in order to set a new value.
If you don't want this behavior, you can use <see cref="!:DisableContextMenu"/> attribute to ensure people can't change the value.
</remarks>
<seealso cref="!:Sirenix.Serialization.OdinSerializeAttribute"/>
<example>
<code>
public class MyComponent : SerializedMonoBehaviour
{
[Header("Hidden Object Pickers")]
[Indent]
[HideReferenceObjectPicker]
public MyCustomReferenceType OdinSerializedProperty1;
[Indent]
[HideReferenceObjectPicker]
public MyCustomReferenceType OdinSerializedProperty2;
[Indent]
[Header("Shown Object Pickers")]
public MyCustomReferenceType OdinSerializedProperty3;
[Indent]
public MyCustomReferenceType OdinSerializedProperty4;
public class MyCustomReferenceType
{
public int A;
public int B;
public int C;
}
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.HorizontalGroupAttribute">
<summary>
<para>HorizontalGroup is used group multiple properties horizontally in the inspector.</para>
<para>The width can either be specified as percentage or pixels.</para>
<para>All values between 0 and 1 will be treated as a percentage.</para>
<para>If the width is 0 the column will be automatically sized.</para>
<para>Margin-left and right can only be specified in pixels.</para>
</summary>
<example>
<para>The following example shows how three properties have been grouped together horizontally.</para>
<code>
// The width can either be specified as percentage or pixels.
// All values between 0 and 1 will be treated as a percentage.
// If the width is 0 the column will be automatically sized.
// Margin-left and right can only be specified in pixels.
public class HorizontalGroupAttributeExamples : MonoBehaviour
{
[HorizontalGroup]
public int A;
[HideLabel, LabelWidth (150)]
[HorizontalGroup(150)]
public LayerMask B;
// LabelWidth can be helpfull when dealing with HorizontalGroups.
[HorizontalGroup("Group 1"), LabelWidth(15)]
public int C;
[HorizontalGroup("Group 1"), LabelWidth(15)]
public int D;
[HorizontalGroup("Group 1"), LabelWidth(15)]
public int E;
// Having multiple properties in a column can be achived using multiple groups. Checkout the "Combining Group Attributes" example.
[HorizontalGroup("Split", 0.5f, PaddingRight = 15)]
[BoxGroup("Split/Left"), LabelWidth(15)]
public int L;
[BoxGroup("Split/Right"), LabelWidth(15)]
public int M;
[BoxGroup("Split/Left"), LabelWidth(15)]
public int N;
[BoxGroup("Split/Right"), LabelWidth(15)]
public int O;
// Horizontal Group also has supprot for: Title, MarginLeft, MarginRight, PaddingLeft, PaddingRight, MinWidth and MaxWidth.
[HorizontalGroup("MyButton", MarginLeft = 0.25f, MarginRight = 0.25f)]
public void SomeButton()
{
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.VerticalGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.Width">
<summary>
The width. Values between 0 and 1 will be treated as percentage, 0 = auto, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.MarginLeft">
<summary>
The margin left. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.MarginRight">
<summary>
The margin right. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.PaddingLeft">
<summary>
The padding left. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.PaddingRight">
<summary>
The padding right. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.MinWidth">
<summary>
The minimum Width. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.MaxWidth">
<summary>
The maximum Width. Values between 0 and 1 will be treated as percentage, 0 = ignore, otherwise pixels.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.Title">
<summary>
Adds a title above the horizontal group.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.HorizontalGroupAttribute.LabelWidth">
<summary>
The label width, 0 = auto.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.HorizontalGroupAttribute.#ctor(System.String,System.Single,System.Int32,System.Int32,System.Single)">
<summary>
Organizes the property in a horizontal group.
</summary>
<param name="group">The group for the property.</param>
<param name="width">The width of the property. Values between 0 and 1 are interpolated as a percentage, otherwise pixels.</param>
<param name="marginLeft">The left margin in pixels.</param>
<param name="marginRight">The right margin in pixels.</param>
<param name="order">The order of the group in the inspector.</param>
</member>
<member name="M:Sirenix.OdinInspector.HorizontalGroupAttribute.#ctor(System.Single,System.Int32,System.Int32,System.Single)">
<summary>
Organizes the property in a horizontal group.
</summary>
<param name="width">The width of the property. Values between 0 and 1 are interpolated as a percentage, otherwise pixels.</param>
<param name="marginLeft">The left margin in pixels.</param>
<param name="marginRight">The right margin in pixels.</param>
<param name="order">The order of the group in the inspector.</param>
</member>
<member name="M:Sirenix.OdinInspector.HorizontalGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Merges the values of two group attributes together.
</summary>
<param name="other">The other group to combine with.</param>
</member>
<member name="T:Sirenix.OdinInspector.InlineEditorAttribute">
<summary>
<para>InlineAttribute is used on any property or field with a type that inherits from UnityEngine.Object. This includes components and assets etc.</para>
</summary>
<example>
<code>
public class InlineEditorExamples : MonoBehaviour
{
[DisableInInlineEditors]
public Vector3 DisabledInInlineEditors;
[HideInInlineEditors]
public Vector3 HiddenInInlineEditors;
[InlineEditor]
public Transform InlineComponent;
[InlineEditor(InlineEditorModes.FullEditor)]
public Material FullInlineEditor;
[InlineEditor(InlineEditorModes.GUIAndHeader)]
public Material InlineMaterial;
[InlineEditor(InlineEditorModes.SmallPreview)]
public Material[] InlineMaterialList;
[InlineEditor(InlineEditorModes.LargePreview)]
public GameObject InlineObjectPreview;
[InlineEditor(InlineEditorModes.LargePreview)]
public Mesh InlineMeshPreview;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.DisableInInlineEditorsAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideInInlineEditorsAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.InlineEditorAttribute.Expanded">
<summary>
If true, the inline editor will start expanded.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.DrawHeader">
<summary>
Draw the header editor header inline.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.DrawGUI">
<summary>
Draw editor GUI inline.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.DrawPreview">
<summary>
Draw editor preview inline.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.MaxHeight">
<summary>
Maximum height of the inline editor. If the inline editor exceeds the specified height, a scrollbar will appear.
Values less or equals to zero will let the InlineEditor expand to its full size.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.PreviewWidth">
<summary>
The size of the editor preview if drawn together with GUI.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.PreviewHeight">
<summary>
The size of the editor preview if drawn alone.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.IncrementInlineEditorDrawerDepth">
<summary>
If false, this will prevent the InlineEditor attribute from incrementing the InlineEditorAttributeDrawer.CurrentInlineEditorDrawDepth.
This is helpful in cases where you want to draw the entire editor, and disregard attributes
such as [<see cref="T:Sirenix.OdinInspector.HideInInlineEditorsAttribute"/>] and [<see cref="T:Sirenix.OdinInspector.DisableInInlineEditorsAttribute"/>].
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.ObjectFieldMode">
<summary>
How the InlineEditor attribute drawer should draw the object field.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorAttribute.DisableGUIForVCSLockedAssets">
<summary>
Whether to set GUI.enabled = false when drawing an editor for an asset that is locked by source control. Defaults to true.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.InlineEditorAttribute.#ctor(Sirenix.OdinInspector.InlineEditorModes,Sirenix.OdinInspector.InlineEditorObjectFieldModes)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute" /> class.
</summary>
<param name="inlineEditorMode">The inline editor mode.</param>
<param name="objectFieldMode">How the object field should be drawn.</param>
</member>
<member name="M:Sirenix.OdinInspector.InlineEditorAttribute.#ctor(Sirenix.OdinInspector.InlineEditorObjectFieldModes)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute"/> class.
</summary>
<param name="objectFieldMode">How the object field should be drawn.</param>
</member>
<member name="T:Sirenix.OdinInspector.SuppressInvalidAttributeErrorAttribute">
<summary>
<para>SuppressInvalidAttributeError is used on members to suppress the inspector error message you get when applying an attribute to a value that it's not supposed to work on.</para>
<para>This can be very useful for applying attributes to generic parameter values, when it only applies to some of the possible types that the value might become.</para>
</summary>
<example>
<para>The following example shows a case where the attribute might be useful.</para>
<code>
public class NamedValue<T>
{
public string Name;
// The Range attribute will be applied if T is compatible with it, but if T is not compatible, an error will not be shown.
[SuppressInvalidAttributeError, Range(0, 10)]
public T Value;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.InlineEditorModes">
<summary>
Editor modes for <see cref="T:Sirenix.OdinInspector.InlineEditorAttribute" />
</summary>
<seealso cref="T:Sirenix.OdinInspector.InlineEditorAttribute" />
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.GUIOnly">
<summary>
Draws only the editor GUI
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.GUIAndHeader">
<summary>
Draws the editor GUI and the editor header.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.GUIAndPreview">
<summary>
Draws the editor GUI to the left, and a small editor preview to the right.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.SmallPreview">
<summary>
Draws a small editor preview without any GUI.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.LargePreview">
<summary>
Draws a large editor preview without any GUI.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InlineEditorModes.FullEditor">
<summary>
Draws the editor header and GUI to the left, and a small editor preview to the right.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ShowDrawerChainAttribute">
<summary>
<para>
ShowDrawerChain lists all prepend, append and value drawers being used in the inspector.
This is great in situations where you want to debug, and want to know which drawers might be involved in drawing the property.
</para>
<para>Your own custom drawers are highlighted with a green label.</para>
<para>Drawers, that have not been called during the draw chain, will be greyed out in the inspector to make it clear which drawers have had an effect on the properties.</para>
</summary>
<example>
<code>
public class MyComponent : MonoBehaviour
{
[ShowDrawerChain]
public int IndentedInt;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.ShowOdinSerializedPropertiesInInspectorAttribute">
<summary>
Marks a type as being specially serialized. Odin uses this attribute to check whether it should include non-Unity-serialized members in the inspector.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.FoldoutGroupAttribute">
<summary>
<para>FoldoutGroup is used on any property, and organizes properties into a foldout.</para>
<para>Use this to organize properties, and to allow the user to hide properties that are not relevant for them at the moment.</para>
</summary>
<example>
<para>The following example shows how FoldoutGroup is used to organize properties into a foldout.</para>
<code>
public class MyComponent : MonoBehaviour
{
[FoldoutGroup("MyGroup")]
public int A;
[FoldoutGroup("MyGroup")]
public int B;
[FoldoutGroup("MyGroup")]
public int C;
}
</code>
</example>
<example>
<para>The following example shows how properties can be organizes into multiple foldouts.</para>
<code>
public class MyComponent : MonoBehaviour
{
[FoldoutGroup("First")]
public int A;
[FoldoutGroup("First")]
public int B;
[FoldoutGroup("Second")]
public int C;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyGroupAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.FoldoutGroupAttribute.Expanded">
<summary>
Gets a value indicating whether or not the foldout should be expanded by default.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.FoldoutGroupAttribute.HasDefinedExpanded">
<summary>
Gets a value indicating whether or not the Expanded property has been set.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.FoldoutGroupAttribute.#ctor(System.String,System.Single)">
<summary>
Adds the property to the specified foldout group.
</summary>
<param name="groupName">Name of the foldout group.</param>
<param name="order">The order of the group in the inspector.</param>
</member>
<member name="M:Sirenix.OdinInspector.FoldoutGroupAttribute.#ctor(System.String,System.Boolean,System.Single)">
<summary>
Adds the property to the specified foldout group.
</summary>
<param name="groupName">Name of the foldout group.</param>
<param name="expanded">Whether or not the foldout should be expanded by default.</param>
<param name="order">The order of the group in the inspector.</param>
</member>
<member name="M:Sirenix.OdinInspector.FoldoutGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines the foldout property with another.
</summary>
<param name="other">The group to combine with.</param>
</member>
<member name="T:Sirenix.OdinInspector.GUIColorAttribute">
<summary>
<para>GUIColor is used on any property and changes the GUI color used to draw the property.</para>
</summary>
<example>
<para>The following example shows how GUIColor is used on a properties to create a rainbow effect.</para>
<code>
public class MyComponent : MonoBehaviour
{
[GUIColor(1f, 0f, 0f)]
public int A;
[GUIColor(1f, 0.5f, 0f, 0.2f)]
public int B;
[GUIColor("GetColor")]
public int C;
private Color GetColor() { return this.A == 0 ? Color.red : Color.white; }
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.GUIColorAttribute.Color">
<summary>
The GUI color of the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.GUIColorAttribute.GetColor">
<summary>
The name of a local field, member or property that returns a Color. Both static and instance methods are supported.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.GUIColorAttribute.#ctor(System.Single,System.Single,System.Single,System.Single)">
<summary>
Sets the GUI color for the property.
</summary>
<param name="r">The red channel.</param>
<param name="g">The green channel.</param>
<param name="b">The blue channel.</param>
<param name="a">The alpha channel.</param>
</member>
<member name="M:Sirenix.OdinInspector.GUIColorAttribute.#ctor(System.String)">
<summary>
Sets the GUI color for the property.
</summary>
<param name="getColor">Specify the name of a local field, member or property that returns a Color.</param>
</member>
<member name="T:Sirenix.OdinInspector.HideLabelAttribute">
<summary>
<para>HideLabel is used on any property, and hides the label in the inspector.</para>
<para>Use this to hide the label of properties in the inspector.</para>
</summary>
<example>
<para>The following example show how HideLabel is used to hide the label of a game object property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[HideLabel]
public GameObject MyGameObjectWithoutLabel;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.LabelTextAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.IndentAttribute">
<summary>
<para>Indent is used on any property and moves the property's label to the right.</para>
<para>Use this to clearly organize properties in the inspector.</para>
</summary>
<example>
<para>The following example shows how a property is indented by Indent.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Indent]
public int IndentedInt;
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.IndentAttribute.IndentLevel">
<summary>
Indicates how much a property should be indented.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.IndentAttribute.#ctor(System.Int32)">
<summary>
Indents a property in the inspector.
</summary>
<param name="indentLevel">How much a property should be indented.</param>
</member>
<member name="T:Sirenix.OdinInspector.InfoBoxAttribute">
<summary>
<para>InfoBox is used on any property, and display a text box above the property in the inspector.</para>
<para>Use this to add comments or warn about the use of different properties.</para>
</summary>
<example>
<para>The following example shows different info box types.</para>
<code>
public class MyComponent : MonoBehaviour
{
[InfoBox("This is an int property")]
public int MyInt;
[InfoBox("This info box is a warning", InfoMessageType.Warning)]
public float MyFloat;
[InfoBox("This info box is an error", InfoMessageType.Error)]
public object MyObject;
[InfoBox("This info box is just a box", InfoMessageType.None)]
public Vector3 MyVector;
}
</code>
</example>
<example>
<para>The following example how info boxes can be hidden by fields and properties.</para>
<code>
public class MyComponent : MonoBehaviour
{
[InfoBox("This info box is hidden by an instance field.", "InstanceShowInfoBoxField")]
public int MyInt;
public bool InstanceShowInfoBoxField;
[InfoBox("This info box is hideable by a static field.", "StaticShowInfoBoxField")]
public float MyFloat;
public static bool StaticShowInfoBoxField;
[InfoBox("This info box is hidden by an instance property.", "InstanceShowInfoBoxProperty")]
public int MyOtherInt;
public bool InstanceShowInfoBoxProperty { get; set; }
[InfoBox("This info box is hideable by a static property.", "StaticShowInfoBoxProperty")]
public float MyOtherFloat;
public static bool StaticShowInfoBoxProperty { get; set; }
}
</code>
</example>
<example>
<para>The following example shows how info boxes can be hidden by functions.</para>
<code>
public class MyComponent : MonoBehaviour
{
[InfoBox("This info box is hidden by an instance function.", "InstanceShowFunction")]
public int MyInt;
public bool InstanceShowFunction()
{
return this.MyInt == 0;
}
[InfoBox("This info box is hidden by a static function.", "StaticShowFunction")]
public short MyShort;
public bool StaticShowFunction()
{
return true;
}
// You can also specify a function with the same type of parameter.
// Use this to specify the same function, for multiple different properties.
[InfoBox("This info box is hidden by an instance function with a parameter.", "InstanceShowParameterFunction")]
public GameObject MyGameObject;
public bool InstanceShowParameterFunction(GameObject property)
{
return property != null;
}
[InfoBox("This info box is hidden by a static function with a parameter.", "StaticShowParameterFunction")]
public Vector3 MyVector;
public bool StaticShowParameterFunction(Vector3 property)
{
return property.magnitude == 0f;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.RequiredAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ValidateInputAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.InfoBoxAttribute.Message">
<summary>
The message to display in the info box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoBoxAttribute.InfoMessageType">
<summary>
The type of the message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoBoxAttribute.VisibleIf">
<summary>
Optional member field, property or function to show and hide the info box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoBoxAttribute.GUIAlwaysEnabled">
<summary>
When <c>true</c> the InfoBox will ignore the GUI.enable flag and always draw as enabled.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.InfoBoxAttribute.#ctor(System.String,Sirenix.OdinInspector.InfoMessageType,System.String)">
<summary>
Displays an info box above the property.
</summary>
<param name="message">The message for the message box. Supports referencing a member string field, property or method by using $.</param>
<param name="infoMessageType">The type of the message box.</param>
<param name="visibleIfMemberName">Name of member bool to show or hide the message box.</param>
</member>
<member name="M:Sirenix.OdinInspector.InfoBoxAttribute.#ctor(System.String,System.String)">
<summary>
Displays an info box above the property.
</summary>
<param name="message">The message for the message box. Supports referencing a member string field, property or method by using $.</param>
<param name="visibleIfMemberName">Name of member bool to show or hide the message box.</param>
</member>
<member name="T:Sirenix.OdinInspector.MinMaxSliderAttribute">
<summary>
<para>Draw a special slider the user can use to specify a range between a min and a max value.</para>
<para>Uses a Vector2 where x is min and y is max.</para>
</summary>
<example>
<para>The following example shows how MinMaxSlider is used.</para>
<code>
public class Player : MonoBehaviour
{
[MinMaxSlider(4, 5)]
public Vector2 SpawnRadius;
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.MinValue">
<summary>
The hardcoded min value for the slider.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.MaxValue">
<summary>
The hardcoded max value for the slider.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.MinMaxSliderAttribute.MinMember">
<summary>
The name of a field, property or method to get the min value from. Obsolete; use MinValueGetter instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.MinValueGetter">
<summary>
A resolved string that should evaluate to a float value, which is used as the min bounds.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.MinMaxSliderAttribute.MaxMember">
<summary>
The name of a field, property or method to get the max value from. Obsolete; use MaxValueGetter instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.MaxValueGetter">
<summary>
A resolved string that should evaluate to a float value, which is used as the max bounds.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.MinMaxSliderAttribute.MinMaxMember">
<summary>
The name of a Vector2 field, property or method to get the min max values from. Obsolete; use MinMaxValueGetter instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.MinMaxValueGetter">
<summary>
A resolved string that should evaluate to a Vector2 value, which is used as the min/max bounds. If this is non-null, it overrides the behaviour of the MinValue, MinValueGetter, MaxValue and MaxValueGetter members.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinMaxSliderAttribute.ShowFields">
<summary>
Draw float fields for min and max value.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.MinMaxSliderAttribute.#ctor(System.Single,System.Single,System.Boolean)">
<summary>
Draws a min-max slider in the inspector. X will be set to min, and Y will be set to max.
</summary>
<param name="minValue">The min value.</param>
<param name="maxValue">The max value.</param>
<param name="showFields">If <c>true</c> number fields will drawn next to the MinMaxSlider.</param>
</member>
<member name="M:Sirenix.OdinInspector.MinMaxSliderAttribute.#ctor(System.String,System.Single,System.Boolean)">
<summary>
Draws a min-max slider in the inspector. X will be set to min, and Y will be set to max.
</summary>
<param name="minValueGetter">A resolved string that should evaluate to a float value, which is used as the min bounds.</param>
<param name="maxValue">The max value.</param>
<param name="showFields">If <c>true</c> number fields will drawn next to the MinMaxSlider.</param>
</member>
<member name="M:Sirenix.OdinInspector.MinMaxSliderAttribute.#ctor(System.Single,System.String,System.Boolean)">
<summary>
Draws a min-max slider in the inspector. X will be set to min, and Y will be set to max.
</summary>
<param name="minValue">The min value.</param>
<param name="maxValueGetter">A resolved string that should evaluate to a float value, which is used as the max bounds.</param>
<param name="showFields">If <c>true</c> number fields will drawn next to the MinMaxSlider.</param>
</member>
<member name="M:Sirenix.OdinInspector.MinMaxSliderAttribute.#ctor(System.String,System.String,System.Boolean)">
<summary>
Draws a min-max slider in the inspector. X will be set to min, and Y will be set to max.
</summary>
<param name="minValueGetter">A resolved string that should evaluate to a float value, which is used as the min bounds.</param>
<param name="maxValueGetter">A resolved string that should evaluate to a float value, which is used as the max bounds.</param>
<param name="showFields">If <c>true</c> number fields will drawn next to the MinMaxSlider.</param>
</member>
<member name="M:Sirenix.OdinInspector.MinMaxSliderAttribute.#ctor(System.String,System.Boolean)">
<summary>
Draws a min-max slider in the inspector. X will be set to min, and Y will be set to max.
</summary>
<param name="minMaxValueGetter">A resolved string that should evaluate to a Vector2 value, which is used as the min/max bounds. If this is non-null, it overrides the behaviour of the MinValue, MinValueGetter, MaxValue and MaxValueGetter members.</param>
<param name="showFields">If <c>true</c> number fields will drawn next to the MinMaxSlider.</param>
</member>
<member name="T:Sirenix.OdinInspector.ToggleLeftAttribute">
<summary>
<para>Draws the checkbox before the label instead of after.</para>
</summary>
<remarks>ToggleLeftAttribute can be used an all fields and properties of type boolean</remarks>
<example>
<code>
public class MyComponent : MonoBehaviour
{
[ToggleLeft]
public bool MyBoolean;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.LabelTextAttribute">
<summary>
<para>LabelText is used to change the labels of properties.</para>
<para>Use this if you want a different label than the name of the property.</para>
</summary>
<example>
<para>The following example shows how LabelText is applied to a few property fields.</para>
<code>
public MyComponent : MonoBehaviour
{
[LabelText("1")]
public int MyInt1;
[LabelText("2")]
public int MyInt2;
[LabelText("3")]
public int MyInt3;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.TitleAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.LabelTextAttribute.Text">
<summary>
The new text of the label.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.LabelTextAttribute.NicifyText">
<summary>
Whether the label text should be nicified before it is displayed, IE, "m_someField" becomes "Some Field".
If the label text is resolved via a member reference, an expression, or the like, then the evaluated result
of that member reference or expression will be nicified.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.LabelTextAttribute.#ctor(System.String)">
<summary>
Give a property a custom label.
</summary>
<param name="text">The new text of the label.</param>
</member>
<member name="M:Sirenix.OdinInspector.LabelTextAttribute.#ctor(System.String,System.Boolean)">
<summary>
Give a property a custom label.
</summary>
<param name="text">The new text of the label.</param>
<param name="nicifyText">Whether to nicify the label text.</param>
</member>
<member name="T:Sirenix.OdinInspector.ListDrawerSettingsAttribute">
<summary>
Customize the behavior for lists and arrays in the inspector.
</summary>
<example>
<para>This example shows how you can add your own custom add button to a list.</para>
<code>
[ListDrawerSettings(HideAddButton = true, OnTitleBarGUI = "DrawTitleBarGUI")]
public List<MyType> SomeList;
#if UNITY_EDITOR
private void DrawTitleBarGUI()
{
if (SirenixEditorGUI.ToolbarButton(EditorIcons.Plus))
{
this.SomeList.Add(new MyType());
}
}
#endif
</code>
</example>
<remarks>
This attribute is scheduled for refactoring.
</remarks>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.HideAddButton">
<summary>
If true, the add button will not be rendered in the title toolbar. You can use OnTitleBarGUI to implement your own add button.
</summary>
<value>
<c>true</c> if [hide add button]; otherwise, <c>false</c>.
</value>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.HideRemoveButton">
<summary>
If true, the remove button will not be rendered on list items. You can use OnBeginListElementGUI and OnEndListElementGUI to implement your own remove button.
</summary>
<value>
<c>true</c> if [hide remove button]; otherwise, <c>false</c>.
</value>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ListElementLabelName">
<summary>
Specify the name of a member inside each list element which defines the label being drawn for each list element.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.CustomAddFunction">
<summary>
Override the default behaviour for adding objects to the list.
If the referenced member returns the list type element, it will be called once per selected object.
If the referenced method returns void, it will only be called once regardless of how many objects are selected.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.OnBeginListElementGUI">
<summary>
Calls a method before each list element. The member referenced must have a return type of void, and an index parameter of type int which represents the element index being drawn.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.OnEndListElementGUI">
<summary>
Calls a method after each list element. The member referenced must have a return type of void, and an index parameter of type int which represents the element index being drawn.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.AlwaysAddDefaultValue">
<summary>
If true, object/type pickers will never be shown when the list add button is clicked, and default(T) will always be added instantly instead, where T is the element type of the list.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ListDrawerSettingsAttribute.AddCopiesLastElement">
<summary>
Whether adding a new element should copy the last element. False by default.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ShowPaging">
<summary>
Override the default setting specified in the Advanced Odin Preferences window and explicitly tell whether paging should be enabled or not.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.DraggableItems">
<summary>
Override the default setting specified in the Advanced Odin Preferences window and explicitly tell whether items should be draggable or not.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.NumberOfItemsPerPage">
<summary>
Override the default setting specified in the Advanced Odin Preferences window and explicitly tells how many items each page should contain.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.IsReadOnly">
<summary>
Mark a list as read-only. This removes all editing capabilities from the list such as Add, Drag and delete,
but without disabling GUI for each element drawn as otherwise would be the case if the <see cref="T:Sirenix.OdinInspector.ReadOnlyAttribute"/> was used.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ShowItemCount">
<summary>
Override the default setting specified in the Advanced Odin Preferences window and explicitly tell whether or not item count should be shown.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.Expanded">
<summary>
Override the default setting specified in the Advanced Odin Preferences window and explicitly tell whether or not the list should be expanded or collapsed by default.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ShowIndexLabels">
<summary>
If true, a label is drawn for each element which shows the index of the element.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.OnTitleBarGUI">
<summary>
Use this to inject custom GUI into the title-bar of the list.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.PagingHasValue">
<summary>
Whether the Paging property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ShowItemCountHasValue">
<summary>
Whether the ShowItemCount property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.NumberOfItemsPerPageHasValue">
<summary>
Whether the NumberOfItemsPerPage property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.DraggableHasValue">
<summary>
Whether the Draggable property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.IsReadOnlyHasValue">
<summary>
Whether the IsReadOnly property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ExpandedHasValue">
<summary>
Whether the Expanded property is set.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ListDrawerSettingsAttribute.ShowIndexLabelsHasValue">
<summary>
Whether the ShowIndexLabels property is set.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.MaxValueAttribute">
<summary>
<para>MaxValue is used on primitive fields. It caps value of the field to a maximum value.</para>
<para>Use this to define a maximum value for the field.</para>
</summary>
<remarks>
<note type="note">Note that this attribute only works in the editor! Values changed from scripting will not be capped at a maximum.</note>
</remarks>
<example>
<para>The following example shows a component where a speed value must be less than or equal to 200.</para>
<code>
public class Car : MonoBehaviour
{
// The speed of the car must be less than or equal to 200.
[MaxValue(200)]
public float Speed;
}
</code>
</example>
<example>
<para>The following example shows how MaxValue can be combined with <see cref="T:Sirenix.OdinInspector.MinValueAttribute"/>.</para>
<code>
public class Health : MonoBehaviour
{
// The speed value must be between 0 and 200.
[MinValue(0), MaxValue(200)]
public float Speed;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.MinValueAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.MaxValueAttribute.MaxValue">
<summary>
The maximum value for the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MaxValueAttribute.Expression">
<summary>
The string with which to resolve a maximum value. This could be a field, property or method name, or an expression.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.MaxValueAttribute.#ctor(System.Double)">
<summary>
Sets a maximum value for the property in the inspector.
</summary>
<param name="maxValue">The max value.</param>
</member>
<member name="M:Sirenix.OdinInspector.MaxValueAttribute.#ctor(System.String)">
<summary>
Sets a maximum value for the property in the inspector.
</summary>
<param name="expression">The string with which to resolve a maximum value. This could be a field, property or method name, or an expression.</param>
</member>
<member name="T:Sirenix.OdinInspector.MinValueAttribute">
<summary>
<para>MinValue is used on primitive fields. It caps value of the field to a minimum value.</para>
<para>Use this to define a minimum value for the field.</para>
</summary>
<remarks>
<note type="note">Note that this attribute only works in the editor! Values changed from scripting will not be capped at a minimum.</note>
</remarks>
<example>
<para>The following example shows a player component that must have at least 1 life.</para>
<code>
public class Player : MonoBehaviour
{
// The life value must be set to at least 1.
[MinValue(1)]
public int Life;
}
</code>
</example>
<example>
<para>The following example shows how MinValue can be combined with <see cref="T:Sirenix.OdinInspector.MaxValueAttribute"/></para>
<code>
public class Health : MonoBehaviour
{
// The health value must be between 0 and 100.
[MinValue(0), MaxValue(100)]
public float Health;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.MaxValueAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.MinValueAttribute.MinValue">
<summary>
The minimum value for the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.MinValueAttribute.Expression">
<summary>
The string with which to resolve a minimum value. This could be a field, property or method name, or an expression.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.MinValueAttribute.#ctor(System.Double)">
<summary>
Sets a minimum value for the property in the inspector.
</summary>
<param name="minValue">The minimum value.</param>
</member>
<member name="M:Sirenix.OdinInspector.MinValueAttribute.#ctor(System.String)">
<summary>
Sets a minimum value for the property in the inspector.
</summary>
<param name="expression">The string with which to resolve a minimum value. This could be a field, property or method name, or an expression.</param>
</member>
<member name="T:Sirenix.OdinInspector.MultiLinePropertyAttribute">
<summary>
<para>MultiLineProperty is used on any string property.</para>
<para>Use this to allow users to edit strings in a multi line textbox.</para>
</summary>
<remarks>
<para>MultiLineProperty is similar to Unity's <see cref="T:UnityEngine.MultilineAttribute"/> but can be applied to both fields and properties.</para>
</remarks>
<example>
<para>The following example shows how MultiLineProperty is applied to properties.</para>
<code>
public class MyComponent : MonoBehaviour
{
[MultiLineProperty]
public string MyString;
[ShowInInspector, MultiLineProperty(10)]
public string PropertyString;
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.MultiLinePropertyAttribute.Lines">
<summary>
The number of lines for the text box.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.MultiLinePropertyAttribute.#ctor(System.Int32)">
<summary>
Makes a multiline textbox for editing strings.
</summary>
<param name="lines">The number of lines for the text box.</param>
</member>
<member name="T:Sirenix.OdinInspector.PropertyTooltipAttribute">
<summary>
<para>PropertyTooltip is used on any property, and creates tooltips for when hovering the property in the inspector.</para>
<para>Use this to explain the purpose, or how to use a property.</para>
</summary>
<remarks>
<para>This is similar to Unity's <see cref="T:UnityEngine.TooltipAttribute"/> but can be applied to both fields and properties.</para>
</remarks>
<example>
<para>The following example shows how PropertyTooltip is applied to various properties.</para>
<code>
public class MyComponent : MonoBehaviour
{
[PropertyTooltip("This is an int property.")]
public int MyField;
[ShowInInspector, PropertyTooltip("This is another int property.")]
public int MyProperty { get; set; }
}
</code>
</example>
<seealso cref="T:UnityEngine.TooltipAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertySpaceAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyRangeAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.PropertyOrderAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.PropertyTooltipAttribute.Tooltip">
<summary>
The message shown in the tooltip.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertyTooltipAttribute.#ctor(System.String)">
<summary>
Adds a tooltip to the property in the inspector.
</summary>
<param name="tooltip">The message shown in the tooltip.</param>
</member>
<member name="T:Sirenix.OdinInspector.ReadOnlyAttribute">
<summary>
<para>ReadOnly is used on any property, and disabled the property from being changed in the inspector.</para>
<para>Use this for when you want to see the value of a property in the inspector, but don't want it to be changed.</para>
</summary>
<remarks>
<note type="note">This attribute only affects the inspector! Values can still be changed by script.</note>
</remarks>
<example>
<para>The following example shows how a field can be displayed in the editor, but not be editable.</para>
<code>
public class Health : MonoBehaviour
{
public int MaxHealth;
[ReadOnly]
public int CurrentHealth;
}
</code>
</example>
<example>
<para>ReadOnly can also be combined with <see cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>.</para>
<code>
public class Health : MonoBehaviour
{
public int MaxHealth;
[ShowInInspector, ReadOnly]
private int currentHealth;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ShowInInspectorAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.OnInspectorGUIAttribute">
<summary>
<para>OnInspectorGUI is used on any property, and will call the specified function whenever the inspector code is running.</para>
<para>Use this to create custom inspector GUI for an object.</para>
</summary>
<example>
<para></para>
<code>
public MyComponent : MonoBehaviour
{
[OnInspectorGUI]
private void MyInspectorGUI()
{
GUILayout.Label("Label drawn from callback");
}
}
</code>
</example>
<example>
<para>The following example shows how a callback can be set before another property.</para>
<code>
public MyComponent : MonoBehaviour
{
[OnInspectorGUI("MyInspectorGUI", false)]
public int MyField;
private void MyInspectorGUI()
{
GUILayout.Label("Label before My Field property");
}
}
</code>
</example>
<example>
<para>The following example shows how callbacks can be added both before and after a property.</para>
<code>
public MyComponent : MonoBehaviour
{
[OnInspectorGUI("GUIBefore", "GUIAfter")]
public int MyField;
private void GUIBefore()
{
GUILayout.Label("Label before My Field property");
}
private void GUIAfter()
{
GUILayout.Label("Label after My Field property");
}
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.OnInspectorGUIAttribute.Prepend">
<summary>
The resolved action string that defines the action to be invoked before the property is drawn, if any.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnInspectorGUIAttribute.Append">
<summary>
The resolved action string that defines the action to be invoked after the property is drawn, if any.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnInspectorGUIAttribute.PrependMethodName">
<summary>
The name of the method to be called before the property is drawn, if any. Obsolete; use the Prepend member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnInspectorGUIAttribute.AppendMethodName">
<summary>
The name of the method to be called after the property is drawn, if any. Obsolete; use the Append member instead.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorGUIAttribute.#ctor">
<summary>
Calls a function decorated with this attribute, when the inspector is being drawn.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorGUIAttribute.#ctor(System.String,System.Boolean)">
<summary>
Adds callbacks to the specified action when the property is being drawn.
</summary>
<param name="action">The resolved action string that defines the action to be invoked.</param>
<param name="append">If <c>true</c> the method will be called after the property has been drawn. Otherwise the method will be called before.</param>
</member>
<member name="M:Sirenix.OdinInspector.OnInspectorGUIAttribute.#ctor(System.String,System.String)">
<summary>
Adds callbacks to the specified actions when the property is being drawn.
</summary>
<param name="prepend">The resolved action string that defines the action to be invoked before the property is drawn, if any.</param>
<param name="append">The resolved action string that defines the action to be invoked after the property is drawn, if any.</param>
</member>
<member name="T:Sirenix.OdinInspector.OnValueChangedAttribute">
<summary>
<para>
OnValueChanged works on properties and fields, and calls the specified function
whenever the value has been changed via the inspector.
</para>
</summary>
<remarks>
<note type="note">Note that this attribute only works in the editor! Properties changed by script will not call the function.</note>
</remarks>
<example>
<para>The following example shows how OnValueChanged is used to provide a callback for a property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[OnValueChanged("MyCallback")]
public int MyInt;
private void MyCallback()
{
// ..
}
}
</code>
</example>
<example>
<para>The following example show how OnValueChanged can be used to get a component from a prefab property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[OnValueChanged("OnPrefabChange")]
public GameObject MyPrefab;
// RigidBody component of MyPrefab.
[SerializeField, HideInInspector]
private RigidBody myPrefabRigidbody;
private void OnPrefabChange()
{
if(MyPrefab != null)
{
myPrefabRigidbody = MyPrefab.GetComponent<Rigidbody>();
}
else
{
myPrefabRigidbody = null;
}
}
}
</code>
</example>
</member>
<member name="P:Sirenix.OdinInspector.OnValueChangedAttribute.MethodName">
<summary>
Name of callback member function. Obsolete; use the Action member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnValueChangedAttribute.Action">
<summary>
A resolved string that defines the action to perform when the value is changed, such as an expression or method invocation.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnValueChangedAttribute.IncludeChildren">
<summary>
Whether to perform the action when a child value of the property is changed.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.OnValueChangedAttribute.InvokeOnUndoRedo">
<summary>
Whether to perform the action when an undo or redo event occurs via UnityEditor.Undo.undoRedoPerformed. True by default.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.OnValueChangedAttribute.#ctor(System.String,System.Boolean)">
<summary>
Adds a callback for when the property's value is changed.
</summary>
<param name="action">A resolved string that defines the action to perform when the value is changed, such as an expression or method invocation.</param>
<param name="includeChildren">Whether to perform the action when a child value of the property is changed.</param>
</member>
<member name="T:Sirenix.OdinInspector.PropertyGroupAttribute">
<summary>
<para>Attribute to derive from if you wish to create a new property group type, such as box groups or tab groups.</para>
<note type="note">Note that this attribute has special behaviour for "combining" several attributes into one, as one group,
may be declared across attributes in several members, completely out of order. See <see cref="M:Sirenix.OdinInspector.PropertyGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)"/>.</note>
</summary>
<remarks>
<para>All group attributes for a group with the same name (and of the same attribute type) are combined into a single representative group attribute using the <see cref="M:Sirenix.OdinInspector.PropertyGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)"/> method, which is called by the <see cref="M:Sirenix.OdinInspector.PropertyGroupAttribute.Combine(Sirenix.OdinInspector.PropertyGroupAttribute)"/> method.</para>
<para>This behaviour is a little unusual, but it is important that you understand it when creating groups with many custom parameters that may have to be combined.</para>
</remarks>
<example>
<para>This example shows how <see cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/> could be implemented.</para>
<code>
[AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = true)]
public class BoxGroupAttribute : PropertyGroupAttribute
{
public string Label { get; private set; }
public bool ShowLabel { get; private set; }
public bool CenterLabel { get; private set; }
public BoxGroupAttribute(string group, bool showLabel = true, bool centerLabel = false, float order = 0)
: base(group, order)
{
this.Label = group;
this.ShowLabel = showLabel;
this.CenterLabel = centerLabel;
}
protected override void CombineValuesWith(PropertyGroupAttribute other)
{
// The given attribute parameter is *guaranteed* to be of type BoxGroupAttribute.
var attr = other as BoxGroupAttribute;
// If this attribute has no label, we the other group's label, thus preserving the label across combines.
if (this.Label == null)
{
this.Label = attr.Label;
}
// Combine ShowLabel and CenterLabel parameters.
this.ShowLabel |= attr.ShowLabel;
this.CenterLabel |= attr.CenterLabel;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ButtonGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.FoldoutGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.TabGroupAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.GroupID">
<summary>
The ID used to grouping properties together.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.GroupName">
<summary>
The name of the group. This is the last part of the group ID if there is a path, otherwise it is just the group ID.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.Order">
<summary>
The order of the group.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.HideWhenChildrenAreInvisible">
<summary>
Whether to hide the group by default when all its children are not visible. True by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.VisibleIf">
<summary>
If not null, this resolved string controls the group's visibility. Note that if <see cref="F:Sirenix.OdinInspector.PropertyGroupAttribute.HideWhenChildrenAreInvisible"/> is true, there must be *both* a visible child *and* this condition must be true, before the group is shown.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.PropertyGroupAttribute.AnimateVisibility">
<summary>
Whether to animate the visibility changes of this group or make the visual transition instantly. True by default.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertyGroupAttribute.#ctor(System.String,System.Single)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.PropertyGroupAttribute"/> class.
</summary>
<param name="groupId">The group identifier.</param>
<param name="order">The group order.</param>
</member>
<member name="M:Sirenix.OdinInspector.PropertyGroupAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.PropertyGroupAttribute"/> class.
</summary>
<param name="groupId">The group identifier.</param>
</member>
<member name="M:Sirenix.OdinInspector.PropertyGroupAttribute.Combine(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
<para>Combines this attribute with another attribute of the same type.
This method invokes the virtual <see cref="M:Sirenix.OdinInspector.PropertyGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)"/> method to invoke custom combine logic.</para>
<para>All group attributes are combined to one attribute used by a single OdinGroupDrawer.</para>
<para>Example: <code>protected override void CombineValuesWith(PropertyGroupAttribute other) { this.Title = this.Title ?? (other as MyGroupAttribute).Title; }</code></para>
</summary>
<param name="other">The attribute to combine with.</param>
<returns>The instance that the method was invoked on.</returns>
<exception cref="T:System.ArgumentNullException">The argument 'other' was null.</exception>
<exception cref="T:System.ArgumentException">
Attributes to combine are not of the same type.
or
PropertyGroupAttributes to combine must have the same group id.
</exception>
</member>
<member name="M:Sirenix.OdinInspector.PropertyGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
<para>Override this method to add custom combine logic to your group attribute. This method determines how your group's parameters combine when spread across multiple attribute declarations in the same class.</para>
<para>Remember, in .NET, member order is not guaranteed, so you never know which order your attributes will be combined in.</para>
</summary>
<param name="other">The attribute to combine with. This parameter is guaranteed to be of the correct attribute type.</param>
<example>
<para>This example shows how <see cref="T:Sirenix.OdinInspector.BoxGroupAttribute"/> attributes are combined.</para>
<code>
protected override void CombineValuesWith(PropertyGroupAttribute other)
{
// The given attribute parameter is *guaranteed* to be of type BoxGroupAttribute.
var attr = other as BoxGroupAttribute;
// If this attribute has no label, we the other group's label, thus preserving the label across combines.
if (this.Label == null)
{
this.Label = attr.Label;
}
// Combine ShowLabel and CenterLabel parameters.
this.ShowLabel |= attr.ShowLabel;
this.CenterLabel |= attr.CenterLabel;
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.PropertyOrderAttribute">
<summary>
<para>PropertyOrder is used on any property, and allows for ordering of properties.</para>
<para>Use this to define in which order your properties are shown.</para>
</summary>
<remarks>
<para>Lower order values will be drawn before higher values.</para>
<note type="note">There is unfortunately no way of ensuring that properties are in the same order, as they appear in your class. PropertyOrder overcomes this.</note>
</remarks>
<example>
<para>The following example shows how PropertyOrder is used to order properties in the inspector.</para>
<code>
public class MyComponent : MonoBehaviour
{
[PropertyOrder(1)]
public int MySecondProperty;
[PropertyOrder(-1)]
public int MyFirstProperty;
}
</code>
</example>
</member>
<member name="F:Sirenix.OdinInspector.PropertyOrderAttribute.Order">
<summary>
The order for the property.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertyOrderAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.PropertyOrderAttribute"/> class.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.PropertyOrderAttribute.#ctor(System.Single)">
<summary>
Defines a custom order for the property.
</summary>
<param name="order">The order for the property.</param>
</member>
<member name="T:Sirenix.OdinInspector.RequiredAttribute">
<summary>
<para>Required is used on any object property, and draws a message in the inspector if the property is missing.</para>
<para>Use this to clearly mark fields as necessary to the object.</para>
</summary>
<example>
<para>The following example shows different uses of the Required attribute.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Required]
public GameObject MyPrefab;
[Required(InfoMessageType.Warning)]
public Texture2D MyTexture;
[Required("MyMesh is nessessary for this component.")]
public Mesh MyMesh;
[Required("MyTransform might be important.", InfoMessageType.Info)]
public Transform MyTransform;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.InfoBoxAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ValidateInputAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.RequiredAttribute.ErrorMessage">
<summary>
The message of the info box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.RequiredAttribute.MessageType">
<summary>
The type of the info box.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.RequiredAttribute.#ctor">
<summary>
Adds an error box to the inspector, if the property is missing.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.RequiredAttribute.#ctor(System.String,Sirenix.OdinInspector.InfoMessageType)">
<summary>
Adds an info box to the inspector, if the property is missing.
</summary>
<param name="errorMessage">The message to display in the error box.</param>
<param name="messageType">The type of info box to draw.</param>
</member>
<member name="M:Sirenix.OdinInspector.RequiredAttribute.#ctor(System.String)">
<summary>
Adds an error box to the inspector, if the property is missing.
</summary>
<param name="errorMessage">The message to display in the error box.</param>
</member>
<member name="M:Sirenix.OdinInspector.RequiredAttribute.#ctor(Sirenix.OdinInspector.InfoMessageType)">
<summary>
Adds an info box to the inspector, if the property is missing.
</summary>
<param name="messageType">The type of info box to draw.</param>
</member>
<member name="T:Sirenix.OdinInspector.SceneObjectsOnlyAttribute">
<summary>
<para>SceneObjectsOnly is used on object properties, and restricts the property to scene objects, and not project assets.</para>
<para>Use this when you want to ensure an object is a scene object, and not from a project asset.</para>
</summary>
<example>
<para>The following example shows a component with a game object property, that must be from a scene, and not a prefab asset.</para>
<code>
public MyComponent : MonoBehaviour
{
[SceneObjectsOnly]
public GameObject MyPrefab;
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.AssetsOnlyAttribute"/>
</member>
<member name="T:Sirenix.OdinInspector.ValueDropdownAttribute">
<summary>
<para>ValueDropdown is used on any property and creates a dropdown with configurable options.</para>
<para>Use this to give the user a specific set of options to select from.</para>
</summary>
<remarks>
<note type="note">Due to a bug in Unity, enums will sometimes not work correctly. The last example shows how this can be fixed.</note>
</remarks>
<example>
<para>The following example shows a how the ValueDropdown can be used on an int property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ValueDropdown("myValues")]
public int MyInt;
// The selectable values for the dropdown.
private int[] myValues = { 1, 2, 3 };
}
</code>
</example>
<example>
<para>The following example shows how ValueDropdownList can be used for objects, that do not implement a usable ToString.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ValueDropdown("myVectorValues")]
public Vector3 MyVector;
// The selectable values for the dropdown, with custom names.
private ValueDropdownList<Vector3> myVectorValues = new ValueDropdownList<Vector3>()
{
{"Forward", Vector3.forward },
{"Back", Vector3.back },
{"Up", Vector3.up },
{"Down", Vector3.down },
{"Right", Vector3.right },
{"Left", Vector3.left },
};
}
</code>
</example>
<example>
<para>The following example shows how the ValueDropdown can on any member that implements IList.</para>
<code>
public class MyComponent : MonoBehaviour
{
// Member field of type float[].
private float[] valuesField;
[ValueDropdown("valuesField")]
public float MyFloat;
// Member property of type List<thing>.
private List<string> ValuesProperty { get; set; }
[ValueDropdown("ValuesProperty")]
public string MyString;
// Member function that returns an object of type IList.
private IList<ValueDropdownItem<int>> ValuesFunction()
{
return new ValueDropdownList<int>
{
{ "The first option", 1 },
{ "The second option", 2 },
{ "The third option", 3 },
};
}
[ValueDropdown("ValuesFunction")]
public int MyInt;
}
</code>
</example>
<example>
<para>Due to a bug in Unity, enums member arrays will in some cases appear as empty. This example shows how you can get around that.</para>
<code>
public class MyComponent : MonoBehaviour
{
// Make the field static.
private static MyEnum[] MyStaticEnumArray = MyEnum[] { ... };
// Force Unity to serialize the field, and hide the property from the inspector.
[SerializeField, HideInInspector]
private MyEnum MySerializedEnumArray = MyEnum[] { ... };
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ValueDropdownList`1"/>
</member>
<member name="P:Sirenix.OdinInspector.ValueDropdownAttribute.MemberName">
<summary>
Name of any field, property or method member that implements IList. E.g. arrays or Lists. Obsolete; use the ValuesGetter member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.ValuesGetter">
<summary>
A resolved string that should evaluate to a value that is assignable to IList; e.g, arrays and lists are compatible.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.NumberOfItemsBeforeEnablingSearch">
<summary>
The number of items before enabling search. Default is 10.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.IsUniqueList">
<summary>
False by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DrawDropdownForListElements">
<summary>
True by default. If the ValueDropdown attribute is applied to a list, then disabling this,
will render all child elements normally without using the ValueDropdown. The ValueDropdown will
still show up when you click the add button on the list drawer, unless <see cref="F:Sirenix.OdinInspector.ValueDropdownAttribute.DisableListAddButtonBehaviour"/> is true.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DisableListAddButtonBehaviour">
<summary>
False by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.ExcludeExistingValuesInList">
<summary>
If the ValueDropdown attribute is applied to a list, and <see cref="F:Sirenix.OdinInspector.ValueDropdownAttribute.IsUniqueList"/> is set to true, then enabling this,
will exclude existing values, instead of rendering a checkbox indicating whether the item is already included or not.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.ExpandAllMenuItems">
<summary>
If the dropdown renders a tree-view, then setting this to true will ensure everything is expanded by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.AppendNextDrawer">
<summary>
If true, instead of replacing the drawer with a wide dropdown-field, the dropdown button will be a little button, drawn next to the other drawer.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DisableGUIInAppendedDrawer">
<summary>
Disables the the GUI for the appended drawer. False by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DoubleClickToConfirm">
<summary>
By default, a single click selects and confirms the selection.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.FlattenTreeView">
<summary>
By default, the dropdown will create a tree view.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DropdownWidth">
<summary>
Gets or sets the width of the dropdown. Default is zero.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DropdownHeight">
<summary>
Gets or sets the height of the dropdown. Default is zero.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.DropdownTitle">
<summary>
Gets or sets the title for the dropdown. Null by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.SortDropdownItems">
<summary>
False by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownAttribute.HideChildProperties">
<summary>
Whether to draw all child properties in a foldout.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownAttribute.#ctor(System.String)">
<summary>
Creates a dropdown menu for a property.
</summary>
<param name="valuesGetter">A resolved string that should evaluate to a value that is assignable to IList; e.g, arrays and lists are compatible.</param>
</member>
<member name="T:Sirenix.OdinInspector.IValueDropdownItem">
<summary>
</summary>
</member>
<member name="M:Sirenix.OdinInspector.IValueDropdownItem.GetText">
<summary>
Gets the label for the dropdown item.
</summary>
<returns>The label text for the item.</returns>
</member>
<member name="M:Sirenix.OdinInspector.IValueDropdownItem.GetValue">
<summary>
Gets the value of the dropdown item.
</summary>
<returns>The value for the item.</returns>
</member>
<member name="T:Sirenix.OdinInspector.ValueDropdownList`1">
<summary>
Use this with <see cref="T:Sirenix.OdinInspector.ValueDropdownAttribute"/> to specify custom names for values.
</summary>
<typeparam name="T">The type of the value.</typeparam>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownList`1.Add(System.String,`0)">
<summary>
Adds the specified value with a custom name.
</summary>
<param name="text">The name of the item.</param>
<param name="value">The value.</param>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownList`1.Add(`0)">
<summary>
Adds the specified value.
</summary>
<param name="value">The value.</param>
</member>
<member name="T:Sirenix.OdinInspector.ValueDropdownItem">
<summary>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownItem.Text">
<summary>
The name of the item.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownItem.Value">
<summary>
The value of the item.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem.#ctor(System.String,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.ValueDropdownItem`1" /> class.
</summary>
<param name="text">The text to display for the dropdown item.</param>
<param name="value">The value for the dropdown item.</param>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem.ToString">
<summary>
The name of this item.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem.Sirenix#OdinInspector#IValueDropdownItem#GetText">
<summary>
Gets the text.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem.Sirenix#OdinInspector#IValueDropdownItem#GetValue">
<summary>
Gets the value.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ValueDropdownItem`1">
<summary>
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownItem`1.Text">
<summary>
The name of the item.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValueDropdownItem`1.Value">
<summary>
The value of the item.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem`1.#ctor(System.String,`0)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.ValueDropdownItem`1" /> class.
</summary>
<param name="text">The text to display for the dropdown item.</param>
<param name="value">The value for the dropdown item.</param>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem`1.Sirenix#OdinInspector#IValueDropdownItem#GetText">
<summary>
Gets the text.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem`1.Sirenix#OdinInspector#IValueDropdownItem#GetValue">
<summary>
Gets the value.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValueDropdownItem`1.ToString">
<summary>
The name of this item.
</summary>
</member>
<member name="T:Sirenix.OdinInspector.ShowInInspectorAttribute">
<summary>
<para>ShowInInspector is used on any member, and shows the value in the inspector. Note that the value being shown due to this attribute DOES NOT mean that the value is being serialized.</para>
</summary>
<remarks>
<para>This can for example be combined with <see cref="T:Sirenix.OdinInspector.ReadOnlyAttribute"/> to allow for live debugging of values.</para>
<note type="note"></note>
</remarks>
<example>
<para>The following example shows how ShowInInspector is used to show properties in the inspector, that otherwise wouldn't.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ShowInInspector]
private int myField;
[ShowInInspector]
public int MyProperty { get; set; }
}
</code>
</example>
</member>
<member name="T:Sirenix.OdinInspector.TabGroupAttribute">
<summary>
<para>TabGroup is used on any property, and organizes properties into different tabs.</para>
<para>Use this to organize different value to make a clean and easy to use inspector.</para>
</summary>
<remarks>
<para>Use groups to create multiple tab groups, each with multiple tabs and even sub tabs.</para>
</remarks>
<example>
<para>The following example shows how to create a tab group with two tabs.</para>
<code>
public class MyComponent : MonoBehaviour
{
[TabGroup("First")]
public int MyFirstInt;
[TabGroup("First")]
public int AnotherInt;
[TabGroup("Second")]
public int MySecondInt;
}
</code>
</example>
<example>
<para>The following example shows how multiple groups of tabs can be created.</para>
<code>
public class MyComponent : MonoBehaviour
{
[TabGroup("A", "FirstGroup")]
public int FirstGroupA;
[TabGroup("B", "FirstGroup")]
public int FirstGroupB;
// The second tab group has been configured to have constant height across all tabs.
[TabGroup("A", "SecondGroup", true)]
public int SecondgroupA;
[TabGroup("B", "SecondGroup")]
public int SecondGroupB;
[TabGroup("B", "SecondGroup")]
public int AnotherInt;
}
</code>
</example>
<example>
<para>This example demonstrates how multiple tabs groups can be combined to create tabs in tabs.</para>
<code>
public class MyComponent : MonoBehaviour
{
[TabGroup("ParentGroup", "First Tab")]
public int A;
[TabGroup("ParentGroup", "Second Tab")]
public int B;
// Specify 'First Tab' as a group, and another child group to the 'First Tab' group.
[TabGroup("ParentGroup/First Tab/InnerGroup", "Inside First Tab A")]
public int C;
[TabGroup("ParentGroup/First Tab/InnerGroup", "Inside First Tab B")]
public int D;
[TabGroup("ParentGroup/Second Tab/InnerGroup", "Inside Second Tab")]
public int E;
}
</code>
</example>
<seealso cref="!:TabListAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TabGroupAttribute.DEFAULT_NAME">
<summary>
The default tab group name which is used when the single-parameter constructor is called.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TabGroupAttribute.TabName">
<summary>
Name of the tab.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TabGroupAttribute.UseFixedHeight">
<summary>
Should this tab be the same height as the rest of the tab group.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TabGroupAttribute.Paddingless">
<summary>
If true, the content of each page will not be contained in any box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TabGroupAttribute.HideTabGroupIfTabGroupOnlyHasOneTab">
<summary>
If true, the tab group will be hidden if it only contains one tab.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TabGroupAttribute.#ctor(System.String,System.Boolean,System.Single)">
<summary>
Organizes the property into the specified tab in the default group.
Default group name is '_DefaultTabGroup'
</summary>
<param name="tab">The tab.</param>
<param name="useFixedHeight">if set to <c>true</c> [use fixed height].</param>
<param name="order">The order.</param>
</member>
<member name="M:Sirenix.OdinInspector.TabGroupAttribute.#ctor(System.String,System.String,System.Boolean,System.Single)">
<summary>
Organizes the property into the specified tab in the specified group.
</summary>
<param name="group">The group to attach the tab to.</param>
<param name="tab">The name of the tab.</param>
<param name="useFixedHeight">Set to true to have a constant height across the entire tab group.</param>
<param name="order">The order of the group.</param>
</member>
<member name="P:Sirenix.OdinInspector.TabGroupAttribute.Tabs">
<summary>
Name of all tabs in this group.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TabGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines the tab group with another group.
</summary>
<param name="other">The other group.</param>
</member>
<member name="M:Sirenix.OdinInspector.TabGroupAttribute.Sirenix#OdinInspector#Internal#ISubGroupProviderAttribute#GetSubGroupAttributes">
<summary>
Not yet documented.
</summary>
<returns>Not yet documented.</returns>
</member>
<member name="M:Sirenix.OdinInspector.TabGroupAttribute.Sirenix#OdinInspector#Internal#ISubGroupProviderAttribute#RepathMemberAttribute(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Not yet documented.
</summary>
<returns>Not yet documented.</returns>
</member>
<member name="T:Sirenix.OdinInspector.TitleAttribute">
<summary>
<para>Title is used to make a bold header above a property.</para>
</summary>
<example>
The following example shows how Title is used on different properties.
<code>
public class TitleExamples : MonoBehaviour
{
[Title("Titles and Headers")]
[InfoBox(
"The Title attribute has the same purpose as Unity's Header attribute," +
"but it also supports properties, and methods." +
"\n\nTitle also offers more features such as subtitles, options for horizontal underline, bold text and text alignment." +
"\n\nBoth attributes, with Odin, supports either static strings, or refering to members strings by adding a $ in front.")]
public string MyTitle = "My Dynamic Title";
public string MySubtitle = "My Dynamic Subtitle";
[Title("Static title")]
public int C;
public int D;
[Title("Static title", "Static subtitle")]
public int E;
public int F;
[Title("$MyTitle", "$MySubtitle")]
public int G;
public int H;
[Title("Non bold title", "$MySubtitle", bold: false)]
public int I;
public int J;
[Title("Non bold title", "With no line seperator", horizontalLine: false, bold: false)]
public int K;
public int L;
[Title("$MyTitle", "$MySubtitle", TitleAlignments.Right)]
public int M;
public int N;
[Title("$MyTitle", "$MySubtitle", TitleAlignments.Centered)]
public int O;
public int P;
[Title("$Combined", titleAlignment: TitleAlignments.Centered)]
public int Q;
public int R;
[ShowInInspector]
[Title("Title on a Property")]
public int S { get; set; }
[Title("Title on a Method")]
[Button]
public void DoNothing()
{ }
public string Combined { get { return this.MyTitle + " - " + this.MySubtitle; } }
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ButtonAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.LabelTextAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.TitleAttribute.Title">
<summary>
The title displayed above the property in the inspector.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAttribute.Subtitle">
<summary>
Optional subtitle.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAttribute.Bold">
<summary>
If <c>true</c> the title will be displayed with a bold font.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAttribute.HorizontalLine">
<summary>
Gets a value indicating whether or not to draw a horizontal line below the title.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.TitleAttribute.TitleAlignment">
<summary>
Title alignment.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.TitleAttribute.#ctor(System.String,System.String,Sirenix.OdinInspector.TitleAlignments,System.Boolean,System.Boolean)">
<summary>
Creates a title above any property in the inspector.
</summary>
<param name="title">The title displayed above the property in the inspector.</param>
<param name="subtitle">Optional subtitle</param>
<param name="titleAlignment">Title alignment</param>
<param name="horizontalLine">Horizontal line</param>
<param name="bold">If <c>true</c> the title will be drawn with a bold font.</param>
</member>
<member name="T:Sirenix.OdinInspector.ToggleAttribute">
<summary>
<para>Toggle is used on any field or property, and allows to enable or disable the property in the inspector.</para>
<para>Use this to create a property that can be turned off or on.</para>
</summary>
<remarks>
<note type="note">Toggle does current not support any static members for toggling.</note>
</remarks>
<example>
<para>The following example shows how Toggle is used to create a toggleable property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Toggle("Enabled")]
public MyToggleable MyToggler = new MyToggleable();
}
public class MyToggleable
{
public bool Enabled;
public int MyValue;
}
</code>
</example>
<seealso cref="!:ToggleListAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.ToggleAttribute.ToggleMemberName">
<summary>
Name of any bool field or property to enable or disable the object.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ToggleAttribute.CollapseOthersOnExpand">
<summary>
If true, all other open toggle groups will collapse once another one opens.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ToggleAttribute.#ctor(System.String)">
<summary>
Create a togglable property in the inspector.
</summary>
<param name="toggleMemberName">Name of any bool field or property to enable or disable the object.</param>
</member>
<member name="T:Sirenix.OdinInspector.ToggleGroupAttribute">
<summary>
<para>ToggleGroup is used on any field, and create a toggleable group of options.</para>
<para>Use this to create options that can be enabled or disabled.</para>
</summary>
<remarks>
<para>The <see cref="P:Sirenix.OdinInspector.ToggleGroupAttribute.ToggleMemberName"/> functions as the ID for the ToggleGroup, and therefore all members of a toggle group must specify the same toggle member.</para>
<note note="Note">This attribute does not support static members!</note>
</remarks>
<example>
<para>The following example shows how ToggleGroup is used to create two separate toggleable groups.</para>
<code>
public class MyComponent : MonoBehaviour
{
// This attribute has a title specified for the group. The title only needs to be applied to a single attribute for a group.
[ToggleGroup("FirstToggle", order: -1, groupTitle: "First")]
public bool FirstToggle;
[ToggleGroup("FirstToggle")]
public int MyInt;
// This group specifies a member string as the title of the group. A property or a function can also be used.
[ToggleGroup("SecondToggle", titleStringMemberName: "SecondGroupTitle")]
public bool SecondToggle { get; set; }
[ToggleGroup("SecondToggle")]
public float MyFloat;
[HideInInspector]
public string SecondGroupTitle = "Second";
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.ToggleAttribute"/>
<seealso cref="!:ToggleListAttribute"/>"/>
</member>
<member name="F:Sirenix.OdinInspector.ToggleGroupAttribute.ToggleGroupTitle">
<summary>
Title of the toggle group in the inspector.
If <c>null</c> <see cref="P:Sirenix.OdinInspector.ToggleGroupAttribute.ToggleMemberName"/> will be used instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ToggleGroupAttribute.CollapseOthersOnExpand">
<summary>
If true, all other open toggle groups will collapse once another one opens.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ToggleGroupAttribute.#ctor(System.String,System.Single,System.String)">
<summary>
Creates a ToggleGroup. See <see cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>.
</summary>
<param name="toggleMemberName">Name of any bool field or property to enable or disable the ToggleGroup.</param>
<param name="order">The order of the group.</param>
<param name="groupTitle">Use this to name the group differently than toggleMemberName.</param>
</member>
<member name="M:Sirenix.OdinInspector.ToggleGroupAttribute.#ctor(System.String,System.String)">
<summary>
Creates a ToggleGroup. See <see cref="T:Sirenix.OdinInspector.ToggleGroupAttribute"/>.
</summary>
<param name="toggleMemberName">Name of any bool field or property to enable or disable the ToggleGroup.</param>
<param name="groupTitle">Use this to name the group differently than toggleMemberName.</param>
</member>
<member name="M:Sirenix.OdinInspector.ToggleGroupAttribute.#ctor(System.String,System.Single,System.String,System.String)">
<summary>
Obsolete constructor overload.
</summary>
<param name="toggleMemberName">Obsolete overload.</param>
<param name="order">Obsolete overload.</param>
<param name="groupTitle">Obsolete overload.</param>
<param name="titleStringMemberName">Obsolete overload.</param>
</member>
<member name="P:Sirenix.OdinInspector.ToggleGroupAttribute.ToggleMemberName">
<summary>
Name of any bool field, property or function to enable or disable the ToggleGroup.
</summary>
</member>
<member name="P:Sirenix.OdinInspector.ToggleGroupAttribute.TitleStringMemberName">
<summary>
Name of any string field, property or function, to title the toggle group in the inspector.
If <c>null</c> <see cref="F:Sirenix.OdinInspector.ToggleGroupAttribute.ToggleGroupTitle"/> will be used instead.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ToggleGroupAttribute.CombineValuesWith(Sirenix.OdinInspector.PropertyGroupAttribute)">
<summary>
Combines the ToggleGroup with another ToggleGroup.
</summary>
<param name="other">Another ToggleGroup.</param>
</member>
<member name="T:Sirenix.OdinInspector.ValidateInputAttribute">
<summary>
<para>ValidateInput is used on any property, and allows to validate input from inspector.</para>
<para>Use this to enforce correct values.</para>
</summary>
<remarks>
<note type="note">ValidateInput refuses invalid values.</note>
<note type="note">ValidateInput only works in the editor. Values changed through scripting will not be validated.</note>
</remarks>
<example>
<para>The following examples shows how a speed value can be forced to be above 0.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ValidateInput("ValidateInput")]
public float Speed;
// Specify custom output message and message type.
[ValidateInput("ValidateInput", "Health must be more than 0!", InfoMessageType.Warning)]
public float Health;
private bool ValidateInput(float property)
{
return property > 0f;
}
}
</code>
</example>
<example>
<para>The following example shows how a static function could also be used.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ValidateInput("StaticValidateFunction")]
public int MyInt;
private static bool StaticValidateFunction(int property)
{
return property != 0;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.InfoBoxAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.RequiredAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.DefaultMessage">
<summary>
Default message for invalid values.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.MemberName">
<summary>
Name of callback function to validate input. The function must have at least one parameter of the same type as the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.Condition">
<summary>
A resolved string that should evaluate to a boolean value, and which should validate the input. Note that in expressions, the $value named parameter, and in methods, a parameter named value, can be used to get the validated value instead of referring to the value by its containing member. This makes it easier to reuse validation strings.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.MessageType">
<summary>
The type of the message.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.IncludeChildren">
<summary>
Whether to also trigger validation when changes to child values happen. This is true by default.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ValidateInputAttribute.ContinuousValidationCheck">
<summary>
If true, the validation method will not only be executed when the User has changed the value. It'll run once every frame in the inspector.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ValidateInputAttribute.#ctor(System.String,System.String,Sirenix.OdinInspector.InfoMessageType)">
<summary>
Initializes a new instance of the <see cref="T:Sirenix.OdinInspector.ValidateInputAttribute"/> class.
</summary>
<param name="condition">A resolved string that should evaluate to a boolean value, and which should validate the input. Note that in expressions, the $value named parameter, and in methods, a parameter named value, can be used to get the validated value instead of referring to the value by its containing member. This makes it easier to reuse validation strings.</param>
<param name="defaultMessage">Default message for invalid values.</param>
<param name="messageType">Type of the message.</param>
</member>
<member name="M:Sirenix.OdinInspector.ValidateInputAttribute.#ctor(System.String,System.String,Sirenix.OdinInspector.InfoMessageType,System.Boolean)">
<summary>
Obsolete. Rejecting invalid input is no longer supported. Use the other constructors instead.
</summary>
<param name="condition">Obsolete overload.</param>
<param name="message">Obsolete overload.</param>
<param name="messageType">Obsolete overload.</param>
<param name="rejectedInvalidInput">Obsolete overload.</param>
</member>
<member name="T:Sirenix.OdinInspector.ShowIfAttribute">
<summary>
<para>ShowIf is used on any property and can hide the property in the inspector.</para>
<para>Use this to hide irrelevant properties based on the current state of the object.</para>
</summary>
<example>
<para>This example shows a component with fields hidden by the state of another field.</para>
<code>
public class MyComponent : MonoBehaviour
{
public bool ShowProperties;
[ShowIf("showProperties")]
public int MyInt;
[ShowIf("showProperties", false)]
public string MyString;
public SomeEnum SomeEnumField;
[ShowIf("SomeEnumField", SomeEnum.SomeEnumMember)]
public string SomeString;
}
</code>
</example>
<example>
<para>This example shows a component with a field that is hidden when the game object is inactive.</para>
<code>
public class MyComponent : MonoBehaviour
{
[ShowIf("MyVisibleFunction")]
public int MyHideableField;
private bool MyVisibleFunction()
{
return this.gameObject.activeInHierarchy;
}
}
</code>
</example>
<seealso cref="T:Sirenix.OdinInspector.EnableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.DisableIfAttribute"/>
<seealso cref="T:Sirenix.OdinInspector.HideIfAttribute"/>
</member>
<member name="P:Sirenix.OdinInspector.ShowIfAttribute.MemberName">
<summary>
The name of a bool member field, property or method. Obsolete; use the Condition member instead.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ShowIfAttribute.Condition">
<summary>
A resolved string that defines the condition to check the value of, such as a member name or an expression.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ShowIfAttribute.Value">
<summary>
The optional condition value.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.ShowIfAttribute.Animate">
<summary>
Whether or not to slide the property in and out when the state changes.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.ShowIfAttribute.#ctor(System.String,System.Boolean)">
<summary>
Shows a property in the inspector, based on the value of a resolved string.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="animate">Whether or not to slide the property in and out when the state changes.</param>
</member>
<member name="M:Sirenix.OdinInspector.ShowIfAttribute.#ctor(System.String,System.Object,System.Boolean)">
<summary>
Shows a property in the inspector, if the resolved string evaluates to the specified value.
</summary>
<param name="condition">A resolved string that defines the condition to check the value of, such as a member name or an expression.</param>
<param name="optionalValue">Value to check against.</param>
<param name="animate">Whether or not to slide the property in and out when the state changes.</param>
</member>
<member name="T:Sirenix.OdinInspector.WrapAttribute">
<summary>
<para>Wrap is used on most primitive property, and allows for wrapping the value when it goes out of the defined range.</para>
<para>Use this when you want a value that goes around in circle, like for example an angle.</para>
</summary>
<remarks>
<note type="note">Currently unsigned primitives are not supported.</note>
</remarks>
<example>
<para>The following example show how Wrap is used on a property.</para>
<code>
public class MyComponent : MonoBehaviour
{
[Wrap(-100, 100)]
public float MyFloat;
}
</code>
</example>
<seealso cref="!:AngleWrapAttribute"/>
</member>
<member name="F:Sirenix.OdinInspector.WrapAttribute.Min">
<summary>
The lowest value for the property.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.WrapAttribute.Max">
<summary>
The highest value for the property.
</summary>
</member>
<member name="M:Sirenix.OdinInspector.WrapAttribute.#ctor(System.Double,System.Double)">
<summary>
Wraps the value of the property round when the values goes out of range.
</summary>
<param name="min">The lowest value for the property.</param>
<param name="max">The highest value for the property.</param>
</member>
<member name="T:Sirenix.OdinInspector.InfoMessageType">
<summary>
Type of info message box. This enum matches Unity's MessageType enum which could not be used since it is located in the UnityEditor assembly.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoMessageType.None">
<summary>
Generic message box with no type.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoMessageType.Info">
<summary>
Information message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoMessageType.Warning">
<summary>
Warning message box.
</summary>
</member>
<member name="F:Sirenix.OdinInspector.InfoMessageType.Error">
<summary>
Error message box.
</summary>
</member>
</members>
</doc>
|