empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

info/retreat info/lretreat: Fix and clean up

Browse source 
.SY claims all arguments are individually optional.  Fix that, and
clarify that omitting the optional arguments shows current orders.

Don't complicate syntax with <SECTS>, <SHIP/FLEET> covers sectors.

The two pages are identical apart from header and footer.  They
mention land units briefly, then explain ship retreat.  Lazy.  Drop
the land unit mention from "info retreat", and rewrite "info lretreat"
for land units.

Update example output for current code.

Don't shout retreat conditions.  We've always accepted both lower and
upper case conditions.  Help has been advertising lower case since
commit bb5dfd8, v4.3.16.

While there, fix a few misspellings and such.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
This commit is contained in:
Markus Armbruster 2014-12-31 10:02:23 +01:00
parent 75a049515b
commit 4e0d02b359
2 changed files with 72 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

104
info/lretreat.t
View file

@ -1,91 +1,81 @@
.TH Command LRETREAT .TH Command LRETREAT
.NA lretreat "Set retreat conditions/paths for units or armies" .NA lretreat "Set retreat conditions/paths for units or armies"
.LV Expert .LV Expert
.SY "retreat [<SHIP/FLEET> | <SECTS>] [<PATH>] [<CONDITIONS>]" .SY "lretreat <UNIT/ARMY> [<PATH> <CONDITIONS>]"
.SY "lretreat [<UNIT/ARMY> | <SECTS>] [<PATH>] [<CONDITIONS>]" The lretreat command allows you to examine or modify the retreat
The retreat command allows you to examine or modify the retreat paths and conditions of your land units.
paths and conditions of your ships or units. The following description
is for ships. Land units are exactly the same, except of course that
some of the retreat conditions (being sonared, depth charged, etc) don't apply.
.s1 .s1
The <SHIP/FLEET> and <SECTS> arguments are provided to specify which The first argument selects land units to view or give orders for.
ships to view or give orders for. If a fleet designation is given when If an army designation is given when specifying orders, the orders
specifying orders, the orders apply to all ships within that fleet. apply to all members of that army.
.s1
Retreat expects an argument. To see every ship you own, give it
the argument '*', or type "retreat *".
.s1 .s1
Without further arguments, current retreat orders are shown.
The report format contains the following fields: The report format contains the following fields:
.s1 .s1
.in \w'shiptype\0\0'u .in \w'unit type\0\0'u
.L shp# .L lnd#
the ship number the unit number
.L shiptype .L "unit type"
the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc, the type of land unit; \*Qcavalry\*U, \*Qengineer\*U, etc.,
.L x,y .L x,y
the ship's current location (relative to your capital), the land unit's current location,
.L flt .L a
the fleet designation letter (set by \*Qfleetadd\*U command), the army designation letter (set by \*Qarmy\*U command),
.L path .L path
the ship's current retreat path. the current retreat path,
.L as_flt? .L as army?
whether or not the ship's retreat path is a fleet retreat path whether these are army retreat orders,
.L flags .L flags
what conditions the ship will retreat under what conditions will trigger retreat.
.in .in
.s1 .s1
For example: For example:
.EX retreat * .EX lretreat *
.NF .NF
shp# ship type x,y fl path as flt? flags lnd# unit type x,y ar path as army? flags
0 battleship 4 2,0 jjuuj I 0 cav cavalry 2,0 jjuuj I
1 ship 1 unit
.FI .FI
.s1 .s1
.L Overview .L Overview
.s1 .s1
A player may give retreat orders for a ship or a fleet. Retreat A player may give retreat orders for a land unit or an army. Retreat
orders include a set of conditions that determine when the fleet/ship orders include a set of conditions that determine when the army/unit
will retreat, and a path that the fleet/ship will follow. When a condition will retreat, and a path that the army/unit will follow. When a condition
is met for a particular ship, the \*Qas flt?\*U field is checked. If it is met for a particular land unit, the \*Qas army?\*U field is checked. If it
is Yes, then every ship in that fleet with fleet retreat orders retreats is Yes, then every unit in that army with army retreat orders retreats
along the specified path. If it is no, then the retreat orders apply to along the specified path. If it is no, then the retreat orders apply to
that ship only, and only that ship retreats. that unit only, and only that unit retreats.
.s1 .s1
When a ship is added to a fleet, it is given the retreat orders of the When a land unit is added to an army, it is given the retreat orders
first ship in that fleet that has fleet retreat orders and is in the of the first unit in that army that has army retreat orders and is in
same sector, if any exist. the same sector, if any exist.
.s1 .s1
Retreat orders are wiped when a ship navigates. Retreat orders are wiped when a land unit marches.
.s1 .s1
Retreat conditions are: Retreat conditions are:
.nf .nf
Condition Meaning Condition Meaning
I Retreat when the ship is injured, i Retreat when the unit is injured,
i.e. whenever the ship is damaged by fire, i.e. whenever the unit is damaged by gun fire
bombs, or torping or bombs.
T Retreat when a sub torpedos or tries to b Retreat when a plane bombs or tries to bomb
torpedo the ship the unit.
B Retreat when a plane bombs or tries to bomb h Retreat when helpless --- a unit is helpless
the ship
S Retreat when the ship detects a sonar ping
D Retreat when the ship is depth-charged
H Retreat when helpless --- a ship is helpless
when it is fired upon, and no friendly when it is fired upon, and no friendly
ships/sectors (including the ship itself) are units/sectors (including the unit itself)
able to fire back at the aggressor are able to fire back at the aggressor.
U Retreat upon a failed boarding attempt c Cancel retreat order
C Cancel retreat order
.fi .fi
.s1 .s1
For example, if the battleship above was fired at, it would attempt to For example, if the cavalry above was fired at, it would attempt to
retreat 2 sectors, jj, using the normal amount of mobility for moving retreat 2 sectors, jj, using the normal amount of mobility for moving
2 sectors. It would then look like: 2 sectors. It would then look like:
.NF .NF
shp# ship type x,y fl path as flt? flags lnd# unit type x,y ar path as army? flags
0 battleship 4 2,0 uuj I 0 cav cavalry 2,0 uuj I
1 ship 1 unit
.FI .FI
.s1 .s1
.SA "ship, fleetadd, LandUnits" .SA "land, army, LandUnits"

51
info/retreat.t
View file

@ -1,20 +1,15 @@
.TH Command RETREAT .TH Command RETREAT
.NA retreat "Set retreat conditions/paths for ships or fleets" .NA retreat "Set retreat conditions/paths for ships or fleets"
.LV Expert .LV Expert
.SY "retreat [<SHIP/FLEET> | <SECTS>] [<PATH>] [<CONDITIONS>]" .SY "retreat <SHIP/FLEET> [<PATH> <CONDITIONS>]"
.SY "lretreat [<UNIT/ARMY> | <SECTS>] [<PATH>] [<CONDITIONS>]"
The retreat command allows you to examine or modify the retreat The retreat command allows you to examine or modify the retreat
paths and conditions of your ships or units. The following description paths and conditions of your ships.
is for ships. Land units are exactly the same, except of course that
some of the retreat conditions (being sonared, depth charged, etc) don't apply.
.s1 .s1
The <SHIP/FLEET> and <SECTS> arguments are provided to specify which The first argument selects ships to view or give orders for.
ships to view or give orders for. If a fleet designation is given when If a fleet designation is given when specifying orders, the orders
specifying orders, the orders apply to all ships within that fleet. apply to all members of that fleet.
.s1
Retreat expects an argument. To see every ship you own, give it
the argument '*', or type "retreat *".
.s1 .s1
Without further arguments, current retreat orders are shown.
The report format contains the following fields: The report format contains the following fields:
.s1 .s1
.in \w'ship type\0\0'u .in \w'ship type\0\0'u
@ -23,22 +18,22 @@ the ship number
.L ship type .L ship type
the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc, the type of ship; \*Qpatrol boat\*U, \*Qsubmarine\*U, etc,
.L x,y .L x,y
the ship's current location (relative to your capital), the ship's current location,
.L flt .L flt
the fleet designation letter (set by \*Qfleetadd\*U command), the fleet designation letter (set by \*Qfleetadd\*U command),
.L path .L path
the ship's current retreat path. the current retreat path,
.L as_flt? .L as flt?
whether or not the ship's retreat path is a fleet retreat path whether these are fleet retreat orders,
.L flags .L flags
what conditions the ship will retreat under what conditions will trigger retreat.
.in .in
.s1 .s1
For example: For example:
.EX retreat * .EX retreat *
.NF .NF
shp# ship type x,y fl path as flt? flags shp# ship type x,y fl path as flt? flags
0 battleship 4 2,0 jjuuj I 0 bb battleship 2,0 jjuuj i
1 ship 1 ship
.FI .FI
.s1 .s1
@ -62,21 +57,21 @@ Retreat conditions are:
.nf .nf
Condition Meaning Condition Meaning
I Retreat when the ship is injured, i Retreat when the ship is injured,
i.e. whenever the ship is damaged by fire, i.e. whenever the ship is damaged by gun fire,
bombs, or torping bombs or torpedoes
T Retreat when a sub torpedos or tries to t Retreat when a sub torpedoes or tries to
torpedo the ship torpedo the ship
B Retreat when a plane bombs or tries to bomb b Retreat when a plane bombs or tries to bomb
the ship the ship
S Retreat when the ship detects a sonar ping s Retreat when the ship detects a sonar ping
D Retreat when the ship is depth-charged d Retreat when the ship is depth-charged
H Retreat when helpless --- a ship is helpless h Retreat when helpless --- a ship is helpless
when it is fired upon, and no friendly when it is fired upon, and no friendly
ships/sectors (including the ship itself) are ships/sectors (including the ship itself) are
able to fire back at the aggressor able to fire back at the aggressor
U Retreat upon a failed boarding attempt u Retreat upon a failed boarding attempt
C Cancel retreat order c Cancel retreat order
.fi .fi
.s1 .s1
For example, if the battleship above was fired at, it would attempt to For example, if the battleship above was fired at, it would attempt to
@ -84,7 +79,7 @@ retreat 2 sectors, jj, using the normal amount of mobility for moving
2 sectors. It would then look like: 2 sectors. It would then look like:
.NF .NF
shp# ship type x,y fl path as flt? flags shp# ship type x,y fl path as flt? flags
0 battleship 4 2,0 uuj I 0 bb battleship 2,0 uuj i
1 ship 1 ship
.FI .FI
.s1 .s1