Skip to content

Commit 67d7c13

Browse files
committed
update docs
1 parent 10abfcb commit 67d7c13

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

docs/exportlegends.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ about your world so that it can be browsed with external programs like
1111
get with vanilla export functionality, and many external tools depend on this
1212
extra information.
1313

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.
1518

1619
To use:
1720

@@ -35,7 +38,11 @@ Usage
3538
Overlay
3639
-------
3740

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+
3946
When the overlay is enabled, a toggle for exporting extended legends data will
4047
appear below the vanilla "Export XML" button. If the toggle is enabled when the
4148
"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
4552
of the toggle, reporting the current export target and the overall percent
4653
complete.
4754

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

Comments
 (0)