Add some cross-references and clean up

develop
lethosor 2020-10-20 01:18:25 -04:00
parent 2bd0e938ad
commit 26505acb70
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 15 additions and 11 deletions

@ -3687,7 +3687,7 @@ the plugin. See existing files in ``plugins/lua`` for examples.
blueprint
=========
Native functions:
Native functions provided by the `blueprint` plugin:
* ``dig(start, end, name)``
* ``build(start, end, name)``
@ -3782,7 +3782,7 @@ Or with auto_gears::
buildingplan
============
Native functions:
Native functions provided by the `buildingplan` plugin:
* ``bool isPlannableBuilding(df::building_type type)`` returns whether the building type is handled by buildingplan
* ``void addPlannedBuilding(df::building *bld)`` suspends the building jobs and adds the building to the monitor list
@ -3791,7 +3791,7 @@ Native functions:
burrows
=======
Implements extended burrow manipulations.
The `burrows` plugin implements extended burrow manipulations.
Events:
@ -4197,8 +4197,9 @@ A class with all the tcp functionality.
map-render
==========
A way to ask df to render a slice of map. This uses native df rendering function so it's highly dependant on
df settings (e.g. used tileset, colors, if using graphics or not and so on...)
A way to ask DF to render a section of the fortress mode map. This uses a native
DF rendering function so it's highly dependent on DF settings (e.g. tileset,
colors, etc.)
Functions
---------
@ -4223,8 +4224,8 @@ single Lua function, in ``hack/lua/plugins/pathable.lua``:
sort
====
Does not export any native functions as of now. Instead, it
calls lua code to perform the actual ordering of list items.
The `sort <sort>` plugin does not export any native functions as of now.
Instead, it calls Lua code to perform the actual ordering of list items.
.. _xlsxreader:

@ -37,7 +37,9 @@ For more information, see `the full Stonesense README <stonesense>`.
blueprint
=========
Exports a portion of your fortress into QuickFort style blueprint files.::
Exports a portion of your fortress into QuickFort style blueprint files.
Usage::
blueprint <x> <y> <z> <name> [dig] [build] [place] [query]
@ -781,6 +783,7 @@ Adds a :kbd:`q` menu for track stops, which is completely blank by default.
This allows you to view and/or change the track stop's friction and dump
direction settings, using the keybindings from the track stop building interface.
.. _sort:
.. _sort-items:
sort-items
@ -1940,10 +1943,10 @@ Options:
:L: Low Traffic
:R: Restricted Traffic
.. _burrow:
.. _burrows:
burrow
======
burrows
=======
Miscellaneous burrow control. Allows manipulating burrows and automated burrow
expansion while digging.