Adding Watercraft to TGE

[b]General[/b]

I've created a Watercraft class, which is quite parallel to the HoverVehicle class.
Someone with more time may want to change this to actually derive Watercraft
from Hovercraft properly. I didn't, since I wasn't sure where I was going to
go with it, until I got there. The Zodiac rubber boat is used as an instance
of a Watercraft.

To add the Watercraft class, and get a functioning boat into your game,
you need to do the following:

A) Download the latest Head release of TGE.
B) Incorporate the Watercraft class files into your engine project.
C) Add a Watercraft control script & vehicle model to your game.
D) Add Watercraft/zodiac support statements to existing scripts.
E) Modify the Collision and Dismount code to accommodate the Watercraft.
F) Test the Zodiac by running the game and inserting the boat with
   the Editor.


[b]Procedure[/b]

[b]A)[/b] If you do not have it, download the latest Head release of TGE. 
   Once you have that working, you can then add the WaterCraft class, 
   with some minor modifications. These modifications are made against
   the Head (which includes the racing demo).
   
[b]B)[/b] Incorporating the class files into your engine project.

   1) Download the 'WaterCraft.zip' file, and extract 'WaterCraft.cc' and
      'Watercraft.h' to the engine directory: engine\game\vehicles.
   
   2) Add 'WaterCraft.cc' to your engine project in the game:vehicles project folder
      (you can add 'WaterCraft.h' to your project as well, but it isn't
      necessary).
   3) Rebuild your project.

[b]C)[/b] Add the Watercraft control script & vehicle model.

   1) Extract the file 'zodiac.cs' from 'WaterCraft.zip' into the game directory:
      fps\server\scripts.
      
   2) Create a directory named 'fps\data\shapes\zodiac'. 
   
   3) Extract the archive file 'zodiac.zip' from the 'WaterCraft.zip' archive.
   
   4) Extract the shape file 'zodiac.dts' from 'zodiac.zip' into the new game directory:
      fps\data\shapes\zodiac.
      
   5) Extract the skin files: 'motorbase.png', 'motortop'.png, 'rubber.png', 'transoms.png' and
      'prop.png' into the new game directory: fps\data\shapes\zodiac.
      

[b]D)[/b] Add Watercraft/zodiac support statements to existing scripts.

   1) in the script 'fps\server\script\sgame.cs' add
   
      exec("./Zodiac.cs");
      
      to the function 'createGame();' after the last 'exec' statement.
      
[b]E)[/b] Modify the Collision and Dismount code to accommodate the Watercraft.

   1) In the file 'fps\server\scripts\player.cs' find the conditional that
      tests for vehicle type in the Armor::onCollision method:
      
      if ((%this.className $= WheeledVehicleData ) && %obj.mountVehicle &&
            %obj.getState() $= "Move" && %col.mountable) {
       
      
      and change it to this:
      
      [b]
      if ((%this.className $= WheeledVehicleData ||
            %this.className $= WaterCraftData) && %obj.mountVehicle &&
            %obj.getState() $= "Move" && %col.mountable) {
      [/b]
         
         This checks for the Watercraft data type to allow for mounting them.
         
    2) In the same file, find the Armor::doDismount method (just above onCollision)
       and locate the following section:
        
      if (%forced && %success == -1)
         %pos = %oldPos;
   
      %obj.mountVehicle = false;
      %obj.schedule(4000, "MountVehicles", true);
     
      
      and change it to this:
      
      [b]
      if (%forced && %success == -1)
         %pos = %oldPos;
      %obj.unmount();
      %obj.setControlObject(%obj);
      if(%obj.mVehicle)
      {
          %obj.mVehicle.getDataBlock().playerDismounted(%obj.mVehicle, %obj);
          %obj.mVehicle.mountable = true;
      }
      %obj.mountVehicle = false;
      %obj.schedule(4000, "MountVehicles", true);
      [/b]
          
       Note: the collision & mount/dismount code is based on the tutorial
             provided by Badguy, found in the GG Resources.
       
       
[b]F)[/b] Test the Zodiac by running the game and inserting the boat with
   the Editor.
   
      1) Start a mission that has plenty of water in it.
   
      2) Use the World Editor Creator (F11, F4) and select the
         Zodiac from the list of Shapes->Vehicles.
         
      3) Depending on how you have things set in your world, when you
         place the boat, it should spawn just a few metres above the
         water, then slowly settle into it. If you have wave action set on, 
         you may see the boat get swamped, then bob back up slowly.
        
      4) Run and jump into the boat to mount, or place the camera over the
         boat and use F7 to drop the player in from the camera position.
         
      5) Use your WASD action keys to control boat speed, use the mouse to
         control direction.
         
      6) Experiment with the settings in the datablock in 'Zodiac.cs' to adjust
         it's movement behaviour, beaching capabilities and so on.
         
 
 There is a posting in the SDK forums from a fellow about how to synchronize
 with the wave action correctly, but I can't find it ...