Generated from report_m.c with ROBODoc v3.2.2 on Sun Aug 27 19:47:35 2000

TABLE OF CONTENTS

  1. GalaxyNG/MReport
  2. GalaxyNG/rMR_M
  3. MReport/rAP_M
  4. MReport/rBB_M
  5. MReport/rBT_M
  6. MReport/rEN_M
  7. MReport/rFL_M
  8. MReport/rGG_M
  9. MReport/rGP_M
  10. MReport/rGS_M
  11. MReport/rHE_M
  12. MReport/rIC_M
  13. MReport/rMK_M
  14. MReport/rMM_M
  15. MReport/rMP_M
  16. MReport/rOD_M
  17. MReport/rOP_M
  18. MReport/rPD_M
  19. MReport/rPL_M
  20. MReport/rPT_M
  21. MReport/rRT_M
  22. MReport/rSH_M
  23. MReport/rST_M
  24. MReport/report_m

GalaxyNG/MReport

NAME
   MReport -- machine report
PURPOSE
   Contains functions that create a turn report in a format
   that is more easy to understand for machines.
AUTHOR
   Christophe  Barbier
HISTORY
   199809: Creation of a machine report
   199903: 
     Corrected a bug in number of uninhabited planets Replaced
     semi-colon delimitor with space (native separator in tcl/tk)
     Section header : 
       Added a space before the "greater" sign, thus last record is
       no longer "polluted".  * Removed useless key words
       Try to get a standard form for header of each section :
       <section-name(only one word) name(if any) number-of-elements >
       Try to get a (poor) standard form in groups record : each
       alien group or group in a battle begin with a 0 (for his
       number)
       Section format (groups, battles...) is now :
       <"section name" "battle or location name" quantity >
       Messages section is now :
       <messages "global or personal" quantity >
   199904: 
     added report version, and galaxy size.  Groups record in battle
     now almost the same that in "normal situations"
   199911: 
       FS, updated for the use of game structure.
TODO
   write a doc :).

GalaxyNG/rMR_M

NAME
   rMR_M --
FUNCTION
   Write the machine report version May be it can help turns viewers
   creators, when changes in machine report break the compatibility
   with previous versions

MReport/rAP_M

NAME
   rAP_M --
FUNCTION
   report (all) planets 

MReport/rBB_M

NAME
   rBB_M --
FUNCTION
   report bombings 

MReport/rBT_M

NAME
   rBT_M --
FUNCTION
   report battles 

MReport/rEN_M

NAME
   rEN_M --
FUNCTION
   Write last line of file report 

MReport/rFL_M

NAME
   rFL_M --
FUNCTION
   Report fleets 

MReport/rGG_M

NAME
   rGG_M --
FUNCTION
   report groups

MReport/rGP_M

NAME
   rGP_M --
FUNCTION
   report groups (it's a sub routine) 

MReport/rGS_M

NAME
   rGS_M --
FUNCTION
   Report groups seen 

MReport/rHE_M

NAME
   rHE_M --
FUNCTION
   Write header of report file 

MReport/rIC_M

NAME
   rIC_M
FUNCTION
   report incomming groups 

MReport/rMK_M

NAME
   rMK_M --
 FUNCION
   report mistakes 

MReport/rMM_M

NAME
   rMM_M --
FUNCTION
   report global or personnal messages.

MReport/rMP_M

NAME
   rMP_M --
FUNCTION
   report text based map 

MReport/rOD_M

NAME
   rOD_M --
FUNCTION
   report orders 

MReport/rOP_M

NAME
   rOP_M --
FUNCTION
   report options

MReport/rPD_M

NAME
   rPD_M --
FUNCTION
   report production (it's a sub routine) 

MReport/rPL_M

NAME
   rPL_M --
FUNCTION
   report planets (it's a sub routine) 

MReport/rPT_M

NAME
   rPT_M --
FUNCTION
   report production tables 

MReport/rRT_M

NAME
   rRT_M --
FUNCTION
   report routes

MReport/rSH_M

NAME
   rSH_M --
FUNCTION
   Report ship types. 

MReport/rST_M

NAME
   rST_M --
FUNCTION
   report status of players 

MReport/report_m

NAME
   report_m -- create machine report.
SYNOPSIS
   void report_m(player *P, game *aGame, FILE *reportFile)
SEE ALSO
   report()
SOURCE
    void
    report_m(player *P, game *aGame, FILE * reportFile)
    {
      Mreport = reportFile;
    
      rHE_M(aGame, P);              /* Writes header of report file */
      rMR_M();                      /* Machine report version */
      rGZ_M(aGame);                 /* Size of the galaxy */
      rMM_M(aGame, P, aGame->messages, "global");   /* Global messages  *  */
      rMM_M(aGame, P, P->messages, "personnal");    /* Personnal * * messages */
      rOP_M(aGame, P);              /* Options */
      rOD_M(aGame, P);              /* Orders */
      rMK_M(aGame, P);              /* Mistakes in orders */
      rST_M(aGame, P);              /* Players status */
      rSH_M(aGame, P);              /* Ship types */
      rBT_M(aGame, P);              /* Battles */
      rBB_M(aGame, P);              /* Bombing */
      rMP_M(aGame, P);              /* Text map */
      rIC_M(aGame, P);              /* Incomming groups */
      rAP_M(aGame, P);              /* All planets */
      rPT_M(aGame, P);              /* Production table */
      rRT_M(aGame, P);              /* Routes */
      rGG_M(aGame, P);              /* Player's groups */
      rGS_M(aGame, P);              /* Others players groups */
      rFL_M(aGame, P);              /* Fleets */
      rEN_M();                      /* Writes last line of machine report file 
                                     * 
                                     * *  * *  * *  * *  */
    }