

Combat Diver addon


An unofficial addon For Operation Flashpoint: Resistance
by The Chain of Command, http://www.thechainofcommand.com/
=========================================================================

This document contains:
  CREDITS
  REQUIREMENTS
  CHANGELOG
  CLASSES AVAILABLE IN THIS ADDON
  FUNCTIONS AND FEATURES FOR MISSION MAKERS
    SWIMMING
    OTHER FEATURES
  MAKING MULTIPLAYER MISSIONS
  REAL LIFE INFORMATION
  INSTALLATION INSTRUCTIONS
  DISCLAIMER

=========================================================================

Version: 1.0 (for Operation Flashpoint:Resistance v1.85)
This addon for Operation Flashpoint is shareware and can be distributed under the 
following conditions: 
- Only non commercial distribution is allowed.
- All original files have to remain in the addon.
- Original files may not be changed in any way.
- Any modifications will automatically be subjected to the abovementioned conditions
  mentioned above.


If you want to reskin or remodel this addon send a request to matthijs@myrealbox.com



CREDITS
-------
Model based on original BIS work, by Willem-Matthijs Crielaard
Camouflaged faces by Frandsen (http://www.ofp.info/talesofwar/)
Coding and configuration by Walker and Willem-Matthijs Crielaard 
Skin by Willem-Matthijs Crielaard
Special features by Willem-Matthijs Crielaard



REQUIREMENTS
------------
This addon requires Operation Flashpoint: Resistance



CHANGELOG
---------
Release candidate 1, 26-04-2003

Release candidate 2, 3-05-2003
- Changed medic inventory
- Changed group class, from "West (CoC) --> Combat Swimmers" to
  "West --> Combat swimmers (CoC)"

Release candidate 3, 3-05-2003
- Disabled "camouflage face" action, because of multiplayer problems
- Changed medic inventory
- Tested multiplayer support

Release v1.0, 16-05-2003
- Changed vehicleclasses, from "<description (CoC)" to "CoC (<description>)"


CLASSES AVAILABLE IN THIS ADDON
-------------------------------
UNITS:
CoC_Diver		Combat swimmer
			Equipment: pistol, rifle, binoculars, hand grenades, smoke devices
CoC_DiverSaboteur	Combat swimmer (Demolition)
			Equipment: pistol, rifle, satchel charge, mine, hand grenades
CoC_DiverM16		Combat swimmer (Rifleman)
			Equipment: pistol, rifle, grenades
CoC_DiverM203		Combat swimmer (Grenadier)
			Equipment: pistol, rifle, grenade launcher, grenades
CoC_DiverRecon		Combat swimmer (Recon)
			Equipment: pistol, silenced sub-machinegun, binoculars,
				   hand grenades, smoke devices
CoC_DiverSNP		Combat swimmer (Sniper)
			Equipment: sniper rifle, hand grenades, smoke devices

WEAPONS:
CoC_LAR7		LAR VII Rebreather

VEHICLES:
CoC_LAR7SWM		Combat swimmer (in water)
			This is actually the CoCOSS CoC_LAR7 vehicle counterpart.
			You may place this and do <unit> moveindriver <vehicle> within
			1 second of INIT.SQS



FUNCTIONS AND FEATURES FOR MISSION MAKERS
-----------------------------------------
In order to keep things organized , this section is cut in two. First we will discuss
swimming, and after that the other special features of this addon are given.



SWIMMING
--------
This addon provides you with the possibility of swimming. It is based on the CoCOSS
(Chain of Command Open Swimming System). This system aims to provide a way of
standardizing the swimming feature. Addom makers are encouraged to read the CoCOSS
document, and create their own swimming addon.



A BASIC UNDERSTANDING OF SWIMMING IN OPERATION FLASHPOINT:
The basics to make swimming in OFP possible are quite simple. Whenever a unit comes
below sea level, AND it is carrying the required swimming equipment (CoC_LAR7), it
spawns a vehicle (CoC_LAR7SWM), in which the unit is placed as driver.

The vehicle continually checks to see:
- If the player is still alive
- If the criteria to end the swimming process are met

Whenever one of these criteria is met, the vehicle destroys itself, leaving the unit
behind.

This system actually works very much like the normal Operation Flashpoint parachute.
The most noticable difference is that this system adds the feature of actually having
to carry the equipment, in order to use it.



CoCOSS COMPLIANT ADDONS:
- Allow units to swim.
- Automatically share the all the swimming equipment wit all other CoCOSS compliant
  units.
- Provide an easy way of adding swimming functionality to regular non-COCOSS compliant
  addons.
- Provide an easy way of disabling swimming, allowing mission maker to implement their
  own mission-dependent script.



MAKING NON-COCOSS COMPLIANT UNITS SWIM:
The easiest way of accomplishing this is to start the unit swim-script from the init
line:
<UNIT> EXEC "\CoC_Diver\Scripts\unit_swimscript.sqs"

Of course, you may also use the UNIT script from any other CoCOSS compliant addon, or
disable COCOSS  functionality and use your own mission-dependent script.



DISABLING COCOSS FUNCTIONALITY
There might be situations where you want to disable CoCOSS functionality, and use your
own mission-dependent script. To disable the CoCOSS swim-scripts, in the INIT.SQS of
your mission place:

CoC_SwimScriptDisable = true

NOTES:
1) Setting COC_SWIMSCRIPTDISABLE  will not make units that are already swimming stop
   swimming. (This is an undefined situation in CoCOSS)
2) Setting COC_SWIMSCRIPTDISABLE  will still make units register their swimming
   equipment. The next chapters will explain equipment registration.



SHARING SWIMMING EQUIPMENT:
There is no special action required to make units use eachothers CoCOSS swimming
equipment. If, for example, addon maker XYZ would create the addon swimsuit, the
CoC_Diver will be able to pick up the Swimsuit equipment and walk into the water to
start swimming. The only requirement is that all required the CoCOSS compliant units
are in the level, or the unit-swimscripts for all addon-types are started at least
once.



MANUALLY REGISTERING EQUIPMENT
As soon as a CoCOSS addon initializes, it will check to see if its swimming equipment
is in the global array CoC_GlobalSwimGear. If not, it will add the name of its swimming
equipment as a string.

The SwimScript will check the unit at hand for each type of equipment, as soon as the
conditions to start swimming are met. If the unit has one of the registered pieces of
equipment, the vehicle with the same name+SWM is spawened, and the unit is placed in
the driver position.

There can be situations where you want to use equipment, without the normal swim-script,
in which case the equipment will not be registered. The result will be that you cannot
swim. This situation is most likely to occur in situations where you are using a custom
swimscript or gear 

You may edit the contents of CoC_GlobalSwimGear in your mission, to manually register
equipment.

To manually register the equipment in this addon, let your script check if CoC_LAR7
is available in CoC_GlobalSwimGear. If not, let it add this value.



IMPORTANT NOTES ON SWIMMING:
1) When creating a mission in which units are starting off in the water, handle the
   situation as you would with parachutes: place units and empty CoC_LARSWM vehicles,
   and do a <unit> moveindriver <vehicle>.
2) AI does not know it can swim. You will not be able to order AI to walk into water.
3) AI cannot handle the rebreather. In future addons, AI might be able to handle itself,
   but in this addon, it will not be able to find its way.



OTHER FEATURES
--------------
- Addon includes a camouflaged face, by Frandsen
- The divemask is compatible with the BAS helicopter downwash script!
- Note that "Camouflage face" is a one time actions. Faces cannot be cleaned during
  gameplay.

Mission makers and scripters are provided with the a series of commands, to control
options and actions:

<unit> animate ["goggles", 1]
Puts on the divemask of <unit>

<unit> animate ["goggles ", 0]
Takes off the divemask of <unit>

<unit> setface "CoC_DiverCamo"
To set camouflage for the unit's face.


To set the camouflaged face on units, use the following command:
<unit> setface "CoC_DiverCamo"


NOTE:
you can quickly change properties for an entire team using the "foreach" command.
If you do so, remember to Use  two double-quotes for strings.

"_x  animate [""goggles"", 1]" foreach units group team1_leader;

(note the extra double-quotes around goggles")



MAKING MULTIPLAYER MISSIONS
---------------------------
It is not possible to use swimming in a multiplayer mission without using a mission-
based script. Read the Chain of Command Open Swimming System documentation. This
document can be obtained from: http://www.thechainofcommand.net/



REAL LIFE INFORMATION
---------------------
There are some ancient texts, describing the earliest combat swimming activity. Most
of them were related to Naval warfare. Its said that Xerxes used combat swimmers.
About 40 years BC, Herodotus wrote about Scyllis, a famous Greek swimmer that was in
Xerxes service to retrieve the treasures from sunken Persian ships. After a job well
done, Xerxes decided to keep Scyllis prisoner. The diver jumped off the ship during a
storm, cut all anchor-ropes and swam 9 miles to Artemissium.

Only many centuries later, the role of the combat swimmer, or frogman,  emerges
again in the history of warfare in November 1918, when allied ships were heavily
damaged or sunk by Italian frogmen. At the same time other countries like England,
Japan, Germany, and Russia, started to use similar tactics.

During the First, and Second World War, the Italians strictly used their combat
swimming teams for underwater demolition. In contrast, English and Amerika started
using frogmen for a broader role in warfare, such as reconnaissance en intelligence. 

Today, combat divers are used for short and long range reconnaissance, intellige
gathering, small scale assaults, and demolition operations, both under and above
water. In some cases, such as with US Navy SEALs and British and Dutch SBS, units
also operate in boarding operations, counter-terrism, and hostage rescue.



INSTALLATION INSTRUCTIONS
-------------------------
extract the COC_DIVER.PBO file, and put in operation flashpoint\res\addons folder.



DISCLAIMER
----------
This is NOT an official Addon. Use it at your own risk. The author does not guarantee
that this software will be fit to serve any purpose. The author will not be held
responsible for any damage these addons might incur, nor will we be responsible for
any problems you might encounter in installing or using this addon. Any problems or
questions with these addons should be posted on the forums of The Chain of Command:
http://www.thechainofcomand.com/

We do our best to make the addons as faultless as possible, but cannot guarantee
that there will not be any.

Be aware that if you are making a mission that uses a custom addon, the addon will need
to be distributed with your mission.
