include/multi_options.h

   1 /*
   2  * $Logfile: /Freespace2/code/Network/multi_options.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  * 6     4/20/99 6:39p Dave
  13  * Almost done with artillery targeting. Added support for downloading
  14  * images on the PXO screen.
  15  *
  16  * 5     2/19/99 2:55p Dave
  17  * Temporary checking to report the winner of a squad war match.
  18  *
  19  * 4     2/12/99 6:16p Dave
  20  * Pre-mission Squad War code is 95% done.
  21  *
  22  * 3     11/19/98 4:19p Dave
  23  * Put IPX sockets back in psnet. Consolidated all multiplayer config
  24  * files into one.
  25  *
  26  * 2     10/07/98 10:53a Dave
  27  * Initial checkin.
  28  *
  29  * 1     10/07/98 10:50a Dave
  30  *
  31  * 12    7/07/98 2:49p Dave
  32  * UI bug fixes.
  33  *
  34  * 11    5/03/98 7:04p Dave
  35  * Make team vs. team work mores smoothly with standalone. Change how host
  36  * interacts with standalone for picking missions. Put in a time limit for
  37  * ingame join ship select. Fix ingame join ship select screen for Vasudan
  38  * ship icons.
  39  *
  40  * 10    5/03/98 2:52p Dave
  41  * Removed multiplayer furball mode.
  42  *
  43  * 9     4/30/98 12:57a Dave
  44  * Put in new mode for ship/weapon selection. Rearranged how game querying
  45  * is done a bit.
  46  *
  47  * 8     4/22/98 5:53p Dave
  48  * Large reworking of endgame sequencing. Updated multi host options
  49  * screen for new artwork. Put in checks for host or team captains leaving
  50  * midgame.
  51  *
  52  * 7     4/16/98 11:39p Dave
  53  * Put in first run of new multiplayer options screen. Still need to
  54  * complete final tab.
  55  *
  56  * 6     4/09/98 11:01p Dave
  57  * Put in new multi host options screen. Tweaked multiplayer options a
  58  * bit.
  59  *
  60  * 5     4/09/98 5:43p Dave
  61  * Remove all command line processing from the demo. Began work fixing up
  62  * the new multi host options screen.
  63  *
  64  * 4     4/06/98 10:24p Dave
  65  * Fixed up Netgame.respawn for the standalone case.
  66  *
  67  * 3     4/06/98 6:37p Dave
  68  * Put in max_observers netgame server option. Make sure host is always
  69  * defaulted to alpha 1 or zeta 1. Changed create game so that MAX_PLAYERS
  70  * can always join but need to be kicked before commit can happen. Put in
  71  * support for server ending a game and notifying clients of a special
  72  * condition.
  73  *
  74  * 2     3/31/98 4:51p Dave
  75  * Removed medals screen and multiplayer buttons from demo version. Put in
  76  * new pilot popup screen. Make ships in mp team vs. team have proper team
  77  * ids. Make mp respawns a permanent option saved in the player file.
  78  *
  79  * 1     3/30/98 6:24p Dave
  80  *
  81  *
  82  * $NoKeywords: $
  83  */
  84
  85 #ifndef _MULTI_NETGAME_OPTIONS_HEADER_FILE
  86 #define _MULTI_NETGAME_OPTIONS_HEADER_FILE
  87
  88 // ----------------------------------------------------------------------------------
  89 // MULTI OPTIONS DEFINES/VARS
  90 //
  91
  92 struct header;
  93 struct netgame_info;
  94 struct net_player;
  95
  96 // global options
  97 #define STD_PASSWD_LEN                  16
  98 #define STD_NAME_LEN                            32
  99 #define MULTI_OPTIONS_STRING_LEN                        256
 100 typedef struct multi_global_options {
 101         // common options
 102         int             protocol;                                                                                                       // selected network protocol
 103         ushort  port;                                                                                                                   // port we're running on - for allowing multiple servers on one machine
 104         int             log;                                                                                                                    // use a logfile
 105         int             datarate_cap;                                                                                           // datarate cap for OBJ_UPDATE_HIGH
 106         char            user_tracker_ip[MULTI_OPTIONS_STRING_LEN];              // ip address of user tracker
 107         char            game_tracker_ip[MULTI_OPTIONS_STRING_LEN];              // ip address of game tracker
 108         char            pxo_ip[MULTI_OPTIONS_STRING_LEN];                                       // ip address of pxo chat server
 109         char            pxo_rank_url[MULTI_OPTIONS_STRING_LEN];                 // URL of pxo rankings page
 110         char            pxo_create_url[MULTI_OPTIONS_STRING_LEN];                       // URL of pxo create account page
 111         char            pxo_verify_url[MULTI_OPTIONS_STRING_LEN];                       // URL of pxo account validation page
 112         char            pxo_banner_url[MULTI_OPTIONS_STRING_LEN];                       // URL of pxo banner files
 113
 114         // standalone only options
 115         int             std_max_players;                                                                                        // max players allowed on the standalone
 116         int             std_datarate;                                                                                           // some OBJ_UPDATE_* value
 117         int             std_voice;                                                                                                      // should standalone allow voice
 118         char            std_passwd[STD_PASSWD_LEN];                                                     // standalone host password
 119         char            std_pname[STD_NAME_LEN];                                                                // permanent name for the standalone - if any
 120         int             std_framecap;                                                                                           // standalone frame cap
 121 } multi_global_options;
 122
 123 extern multi_global_options Multi_options_g;
 124
 125 // local (netplayer - nonserver) options - maintained on individual clients and on the server (no need for other clients to know this guy's settings)
 126 #define MAX_OBJ_UPDATE_LEVELS                                           4                                       // the # of object update levels there are
 127 #define OBJ_UPDATE_LOW                                                          0                                       // low object updates
 128 #define OBJ_UPDATE_MEDIUM                                                       1                                       // medium object updates
 129 #define OBJ_UPDATE_HIGH                                                         2                                       // high object updates
 130 #define OBJ_UPDATE_LAN                                                          3                                       // ultra-high updates - no capping at all
 131
 132 #define MLO_FLAG_ACCEPT_PIX                                             (1<<0)                  // accept pix from server (pilot pics, squadron logos, etc)
 133 #define MLO_FLAG_NO_VOICE                                                       (1<<1)                  // turn off voice altogether
 134 #define MLO_FLAG_LOCAL_BROADCAST                                        (1<<2)                  // broadcast on the local subnet when looking for games
 135 #define MLO_FLAG_FLUSH_CACHE                                            (1<<3)                  // flush the multidata cache before every game
 136 #define MLO_FLAG_XFER_MULTIDATA                                 (1<<4)                  // xfer mission files to the multidata cache directory
 137 #define MLO_FLAG_TEMP_CLOSED                                            (1<<5)                  // send to standalone to tell him to toggle the temp closed status
 138
 139 // BE AWARE : any changes made to this structure will mess with the player file. it will have to be upped!!!!
 140 typedef struct multi_local_options {
 141         int flags;                                                                                                                                      // misc player options
 142         int obj_update_level;                                                                                                   // one off the flags above indicating how often to refresh objects
 143 } multi_local_options;
 144
 145 // server options - maintained on the server _and_ clients
 146 #define MSO_SQUAD_RANK                                                          0                                               // only highest ranking players can message
 147 #define MSO_SQUAD_LEADER                                                        1                                               // only wingleaders can message
 148 #define MSO_SQUAD_ANY                                                           2                                               // anyone can message
 149 #define MSO_SQUAD_HOST                                                          3                                               // only the host can message
 150
 151 #define MSO_END_RANK                                                                    0                                               // only the highest ranking players and the host can end the mission
 152 #define MSO_END_LEADER                                                          1                                               // only team/wing leaders and the host can end the mission
 153 #define MSO_END_ANY                                                                     2                                               // any player can end the mission
 154 #define MSO_END_HOST                                                                    3                                               // only the host can end the mission
 155
 156 #define MSO_FLAG_INGAME_XFER                                            (1<<0)                          // netgame allows file xfers to ingame joiners
 157 #define MSO_FLAG_ACCEPT_PIX                                             (1<<1)                          // netgame allows pilot pix, squad logos
 158 #define MSO_FLAG_NO_VOICE                                                       (1<<2)                          // netgame is disallowing voice altogether
 159 #define MSO_FLAG_SS_LEADERS                                             (1<<3)                          // in ship/weapon select, only host or team captains can modify ships
 160
 161 // BE AWARE : any changes made to this structure will mess with the player file. it will have to be upped!!!!
 162 typedef struct multi_server_options {
 163         // misc settings and flags
 164         ubyte squad_set;                                                                                                                        // see MSO_SQUAD_*
 165         ubyte endgame_set;                                                                                                              // see MSO_END_*
 166         int flags;                                                                                                                                      // see MSO_FLAG_*
 167
 168         // default respawn count
 169         uint respawn;
 170
 171         // default max # of observers
 172         ubyte max_observers;
 173
 174         // default skill level
 175         ubyte skill_level;
 176
 177         // voice settings
 178         ubyte voice_qos;                                                                                                                        // voice quality of sound
 179         int voice_token_wait;                                                                                                   // min time between token gets for a given player
 180         int voice_record_time;                                                                                                  // max duration for voice recording (in ms)
 181
 182         // time limit
 183         fix mission_time_limit;                                                                                                 // mission time limit (set to -1 for no limit)
 184
 185         // kill limit
 186         int kill_limit;                                                                                                                 // kill limit for a furball mission
 187 } multi_server_options;
 188
 189
 190 // ----------------------------------------------------------------------------------
 191 // MULTI OPTIONS FUNCTIONS
 192 //
 193
 194 // load in the config file
 195 void multi_options_read_config();
 196
 197 // set netgame defaults
 198 // NOTE : should be used when creating a newpilot
 199 void multi_options_set_netgame_defaults(multi_server_options *options);
 200
 201 // set local netplayer defaults
 202 // NOTE : should be used when creating a newpilot
 203 void multi_options_set_local_defaults(multi_local_options *options);
 204
 205 // fill in the passed netgame options struct with the data from my player file data (only host/server should do this)
 206 void multi_options_netgame_load(multi_server_options *options);
 207
 208 // fill in the passed local options struct with the data from my player file data (all machines except standalone should do this)
 209 void multi_options_local_load(multi_local_options *options, net_player *pxo_pl);
 210
 211 // update everyone on the current netgame options
 212 void multi_options_update_netgame();
 213
 214 // update everyone with my local settings
 215 void multi_options_update_local();
 216
 217 // update the standalone with the settings I have picked at the "start game" screen
 218 void multi_options_update_start_game(netgame_info *ng);
 219
 220 // update the standalone with the mission settings I have picked (mission filename, etc)
 221 void multi_options_update_mission(netgame_info *ng, int campaign_mode);
 222
 223
 224 // ----------------------------------------------------------------------------------
 225 // MULTI OPTIONS FUNCTIONS
 226 //
 227
 228 // process an incoming multi options packet
 229 void multi_options_process_packet(unsigned char *data, header *hinfo);
 230
 231
 232 #endif
 233