Club Amiga de Montreal - CAM/CAM_CD_1.iso/files/416.lha/EnergionBattleSystem_v1.0/misc.doc.pp/misc.doc

Text File | 1990-09-10 | 17KB | 533 lines

                             EBS User's Manual

                                 Section 6

                         Miscellaneous Information














































                                                  1






6.1  Requesters . . . . . . . . . . . . . . . . . . . . . . . . . . . .    3
     6.1.1 The File Requester . . . . . . . . . . . . . . . . . . . . .    3
     6.1.2  The List Requester  . . . . . . . . . . . . . . . . . . . .    3
     6.1.3  The Options Requester . . . . . . . . . . . . . . . . . . .    3
     6.1.4  Standard String Requester . . . . . . . . . . . . . . . . .    4
     6.1.5  The "ReallyReally" Requester  . . . . . . . . . . . . . . .    4

6.2  The EBS Map  . . . . . . . . . . . . . . . . . . . . . . . . . . .    4

6.3  Current Modules and other Defaults . . . . . . . . . . . . . . . .    5
     6.3.1  Current Location  . . . . . . . . . . . . . . . . . . . . .    5
     6.3.2  Current Marker  . . . . . . . . . . . . . . . . . . . . . .    6
     6.3.3  Current Unit and Associated Modules . . . . . . . . . . . .    6

6.4  Flanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    7

6.5  Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . .    7



































                                                  2






6.1  Requesters

6.1.1 The File Requester

     The EBS file requester is taken whole from PLAYER, and the following
information is taken from the PLAYER documentation.

     The file requester is completely "live", meaning that you can go ahead
and start doing things as soon as it shows up, without having to wait for it
to finish reading the directory.  In order to reduce the amount of mouse-tag
required while the list is being updated, the list will stop updating if you
click in it.  You can restart the updates by clicking anywhere in the
requester
background, outside of the gadgets.  The string gadget box at the top is for
the directory to list; you may click in this box to type a new directory
name, or you may click on a listed directory name to enter it into this box
automatically.  Hitting return within this box, or double-clicking a listed
directory name, causes the requester to list the files in the new directory.
The center box lists the files and/or subdirectories found within the
directory being listed.  Subdirectories are printed in red, and normal files
are printed in black.  The lower string gadget box is for the name of the
file to be loaded or saved; as with the directory box, you may click in this
box to type a filename, or you may click on a listed file name to enter it
automatically.  Hitting return within this box, or double-clicking a listed
file name, finishes the file requester's job and is equivalent to clicking
on the Load/Save button after entering the name.

     All EBS files are by default located in the directory under the EBS
variable FILEPATH.  By default this is "map:" but it may be set to anything
desired, or the user can use the AmigaDOS "assign" command to make that path
equivalent to whatever path desired.  See Section 3, EBS Script Language for
a discussion of setting the filepath and other EBS variables.


6.1.2  The List Requester

     The list requester is similar to the file requester, but is designed to
allow the selection of items from lists of Energion modules or commands.  It
has no gadget for filepath, but otherwise works the same as a file
requester.  Click on the item you wish to choose and it is entered into the
string gadget at the bottom of the requester.


6.1.3  The Options Requester

     The Options requester is similar to the list and file requesters, but
also lacks the string gadget at the bottom of the requester.  It presents a
list of options which may be turned on or off.  Items are printed in color
two of your palette when not selected and in inverse video with colors two
and zero when selected.  Selecting the "OK" gadget accepts the options
entered, cancel returns the options to the state they were when the

                                                  3





requester was entered.  Both gadgets close the requester.

     Note that the words used to display the options in the requester are
identical to their labels as used in the EBS Script Language.


6.1.4  Standard String Requester

     This is an extremely simple and boring requester which has a prompt at
the top, indicating what EBS is looking for and a string gadget below that
for the user to enter a response.  It comes up activated and ready to accept
data.  This requester may be presented in the Main, Marker, Editor or
Command windows, but freezes EBS until a response is received.

     For users of the EBS Script language, this is a requester which awaits
a response before continuing.  In the language there is, in addition, a
requester which will notify your AREXX script/port each time an item is
entered in it.


6.1.5  The "ReallyReally" Requester

     This is a standard AmigaDos requester asking whether you really want to
do something.  EBS presents this when you are clearing or deleting modules
and they have not been saved or are in use by another module, or when you
are preparing to overwrite a file.


6.2  The EBS Map

     For purposes of developing strategies and tactics for units, the EBS
map is divided into sides, zones and sectors.  These items only exist on a
tactical map, and the user may access information about these areas of the
map through the EBS script language.  It will be helpful to have a copy of
EBS up with a tactical map while reading the following section in order to
have an illustration of the information presented.

     To view the map for the following section, start EBS and load the map
provided in the basic EBS package called "tactical.emap."  From the main
menu strip, menu one, select "Options," and when the requester is displayed,
turn on the "MARKSECTORS" item.

     The map displays the sectors.  There are 36 sectors on a map, numbered
from left to right and top to bottom.  Each time you click on the map, the
sector number is included in the location information presented.  EBS uses
information concerning the cover, the altitude, the average movement rate,
the number of hostiles and the number of friendlies in a sector in
establishing strategies.  In addition, this information can be accessed from
the EBS Script Language and used in strategy or tactics scripts.

     Now select from the options requester the "MARKZONES" option and turn
off the mark sectors.  Both can be selected simultaneously, but generally

                                                  4





one tends to obscure the other, so I do not recommend that.

     There are nine zones numbered top to bottom and left to right.  These
zones also provide information concerning the map and its contents for use
in strategy.  Each zone contains four sectors.  Most information is
accessible by the zone, but for any which is not, get the information for
each sector in a zone to calculate it for a zone.

     The largest areas considered on the map for strategy is the "side."
The start side is the map area from which a force begins its actions; the
target side is the area to which the force is attempting to go, or from
which it is expecting an attack.

     There are nine sides to an EBS tactical map, numbered 1 to 9.  Each
side, except for size 9, consists of three zones.  The following is a list
of sides and the zones which they contain.

     Side 1:  Zones 1, 2 and 3.
     Side 2:  Zones 1, 2 and 4.
     Side 3:  Zones 1, 4 and 7.
     Side 4:  Zones 4, 7 and 8.
     Side 5:  Zones 7, 8 and 9.
     Side 6:  Zones 8, 9 and 6.
     Side 7:  Zones 3, 6 and 9.
     Side 8:  Zones 2, 3 and 6.
     Side 9:  Zone 5.

     EBS decides which side a force is on by calculating how many troops it
has in each zone, then taking the side which has the greatest number of
troops in its zones.  In the absence of a defined objective, it decides on a
target side by counting the hostiles in each zone and determining the side
which has the greatest number of hostiles (from any force).  If there is a
defined objective, the side which has that objective most closely centered
will be the target side.

     Routes chosen by computer run units are plotted between the start side
(and the unit's start sector within that side) and the target side using the
information contained in a strategy module which defines idealized courses
for units from their starting location to their target.


6.3  Current Modules and other Defaults

     A current module is a module referenced by EBS as a default.  The
following section describes the current items, and how they are set.

6.3.1  Current Location

     There are three current locations, one for the mouse and one for each
of the two remote pointers.  The locations for the remote pointers are set
through the EBS Script Language.


                                                  5





     The current location is set by clicking on a map.  This also sets
another default, as the old current location becomes--you guessed it--the
previous location.  When the distance mode "Current" is selected, it is the
distance between the current location and the previous location which EBS
displays.

     When one of the two plotting modes is selected, the chain of locations
becomes longer (10 by default).  The first location in this chain is the
first location.  Distance measurement is still between the previous and the
current location.

     When the distance mode "Total" is selected, each time a new current
distance is calculated, it is added to a total distance.  This total will
continue to grow with each new current location until it is cleared using
the menu option or script command.


6.3.2  Current Marker

     There are three current markers, one for the mouse, and one each for
the two remote pointers.  The latter two of these must be set through the
EBS Script Language.

     A current marker is set for the mouse pointer by clicking on a marker.
This results in display of information concerning that marker and execution
of any scripts associated with it.  Also, if the unit has any associated
modules, such as a unit, a supply module or an objective, those also become
current.


6.3.3  Current Unit and Associated Modules

     The Current Unit is set either through clicking on the unit's marker or
by selecting that unit for editing through the editor.  Take care when using
current modules for setting values when the editor window is open.  When
clicking on a marker, ALL associated values are set to the ones associated
with that marker.  If the editor window is open, for example, to edit a
movement module, and you then select a different movement module through the
editor window, that is the new current movement rather than the one
associated with the current unit.  The editor sets the current modules
independently; selecting markers sets all the values to those associated
with a single marker.

     When there are forces on the map, a current unit is set only by
clicking on a marker for a unit of the current force.  Selecting opposing
units (as the current unit) requires changing the current force through the
force requester.

     Clicking on units of the opposing force selects them as the current
target for use in the command window.

     Each module which may be defined in EBS has a current value.  If there

                                                  6





are no such modules defined, the response to a request for the name will be
"None."






6.4  Flanks

     A force in EBS can have six "flanks,"  the leftleft, leftright,
centerleft, centerright, rightleft and rightright.  For more traditional
strategy definition, simply group these two by two for a left flank, a
center and a right flank.  The front is divided into these six groupings
from far left to far right, and movement data can be specified about them
using the EBS strategy module.

     If EBS finds insufficient units to make up all the flanks, it will try
for left, center and right and will execute portions of the strategy
accordingly.  In designing strategies, this must be taken into
consideration, since you could have EBS only implementing part of your
intended actions.  Try executing a small portion of the conflict, and then
observe the flank numbers assigned to your units by EBS.

     If you have a chain of command defined, EBS creates the flanks at the
second echelon of command.  If there are insufficient second echelon HQ
units, EBS will execute the strategy with less different flank actions.  All
units under a single second echelon HQ unit will be considered to be on the
same flank, preventing portions of a unit under a single command from going
off on their own.  The one exception to this is those units assigned to seek
out enemy HQ units or supply units.


6.5  Glossary

     Command Gadget - the string gadget at the top of the command window in
which EBS Script Language commands may be entered one at a time to configure
EBS in the absence of a script or AREXX port.

     Current Attacker - the unit which is currently selected to receive
commands concerning targets.

     Current Location - the location where a pointer was last "clicked."
There are three pointers, and three location chains defined for them.  When
a new location is defined as current, the current location becomes the last
location.  The start of a chain is the first location.

     Current Remote Pointer - the remote pointer defined for current use of
all execute commands.

     Current Unit - the current default unit for editing purposes, accessed
through the EBS variable [CUNIT] in scripts or through the edit window.

                                                  7






     Current Target - the current default unit which will become the target
of the current attacker if the "CTGT" gadget is selected in the Command
Window.

     Force - a module describing the attitudes, strategies, objectives and
members of a group of units with a common aim in a scenario.  EBS allows 32
forces per scenario.

     Map - an IFF graphics file and definition file which combine to provide
EBS with the information it needs to calculate terrain, locations and
distances.  Most EBS functions require a map loaded for use.

     Module - an element describing something about a map or battle
scenario.  Combining modules produces military units, maps and markers.  For
example, a military unit might include its basic unit definition (unit
module), a description of its movement abilities (movement module), its
defensive capabilities (defense module), its abilities to use weapons (one
or more attack modules) and the weapons used (weapon modules).  With the
exception of the attacks, which are added directly to the unit module, all
other modules may be used by multiple other modules, i.e. a movement module
describing how cavalry can move may be used by all cavalry units on the map.

     Last Location - the location defined by a pointer just before the
current location.  Each time a new current location is selected, the former
current location becomes the last location.  There is a last location for
each of the three pointers.

     Options or Options Lists - Each module in EBS has a list of options
which are ON/OFF choices for the user to make about the behavior of that
module.  In addition, there is a list of MAIN options and SCENARIO options
determining how EBS behaves as a whole, and how scenarios behave.  The
options for modules are discussed under each individual module.  The MAIN
and SCENARIO options are discussed under the MAIN menu.

     Remote Pointer - one of two sprites designed to duplicate the function
of the mouse through the script language.  They may be moved around the map,
and have "mouseclicks" executed for them, though they cannot be used to
select menus.  They are called REM1 and REM2 for script purposes.

     Sector - a rectangular section of a tactical map, 1/36 the size of the
whole map.

     Side - a group of zones from which a force starts its actions during a
battle or scenario.

     Strategy - as used in EBS, is the movement decisions made for a unit
before it has an enemy unit which is a valid target inside its zone of
control.  Inside the Zone of Control, tactics takes over.

     Tactics - as used in EBS, is the actions which a unit takes when it has
a valid target inside its zone of control.

                                                  8






     Unit - a module defining the unique elements of a unit, such as the
number of members the unit has and their status, as well as identifications
of all the modules used by that unit.  It is the basic element of a force.

     Zone - a rectangular section of a tactical map, 1/9 the size of the
whole map.

     Zone of Control - that area over which a unit, lacking other direction,
is permitted to adjust its movement for the purpose of attacking valid
targets.










































                                                  9