]> git.pond.sub.org Git - empserver/blob - info/supply.t
Fix trailing whitespace
[empserver] / info / supply.t
1 .TH Command SUPPLY
2 .NA supply "Cause a unit to draw supplies"
3 .LV Basic
4 .SY "supply <UNIT/ARMY>"
5 The supply command causes a unit to draw enough supplies from its
6 supply sources to make sure that it has its basic load of supplies.
7 Supply tells you which units have enough supplies.
8 .s1
9 A basic load of supplies for a unit consists of:
10 .nf
11         1) enough food to eat for one update
12
13         2) enough shells to fire once
14                 A unit uses shells equal to its ammo stat to fire once.
15                 Use the \*Qshow\*U command to find out how much ammo
16                 the unit uses per shot.
17 .fi
18
19 .s1
20 If the unit has enough of all these things, it is said to be 'in supply'.
21 A lack of any of these things is enough to make the unit 'out of supply'.
22 .s1
23 .L "When supplies are drawn & used"
24 .s1
25 A unit that fights may use a basic load of supplies
26 to attack with.  (depending on the intensity of combat. The more intense the
27 combat, the more chance the unit will use a basic load of supplies)
28 .s1
29 During the update, each unit will attempt to draw food supplies just before
30 starvation is calculated.
31 .s1
32 When a unit needs to draw supplies, such as when you use the supply command,
33 or the unit wishes to attack, or is attacked, etc, it must attempt to get
34 them from supply sources. Other things may use the same routines, such as
35 loyal sectors, which will draw food from supply sources when in danger of
36 starvation, and ships/forts/sectors, which will draw shells when they need
37 them to fire defensively or fire AA at planes.
38 .s1
39 .L "Supply Sources"
40 .s1
41 There are four sources of supply. In each case, the
42 unit must be within supply range of the source. Supply range is:
43 .s1
44 .ti 3
45 10 * ((tech+50)/(tech+200) sectors.
46 .s1
47 In addition there must be a valid supply path to the source. A supply path
48 is a path of sectors owned by the owner of the unit that leads to the
49 supply source. (Note that the path may be of any length.. only the supply
50 source itself must be within supply range.. this is to make the coding
51 simpler, and may change in the future) The best path (in terms of mobility
52 use) will be used.
53 .s1
54 In each case, mobility is used to move the supplies.
55 .s1
56 The first source of supply checked is the sector the unit is in.
57 This is foraging, and uses some mobility from the unit itself.
58 .s1
59 If the unit's needs can't be satisfied by foraging, it look for an owned
60 warehouse or headquarters that is at least 60% efficient. Drawing
61 from these sources uses mobility from
62 the warehouse or headquarters. (A headquarters will NOT supply a unit if it
63 has no distribution path)
64 .s1
65 If still in need, the unit will look for an owned supply ship (one that has
66 the supply ability) in an owned harbor.
67 The harbor must be at least 2%
68 efficient. This uses mobility from the harbor.
69 .s1
70 If it still can't find enough supplies, the unit will look for an owned
71 unit with the 'supply' ability. (see info show for information on how to
72 find out about abilities of units) In this case, the supply unit uses its
73 mobility to use the supplies. After it supplies the unit, the supply unit
74 will then itself try to re-supply, so that it is possible to form a chain
75 of supply units reaching back to a headquarters or supply ship.
76 .s1
77 If after all this the unit can't get enough, it is out of supplies.
78 .s1
79 Note that no supply source will give up enough food to make it starve. In
80 addition, no supply source will go below 1 of any commodity.
81 .s1
82 .EX supply *
83 War band #2 has supplies
84 .ti 3
85 4 units
86 .s1
87 OTHER USES OF SUPPLY
88 .s1
89 In general, when any land unit/ship/fort needs shells, it will attempt to
90 draw them before use, if it does not already have them.
91 .s1
92 Also, units/ships/sectors will use supply sources to get enough food during
93 the update so that they do not starve.
94 .s1
95 .SA "lload, LandUnits"