Gametypes

//automatically load any mission type that follows naming convention typeGame.name.cs
%search = "scripts/*Game.cs";
for(%file = findFirstFile(%search); %file !$= ""; %file = findNextFile(%search))
{
   %type = fileBase(%file); // get the name of the script
   exec("scripts/" @ %type @ ".cs");
}

if($CurrentMissionType $= "")
{
   new ScriptObject(Game) {
      class = DefaultGame;
   };
}
else
{
   new ScriptObject(Game) {
      class = $CurrentMissionType @ "Game";      // e.g. "CTFGame"
      superClass = DefaultGame;
   };
}
// allow the game to activate any packages.
Game.activatePackages();

function DefaultGame::activatePackages(%game)
{
   // activate the default package for the game type
   activatePackage(DefaultGame);
   if(isPackage(%game.class) && %game.class !$= DefaultGame)
      activatePackage(%game.class);
}

function DefaultGame::deactivatePackages(%game)
{
   deactivatePackage(DefaultGame);
   if(isPackage(%game.class) && %game.class !$= DefaultGame)
      deactivatePackage(%game.class);
}

package CTFGame {
   function ShapeBaseData::onDestroyed(%data, %obj)
   {
      … CTF-specific scoring for destroyed objects …
   }
   …
};

// DisplayName = Capture the Flag         ← 1. metadata comment

//--- GAME RULES BEGIN ---
//Prevent enemy from capturing your flag
//Score one point for grabbing the enemy's flag
//To capture, your flag must be at its stand
//Score 100 points each time enemy flag is captured
//--- GAME RULES END ---

//exec the AI scripts
exec("scripts/aiCTF.cs");                 ← 2. AI companion file

function CTFGame::initGameVars(%game)     ← 3. namespaced methods
{
   %game.SCORE_PER_KILL = 1;
   %game.SCORE_PER_PLYR_FLAG_CAP = 3;
   %game.SCORE_PER_TEAM_FLAG_CAP = 100;
   …
   %game.FLAG_RETURN_DELAY = 45 * 1000; //45 seconds
   %game.TIME_CONSIDERED_FLAGCARRIER_THREAT = 3 * 1000;
   %game.RADIUS_GEN_DEFENSE = 20;  //meters
}
…

package CTFGame {                          ← 4. the package
   …
};

function getMissionTypeDisplayNames()
{
   %file = new FileObject();
   for ( %type = 0; %type < $HostTypeCount; %type++ )
   {
      $HostTypeDisplayName[%type] = $HostTypeName[%type];
      if ( %file.openForRead( "scripts/" @ $HostTypeName[%type] @ "Game.cs" ) )
      {
         while ( !%file.isEOF() )
         {
            %line = %file.readLine();
            if ( getSubStr( %line, 0, 17 ) $= "// DisplayName = " )
            {
               $HostTypeDisplayName[%type] = getSubStr( %line, 17, 1000 );
               break;
            }
         }
      }
   }
   %file.delete();
}

function CTFGame::initGameVars(%game)
{
   %game.SCORE_PER_KILL                        = 1;
   %game.SCORE_PER_SUICIDE                     = -1;
   %game.SCORE_PER_TEAMKILL                    = -1;
   %game.SCORE_PER_DEATH                       = -1;
   %game.SCORE_PER_PLYR_FLAG_CAP               = 3;
   %game.SCORE_PER_TEAM_FLAG_CAP               = 100;
   %game.SCORE_PER_TEAM_FLAG_TOUCH             = 1;
   %game.SCORE_PER_GEN_DESTROY                 = 2;
   %game.SCORE_PER_ESCORT_ASSIST               = 1;
   %game.SCORE_PER_TURRET_KILL                 = 1;
   %game.SCORE_PER_FLAG_DEFEND                 = 1;
   %game.SCORE_PER_CARRIER_KILL                = 1;
   %game.SCORE_PER_FLAG_RETURN                 = 1;
   %game.SCORE_PER_GEN_DEFEND                  = 1;
   %game.SCORE_PER_GEN_REPAIR                  = 1;

   %game.FLAG_RETURN_DELAY                     = 45 * 1000; //45 seconds
   %game.TIME_CONSIDERED_FLAGCARRIER_THREAT    = 3 * 1000;  //after damaging enemy flag carrier
   %game.RADIUS_GEN_DEFENSE                    = 20;        //meters
   …
}

package MyMod
{
   function CTFGame::initGameVars(%game)
   {
      Parent::initGameVars(%game);
      %game.SCORE_PER_TEAM_FLAG_CAP = 50;
      %game.FLAG_RETURN_DELAY = 20 * 1000;
   }
};

function Weapon::onUse(%data, %obj)
{
   if(Game.weaponOnUse(%data, %obj))            // ← return false to block
      if (%obj.getDataBlock().className $= Armor)
         %obj.mountImage(%data.image, $WeaponSlot);
}

// DisplayName = Race

//--- GAME RULES BEGIN ---
//Reach every checkpoint in order, then return to the start
//Fastest lap wins
//--- GAME RULES END ---

//------------------------------------------------------------------------------
function RaceGame::initGameVars(%game)
{
   Parent::initGameVars(%game);

   %game.SCORE_PER_CHECKPOINT = 1;
   %game.SCORE_PER_LAP        = 25;
   %game.LAP_COUNT            = 3;
   %game.numTeams             = 1;      // free-for-all
}

//------------------------------------------------------------------------------
function RaceGame::missionLoadDone(%game)
{
   Parent::missionLoadDone(%game);

   %game.checkpointCount = 0;
   // Count the checkpoint triggers the .mis placed.
   for (%i = 0; %i < MissionGroup.getCount(); %i++)
   {
      %obj = MissionGroup.getObject(%i);
      if (%obj.getName() $= "checkpoint" @ %game.checkpointCount)
         %game.checkpointCount++;
   }
   echo("RaceGame: " @ %game.checkpointCount @ " checkpoints");
}

//------------------------------------------------------------------------------
function RaceGame::equip(%game, %player)
{
   // No weapons in a race.
   %player.clearInventory();
   %player.setInventory(RepairKit, 1);
}

//------------------------------------------------------------------------------
function RaceGame::onEnterTrigger(%game, %triggerName, %data, %obj, %colobj)
{
   if (getSubStr(%triggerName, 0, 10) !$= "checkpoint")
   {
      Parent::onEnterTrigger(%game, %triggerName, %data, %obj, %colobj);
      return;
   }

   %client = %colobj.client;
   if (!isObject(%client))
      return;

   %index = getSubStr(%triggerName, 10, 10);
   if (%index != %client.nextCheckpoint)
      return;                                   // out of order — ignore

   %client.nextCheckpoint++;
   %game.recalcScore(%client);

   if (%client.nextCheckpoint >= %game.checkpointCount)
   {
      %client.nextCheckpoint = 0;
      %client.laps++;
      bottomPrint(%client, "Lap " @ %client.laps @ " of " @ %game.LAP_COUNT, 3, 1);

      if (%client.laps >= %game.LAP_COUNT)
         %game.gameOver();
   }
   else
      bottomPrint(%client, "Checkpoint " @ %client.nextCheckpoint, 2, 1);
}

//------------------------------------------------------------------------------
function RaceGame::clientJoinTeam(%game, %client, %team, %respawn)
{
   Parent::clientJoinTeam(%game, %client, %team, %respawn);
   %client.nextCheckpoint = 0;
   %client.laps = 0;
}

//------------------------------------------------------------------------------
// Gametype-scoped overrides go in the package — automatically activated when a
// Race mission loads, deactivated when it ends.
package RaceGame
{
   function Weapon::onUse(%data, %obj)
   {
      // Weapons are disabled entirely in Race.
   }
};

package MyMod
{
   function CTFGame::initGameVars(%game)
   {
      Parent::initGameVars(%game);
      %game.SCORE_PER_TEAM_FLAG_CAP = 50;
   }

   function DefaultGame::onClientKilled(%game, %clVictim, %clKiller, %damageType,
                                        %implement, %damageLocation)
   {
      Parent::onClientKilled(%game, %clVictim, %clKiller, %damageType,
                             %implement, %damageLocation);

      if (%damageType == $DamageType::ShockLance)
         messageAll('MyModStyleKill', '\c2%1 shocked %2!',
                    getTaggedString(%clKiller.name), getTaggedString(%clVictim.name));
   }
};
activatePackage(MyMod);

// deactivating old master list server protocol handlers in script
// sending a game type list to a dedicated server would result in a massive number
// of nuiscance calls to the following functions, and spam the console with pages of errors
// the errors were the main source of CPU utilization, so just setting stubs is adequate protection
function addGameType()                 { return; }
function clearGameTypes()              { return; }
function clearMissionTypes()           { return; }
function sortGameAndMissionTypeLists() { return; }