Doc/Obsolete/FELL.txt

   1 ----------------------------------------------------------------------------
   2
   3                 Fatal Error Listing Library (FELL) documentation
   4
   5 ----------------------------------------------------------------------------
   6
   7 Overview:
   8 ---------
   9
  10 A simple system for handing different types of list displays, like the
  11 inventory screen of the game or a high score list.
  12
  13 Classes:
  14 --------
  15
  16 highscore (hscore.h)
  17 --------------------
  18
  19 A class that loads, saves and handles highscore files.
  20
  21 highscore(std::string File = "HScore.dat")
  22
  23         Creates the class and loads a highscore file with specified
  24         filename.
  25
  26 Add(long NewScore, std::string NewEntry)
  27
  28         Adds a new score entry. The class automatically places the
  29         current score to its appropriate position in the list and
  30         resizes the list size to one hundred if its longer than that.
  31         NewEntry should contain the name of player and the cause of
  32         death/victory.
  33
  34         Example of usage:
  35
  36         highscore HScore;
  37         HScore.Add(-1234, "Bill, died of bloodloss after Perttu ate his nuts");
  38         HScore.Save();
  39         HScore.Draw();
  40
  41         Result: Bill is (most likely) placed at the bottom of the score list
  42         and the list is drawn onto the screen.
  43
  44 Draw()
  45
  46         Draws the highscore list and waits for keypress.
  47
  48 Save(std::string File)
  49
  50         Saves the highscore list.
  51
  52 Load(std::string File)
  53
  54         Loads a highscore list. Normally called only by the constructor.
  55
  56 list (list.h)
  57 -------------
  58
  59 A simple list class containing list data and draw-to-screen functions.
  60
  61 list()
  62
  63         Creates an empty list with no topic.
  64
  65 list(std::string Topic)
  66
  67         Creates an empty list with topic Topic.
  68
  69 AddString(std::string S)
  70
  71         Adds an element to the list.
  72
  73 AddDescription(std::string S)
  74
  75         Adds a description to the list. Descriptions are drawn above other
  76         list items and they cannot be selected by alphabet keys. Topic
  77         counts as the first description.
  78
  79 std::string GetString(ushort Index)
  80
  81         Returns a previously added element of the list.
  82
  83 ushort Length()
  84
  85         Returns the total amount of previously added elements.
  86
  87 dynarray<std::string>* CString()
  88
  89         Returns a pointer to the dynamic element array.
  90
  91 ushort Draw(bool WillDrawNumbers)
  92
  93         Draws the list onto the screen above the current DoubleBuffer in
  94         20 element sections and waits for keypress. WillDrawNumbers
  95         determines whether individual alphabet letters are drawn before
  96         every element. Pressing the key of element's letter causes the
  97         function to terminate and return the index of the element selected,
  98         or 0xFFFE if '-' was pressed, 0xFFFD if Escape was pressed and
  99         0xFFFF if an illegal key (not of any element nor '-' or Esc) was
 100         pressed.
 101
 102         Example of usage:
 103
 104         list List("Choose your lord:");
 105         List.Add("Bill");
 106         List.Add("Valpuri");
 107         List.Add("Santa Claus");
 108         if(List.Draw() == 0)
 109         {
 110                 ADD_MESSAGE("Suddenly the dungeon just crashes.");
 111                 game::CPlayer()->CHP(-98);
 112                 game::CPlayer()->CheckDeath("crashed horribly");
 113         }
 114
 115         Result: Guess twice.
 116
 117 DrawDescription()
 118
 119         Draws the description strings. Only used by Draw().
 120
 121 Empty()
 122
 123         Removes all previously added string elements from the list.
 124         Descriptions, however, are not affected.
 125
 126 ----------------------------------------------------------------------------
 127
 128 End of document.