include/multi_pause.h

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