Skip to content

Commit 6c3da51

Browse files
authored
Merge pull request #3707 from myk002/myk_quickfort_by_id
update quickfort user guide for new take_from semantics
2 parents fb3ec49 + 6185df2 commit 6c3da51

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/guides/quickfort-user-guide.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1992,10 +1992,10 @@ All stockpiles support the following properties:
19921992
Property Description
19931993
================ ===========
19941994
``name`` the name of the stockpile
1995-
``take_from`` comma-separated list of names of stockpiles or workshops that
1996-
the stockpile takes from
1997-
``give_to`` comma-separated list of names of stockpiles or workshops that
1998-
the stockpile gives to
1995+
``take_from`` comma-separated list of names or building ids of stockpiles
1996+
or workshops that the stockpile takes from
1997+
``give_to`` comma-separated list of names or building ids of stockpiles
1998+
or workshops that the stockpile gives to
19991999
``links_only`` if set to ``true`` then the stockpile will only take from
20002000
links
20012001
``barrels`` the number of desired barrels
@@ -2014,6 +2014,12 @@ Property Description
20142014
feature
20152015
================ ===========
20162016

2017+
Note that specifying building IDs in ``take_from`` or ``give_to`` lists is
2018+
primarily useful when dynamically generating `quickfort` blueprints and
2019+
applying them via the API. You will not generally know the ID of a stockpile or
2020+
building when writing a blueprint by hand or when preparing a blueprint to
2021+
apply in a different fort.
2022+
20172023
#build mode reference
20182024
~~~~~~~~~~~~~~~~~~~~~
20192025

@@ -2023,8 +2029,8 @@ accept the ``name`` property.
20232029
Moreover, all workshops and furnaces accept the ``max_general_orders``
20242030
property, which sets the maximum number of general workorders that the building
20252031
can accept, and the ``take_from`` and ``give_to`` properties, which are
2026-
comma-separated lists of names (the same as the correponding stockpile
2027-
properties above).
2032+
comma-separated lists of names or building ids (the same as the correponding
2033+
stockpile properties above).
20282034

20292035
================= ============================= ==========
20302036
Symbol Type Properties
@@ -2141,7 +2147,8 @@ Symbol Type Properties
21412147
route stop on this track stop
21422148
and make it take from the given
21432149
comma-separated list of
2144-
stockpile names. ``route``: add
2150+
stockpile names or stockpile
2151+
building ids. ``route``: add
21452152
this route stop to the named
21462153
route. if no route of this name
21472154
exists, it will be created. If

0 commit comments

Comments
 (0)