]> git.pond.sub.org Git - empserver/blob - info/lretreat.t
retreat lretreat: Change query syntax to match mission
[empserver] / info / lretreat.t
1 .TH Command LRETREAT
2 .NA lretreat "Set retreat conditions/paths for units or armies"
3 .LV Expert
4 .SY "lretreat <UNIT/ARMY> <PATH> <CONDITIONS>"
5 .SY "lretreat <UNIT/ARMY> q"
6 The lretreat command allows you to examine or modify the retreat
7 paths and conditions of your land units.
8 .s1
9 The first argument selects land units to view or give orders for.
10 If an army designation is given when specifying orders, the orders
11 apply to all members of that army.
12 .s1
13 With 'q' instead of a retreat path, the current retreat paths and
14 conditions will be listed.
15 The report format contains the following fields:
16 .s1
17 .in \w'unit type\0\0'u
18 .L lnd#
19 the unit number
20 .L "unit type"
21 the type of land unit; \*Qcavalry\*U, \*Qengineer\*U, etc.,
22 .L x,y
23 the land unit's current location,
24 .L a
25 the army designation letter (set by \*Qarmy\*U command),
26 .L path
27 the current retreat path,
28 .L as army?
29 whether these are army retreat orders,
30 .L flags
31 what conditions will trigger retreat.
32 .in
33 .s1
34 For example:
35 .EX lretreat * q
36 .NF
37 lnd#     unit type       x,y   ar path       as army? flags
38    0 cav  cavalry        2,0      jjuuj               I
39 1 unit
40 .FI
41 .s1
42 A player may give retreat orders for a land unit or an army.  Retreat
43 orders include a set of conditions that determine when the army/unit
44 will retreat, and a path that the army/unit will follow.  When a condition
45 is met for a particular land unit, the \*Qas army?\*U field is checked. If it
46 is Yes, then every unit in that army with army retreat orders retreats
47 along the specified path. If it is no, then the retreat orders apply to
48 that unit only, and only that unit retreats.
49 .s1
50 When a land unit is added to an army, it is given the retreat orders
51 of the first unit in that army that has army retreat orders and is in
52 the same sector, if any exist.
53 .s1
54 Retreat orders are wiped when a land unit marches.
55 .s1
56 Retreat conditions are:
57 .nf
58
59         Condition       Meaning
60         i               Retreat when the unit is injured,
61                         i.e. whenever the unit is damaged by gun fire
62                         or bombs.
63         b               Retreat when a plane bombs or tries to bomb
64                         the unit.
65         h               Retreat when helpless --- a unit is helpless
66                         when it is fired upon, and no friendly
67                         units/sectors (including the unit itself)
68                         are able to fire back at the aggressor.
69         c               Cancel retreat order
70 .fi
71 .s1
72 For example, if the cavalry above was fired at, it would attempt to
73 retreat 2 sectors, jj, using the normal amount of mobility for moving
74 2 sectors. It would then look like:
75 .NF
76 lnd#     unit type       x,y   ar path       as army? flags
77    0 cav  cavalry        2,0      uuj                 I
78 1 unit
79 .FI
80 .s1
81 .SA "land, army, LandUnits"