]> git.pond.sub.org Git - empserver/blob - info/retreat.t
Fix trailing whitespace
[empserver] / info / retreat.t
1 .TH Command RETREAT
2 .NA retreat "Set retreat conditions/paths for ships or fleets"
3 .LV Expert
4 .SY "retreat [<SHIP/FLEET> | <SECTS>] [<PATH>] [<CONDITIONS>]"
5 .SY "lretreat [<UNIT/ARMY> | <SECTS>] [<PATH>] [<CONDITIONS>]"
6 The retreat command allows you to examine or modify the retreat
7 paths and conditions of your ships or units. The following description
8 is for ships. Land units are exactly the same, except of course that
9 some of the retreat conditions (being sonared, depth charged, etc) don't apply.
10 .s1
11 The <SHIP/FLEET> and <SECTS> arguments are provided to specify which
12 ships to view or give orders for. If a fleet designation is given when
13 specifying orders, the orders apply to all ships within that fleet.
14 .s1
15 Retreat expects an argument.  To see every ship you own, give it
16 the argument '*', or type "retreat *".
17 .s1
18 The report format contains the following fields:
19 .s1
20 .in \w'shiptype\0\0'u
21 .L shp#
22 the ship number
23 .L shiptype
24 the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc,
25 .L x,y
26 the ship's current location (relative to your capital),
27 .L flt
28 the fleet designation letter (set by \*Qfleetadd\*U command),
29 .L path
30 the ship's current retreat path.
31 .L as_flt?
32 whether or not the ship's retreat path is a fleet retreat path
33 .L flags
34 what conditions the ship will retreat under
35 .in
36 .s1
37 For example:
38 .EX retreat *
39 .NF
40 shp#     ship type       x,y   fl path       as flt?  flags
41    0 battleship 4        2,0      jjuuj               I
42 1 ship
43 .FI
44 .s1
45 .L Overview
46 .s1
47 A player may give retreat orders for a ship or a fleet. Retreat
48 orders include a set of conditions that determine when the fleet/ship
49 will retreat, and a path that the fleet/ship will follow. When a condition
50 is met for a particular ship, the \*Qas flt?\*U field is checked. If it
51 is Yes, then every ship in that fleet with fleet retreat orders retreats
52 along the specified path. If it is no, then the retreat orders apply to
53 that ship only, and only that ship retreats.
54 .s1
55 When a ship is added to a fleet, it is given the retreat orders of the
56 first ship in that fleet that has fleet retreat orders and is in the
57 same sector, if any exist.
58 .s1
59 Retreat orders are wiped when a ship navigates.
60 .s1
61 Retreat conditions are:
62 .nf
63
64         Condition       Meaning
65         I               Retreat when the ship is injured,
66                         i.e. whenever the ship is damaged by fire,
67                         bombs, or torping
68         T               Retreat when a sub torpedos or tries to
69                         torpedo the ship
70         B               Retreat when a plane bombs or tries to bomb
71                         the ship
72         S               Retreat when the ship detects a sonar ping
73         D               Retreat when the ship is depth-charged
74         H               Retreat when helpless --- a ship is helpless
75                         when it is fired upon, and no friendly
76                         ships/sectors (including the ship itself) are
77                         able to fire back at the aggressor
78         U               Retreat upon a failed boarding attempt
79         C               Cancel retreat order
80         ?               List the conditions
81 .fi
82 .s1
83 For example, if the battleship above was fired at, it would attempt to
84 retreat 2 sectors, jj, using the normal amount of mobility for moving
85 2 sectors. It would then look like:
86 .NF
87 shp#     ship type       x,y   fl path       as flt?  flags
88    0 battleship 4        2,0      uuj                 I
89 1 ship
90 .FI
91 .s1
92 .SA "ship, fleetadd, Ships"