TGB High Scores Object

// FUNCTION: NewHighScores
// PARAMS  : None
// DESC    : Create's a new HighScores object
// USE     : public
function NewHighScores()
{
   if(isObject(%this)) return %this;
   
   %obj = new ScriptObject()
   {
      class = "HighScores";
      MaxCount = 10; // DEFAULT
   };
   return %obj;
}

// FUNCTION: HighScores::setMaximumScores
// PARAMS  :
//   %this   -- object for reference
//   %count  -- maximum number of scores to store
// DESC    : sets the maximum number of scores to store
// USE     : public
function HighScores::setMaximumScores(%this, %count)
{
   %this.MaxCount = %count;
}

// FUNCTION: HighScores::getMaximumScores
// PARAMS  :
//   %this   -- object for reference
// DESC    : returns the number of maximum scores stored
// USE     : public
function HighScores::getMaximumScores(%this)
{
   return %this.MaxCount;
}

// FUNCTION: HighScores::add
// PARAMS  :
//   %this   -- object for reference
//   %player -- player object
//              must contain a PlayerName and PlayerScore Field
//              fields should not equate to empty strings (!$=)
// DESC    : adds a player to the high score stack
//           and returns true/false if they have a high score
// USE     : public
function HighScores::add(%this, %player)
{
   if(isObject(%player))
   {
      if(%player.PlayerName !$= "")
      {
         if(%player.PlayerScore !$= "")
         {
            if(!isObject(%this.Scores)) %this.Scores = new SimSet();
            // players score is lower then lowest score
            // only check if current score count is equal or greater then max score count
            if(%this.Scores.getCount() >= %this.MaxCount)
            {
               if(%this.Scores.getObject(%this.MaxCount - 1).PlayerScore > %player.PlayerScore) return false;
            }

            %s = new SimObject()
            {
               playerName = %player.PlayerName;
               playerScore = %player.PlayerScore;
            };
            %this.Scores.add(%s);
            %this.Sort();
            while(%this.Scores.getCount() > %this.MaxCount)
            {
               %ref = %this.Scores.getObject(%this.Scores.getCount()-1);
               %this.Scores.remove(%ref);
               %ref.delete();
            }
            return true;
         } else { echo("no player score"); return false; }
      } else { echo("no player name"); return false; }
   } else { echo("player is not object"); return false; }
}

// FUNCTION: HighScores::Sort
// PARAMS  :
//   %this   -- object for reference
// DESC    : sorts the high score stack from Top to Bottom
// USE     : internal
function HighScores::Sort(%this)
{
   if(!isObject(%this.Scores)) { echo("Scores is not object"); return false; }
   %scores = HighScores::copySimSet(%this.Scores);
   %this.Scores.clear();
   echo("Scores.getCount() : " @ %this.Scores.getCount());
   echo("%scores.getCount(): " @ %scores.getCount());
   while(%scores.getCount() > 0)
   {
      %high = null;
      %highx = -1;
      for(%x = 0; %x < %scores.getCount(); %x++)
      {
         if(%highx == -1) { %high = %scores.getObject(%x).PlayerScore; %highx = %x; }
         else {
            if(%scores.getObject(%x).PlayerScore >= %high)
            {
               %highx = %x;
               %high = %scores.getObject(%x).PlayerScore;
            }
         }
      }
      %this.Scores.add(%scores.getObject(%highx));
      %scores.remove(%scores.getObject(%highx));
   }
   %scores.delete(); // Jeremy
}

// FUNCTION: HighScores::getScore
// PARAMS  :
//   %this   -- object for reference
//   %rank   -- the high score rank to return
// DESC    : returns the score of %rank
// USE     : public
function HighScores::getScore(%this, %rank)
{
   if(!isObject(%this.Scores)) return -1;
   if(%this.Scores.getCount() < %rank - 1) return -1;
   return %this.Scores.getObject(%rank).PlayerScore;
}

// FUNCTION: HighScores::getPlayer
// PARAMS  :
//   %this   -- object for reference
//   %rank   -- rank of player object to return
// DESC    : returns player object with %rank score
// USE     : public
function HighScores::getPlayer(%this, %rank)
{
   if(!isObject(%this.Scores)) return -1;
   if(%this.Scores.getCount() < %rank - 1) return -1;
   return %this.Scores.getObject(%rank).PlayerName;
}

// FUNCTION: HighScores::getPlayerScore
// PARAMS  :
//   %this   -- object for reference
//   %rank   -- rank of score to return
// DESC    : returns score of player at %rank
// USE     : public
function HighScores::getPlayerScore(%this, %rank)
{
   if(!isObject(%this.Scores)) return -1;
   if(%this.Scores.getCount() < %rank - 1) return -1;
   return %this.Scores.getObject(%rank);
}

// FUNCTION: HighScores::getRank
// PARAMS  :
//   %this   -- object for reference
//   %player -- player to locate
// DESC    : returns rank for %player
// USE     : public
function HighScores::getRank(%this, %player)
{
   if(!isObject(%this.Scores)) return -1;
   if(%player.PlayerName $= "") return -1;
   for(%x = 0; %x < %this.Scores.getCount(); %x++)
   {
      if(%this.Scores.getObject(%x).PlayerName $= %player.PlayerName) return %x; // rank
   }
}

// FUNCTION: HighScores::save
// PARAMS  :
//   %this   -- object for reference
//   %path   -- path to save as
// DESC    : saves high score object to %path
// USE     : public
function HighScores::save(%this, %path)
{
   if(!isObject(%this.Scores)) return false;

   %save = new SimSet(HighScoreSavedSet);
   %save.add(%this);
   for(%x=0;%x<%this.Scores.getCount();%x++)
   {
      %save.add(%this.Scores.getObject(%x));
   }
   return %save.save(%path);
}

// FUNCTION: HighScores::load
// PARAMS  :
//   %path   -- path to save file
// DESC    : returns a HighScores object
//           previously saved to %path
// USE     : public
function HighScores::load(%path)
{
   if(isObject(%path)) return; // call HighScores::load('path');
   %obj = NewHighScores();
   exec(%path);
   %load = HighScoreSavedSet;
   %obj.MaxCount = %load.getObject(0).MaxCount;
   %load.remove(%load.getObject(0));
   %obj.Scores = new SimSet();
   for(%x=0;%x<%load.getCount();%x++)
   {
      %obj.Scores.add(%load.getObject(%x));
   }
   %load.clear();
   HighScoreSavedSet.delete();
   if(isObject(%load)) echo("%load is still an object");
   if(isObject(HighScoreSavedSet)) echo("HighScoreSavedSet is still an object");
   return %obj;
}

// FUNCTION: HighScores::copySimSet
// PARAMS  :
//   %set  : set to copy
// DESC    : returns a copy of %set
// USE     : internal
function HighScores::copySimSet(%set)
{
   if(!%set.IsMemberOfClass("SimSet")) return false;
   %obj = new SimSet();
   for(%x = 0; %x < %set.getCount(); %x++)
   {
      %obj.add(%set.getObject(%x));
   }
   return %obj;
}

// FUNCTION: HighScores::debug
// PARAMS  : none
// DESC    : echo's high score table to console
// USE     : internal
function HighScores::debug(%this)
{
   if(!isObject(%this.Scores))
   {
      echo("No Scores in Stack");
      return;
   }
   for(%x=0;%x<%this.Scores.getCount();%x++)
   {
      echo("  Player: " @ %this.Scores.getObject(%x).PlayerName);
      echo("  Scores: " @ %this.Scores.getObject(%x).PlayerScore);
      echo(" ");
   }
}