You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/exportlegends.rst
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,10 @@ about your world so that it can be browsed with external programs like
11
11
get with vanilla export functionality, and many external tools depend on this
12
12
extra information.
13
13
14
-
By default, ``exportlegends`` hooks into the standard vanilla ``Export XML`` button and runs in the background when you click it, allowing both the vanilla export and the extended data export to execute simultaneously. You can continue to browse legends mode via the vanilla UI while the export is running.
14
+
By default, ``exportlegends`` hooks into the standard vanilla ``Export XML``
15
+
button and runs in the background when you click it, allowing both the vanilla
16
+
export and the extended data export to execute simultaneously. You can continue
17
+
to browse legends mode via the vanilla UI while the export is running.
15
18
16
19
To use:
17
20
@@ -35,7 +38,11 @@ Usage
35
38
Overlay
36
39
-------
37
40
38
-
This script also provides an overlay that is managed by the `overlay` framework.
41
+
This script also provides several overlays that are managed by the `overlay`
42
+
framework.
43
+
44
+
**exportlegends.export**
45
+
39
46
When the overlay is enabled, a toggle for exporting extended legends data will
40
47
appear below the vanilla "Export XML" button. If the toggle is enabled when the
41
48
"Export XML" button is clicked, then ``exportlegends`` will run alongside the
@@ -45,6 +52,13 @@ While the extended data is being exported, a status line will appear in place
45
52
of the toggle, reporting the current export target and the overall percent
46
53
complete.
47
54
48
-
There is an additional overlay that masks out the "Done" button while the
49
-
extended export is running. This prevents the player from exiting legends mode
50
-
before the export is complete.
55
+
**exportlegends.mask**
56
+
57
+
This overlay masks out the "Done" button while the extended export is running.
58
+
This prevents the player from accidentally exiting legends mode before the
59
+
export is complete.
60
+
61
+
**exportlegends.histfigfilter**
62
+
63
+
This overlay adds a filter widget to the Historical Figures legends page.
64
+
Clicking the widget allows you to filter the list of historical figures by race.
0 commit comments