include/multi_pause.h

   1 /*
   2  * $Logfile: /Freespace2/code/Network/multi_pause.h $
   3  * $Revision$
   4  * $Date$
   5  * $Author$
   6  *
   7  * $Log$
   8  * Revision 1.1  2002/05/03 03:28:12  root
   9  * Initial revision
  10  *
  11  *
  12  * 3     10/13/98 9:29a Dave
  13  * Started neatening up freespace.h. Many variables renamed and
  14  * reorganized. Added AlphaColors.[h,cpp]
  15  *
  16  * 2     10/07/98 10:53a Dave
  17  * Initial checkin.
  18  *
  19  * 1     10/07/98 10:50a Dave
  20  *
  21  * 2     5/07/98 6:26p Dave
  22  * Fix strange boundary conditions which arise when players die/respawn
  23  * while the game is being ended. Spiff up the chatbox doskey thing a bit.
  24  *
  25  * 1     4/14/98 12:18p Dave
  26  *
  27  *
  28  * $NoKeywords: $
  29  */
  30
  31
  32 #ifndef _MULTI_PAUSE_HEADER_FILE
  33 #define _MULTI_PAUSE_HEADER_FILE
  34
  35 // ----------------------------------------------------------------------------------
  36 // PAUSE DEFINES/VARS
  37 //
  38
  39 class UI_WINDOW;
  40 struct net_player;
  41
  42 // state of the game (paused or not) on _my_ machine. Obviously this is important for the server
  43 // call multi_pause_reset() to reinitialize
  44 extern int Multi_pause_status;
  45
  46 // who paused the game
  47 extern net_player *Multi_pause_pauser;
  48
  49
  50 // ----------------------------------------------------------------------------------
  51 // PAUSE FUNCTIONS
  52 //
  53
  54 // re-initializes the pause system. call before entering the mission to reset
  55 void multi_pause_reset();
  56
  57 // send a request to pause or unpause a game (all players should use this function)
  58 void multi_pause_request(int pause);
  59
  60 // (client) call when receiving a packet indicating we should pause
  61 void multi_pause_pause();
  62
  63 // (client) call when receiving a packet indicating we should unpause
  64 void multi_pause_unpause();
  65
  66 // (server) evaluate a pause request from the given player (should call for himself as well)
  67 void multi_pause_server_eval_request(net_player *pl, int pause);
  68
  69 // if we still want to eat keys
  70 int multi_pause_eat_keys();
  71
  72
  73 // ----------------------------------------------------------------------------------
  74 // PAUSE UI FUNCTIONS
  75 //
  76
  77 // initialize multi pause screen
  78 void multi_pause_init(UI_WINDOW *Ui_window);
  79
  80 // do frame for the multi pause screen
  81 void multi_pause_do();
  82
  83 // close the multi pause screen
  84 void multi_pause_close();
  85
  86
  87 #endif
  88