]> git.pond.sub.org Git - empserver/blob - info/distribute.t
Clean up some trailing whitespace
[empserver] / info / distribute.t
1 .TH Command DISTRIBUTE
2 .NA distribute "Establish distribution destination sector"
3 .LV Basic
4 .SY "distribute <SECTS> <DISTSECT|.|h>"
5 The distribute command is used to specify the way that goods will
6 travel during an update.
7 Each sector is allowed to have one and only one
8 \*Qdistribution sector\*U (a warehouse or road, typically).
9 Subsequent distribute commands
10 will replace the existing distribution sector.
11 .s1
12 For example,
13 .EX distribute 2,0 8,4
14 .NF
15 highway at 2,0 delivers to 8,4.
16 Distribution sector? 7,-1
17 highway 2,0 new path distributes to 7,-1 (cost 0.200)
18         Current best path is 'gguh'
19 .FI
20 This command changed the distribution path for sector 2,0 from
21 a warehouse at 8,4 to a warehouse at 7,-1. The cost is the mobility cost
22 to move 1 normal-weight unit from the sector to the warehouse.
23 .s1
24 DISTSECT is a normal empire sector specification. During the update,
25 empire will determine the cheapest existing path to the distribution
26 sector, and use that. (Note that the mobility cost for the path used
27 during the update could
28 be different than the cost reported to you when you use the distribute command,
29 if you have re-designated sectors, or sectors were captured, etc)
30 Again, it will use the cheapest path available AT THE TIME OF THE UPDATE.
31 .s1
32 You may also use '.' or 'h' to specify no distribution sector.
33 .s1
34 .EX dist 2,0 .
35 .NF
36 Distribution to and from 2,0 halted.
37 .FI
38 .s1
39 The command will warn you if there is no existing path completely
40 owned by you, and also if the path does not end at a warehouse.
41 It is not required that the distribution path end at a warehouse,
42 but it is required that you own all the sectors that the goods
43 will travel along.
44 .s1
45 .L "Distribution & the Update"
46 .s1
47 One of the last things that takes place during the update, after all growth,
48 production, delivery, etc, distribution takes place. (The only thing that
49 really happens after that is mobility increases) Each sector may have
50 product
51 thresholds and a distribution sector. A threshold is a target level for a
52 particular commodity, like food. So, if the food threshold for a sector is
53 100, it will try to maintain 100 food there. If it has more than 100 food,
54 it will export it to its distribution point. If it has less than 100, it
55 will try to import food from the distribution point to reach 100.
56 .s1
57 During the distribution phase of the update, all sectors (going left to
58 right, top to bottom) first export excess
59 commodities, and then (again left to right, top to bottom)
60 import needed commodities.
61 .s1
62 In order to either send things to or get things from a distribution sector,
63 you must own the distribution sector, and there must be a path of owned
64 sectors to it. In order to export something from a sector, you must have
65 military control of the sector. In order to import something from a
66 distribution sector, you must have military control of the distribution
67 sector. (Military control is defined as having mil in the sector equal
68 to at least 1/10th the number of unconverted civilians there. Units count
69 as if they were straight mil, i.e. a 100% unit that contained 50 mil would
70 count as 50 mil for the purposes of control)
71 .s1
72 Mobility is used from the sector when sending \*Qto\*U the distribution sector.
73 When getting something \*Qfrom\*U the distribution sector, mobility is paid
74 by the distribution sector.  See \*Qinfo Mobility\*U for an
75 explanation of mobility costs.
76 .s1
77 .L Amount
78 .s1
79 The amount is determined by the threshold, as explained above.
80 Use the \*Qthreshold\*U command to specify what goods
81 will flow to and from the warehouse.
82 .s1
83 .L "Finding sectors with not dist point set"
84 .s1
85 If you want to find sectors with no distribution point set, use the
86 xdist and ydist selectors:
87 .s1
88 .EX level # ?xdist=xloc&ydist=yloc
89 .s1
90 This finds all sectors that have themselves as a distribution point.
91 .s1
92 .L "Distributing civilians and military"
93 .s1
94 When distributing civilians or military,
95 no distribution point will ship out its last civilian or
96 the last military if there are no civilians,
97 regardless of thresholds set in sectors using it as a
98 distribution point.
99 .s1
100 .SA "deliver, threshold, level, Distribution"