include/hudescort.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/Hud/HUDescort.h $
  11  * $Revision$
  12  * $Date$
  13  * $Author$
  14  *
  15  * Header file for managing and displaying ships that are in an escort
  16  *
  17  * $Log$
  18  * Revision 1.2  2002/06/09 04:41:13  relnev
  19  * added copyright header
  20  *
  21  * Revision 1.1.1.1  2002/05/03 03:28:12  root
  22  * Initial import.
  23  *
  24  *
  25  * 6     7/30/99 7:01p Dave
  26  * Dogfight escort gauge. Fixed up laser rendering in Glide.
  27  *
  28  * 5     5/24/99 11:28a Dave
  29  * Sexpression for adding/removing ships from the hud escort list.
  30  *
  31  * 4     3/04/99 9:22a Andsager
  32  * Make escort list work with ship-is-visible.  When not visible, dump,
  33  * when becoming visible, maybe add.
  34  *
  35  * 3     11/05/98 5:55p Dave
  36  * Big pass at reducing #includes
  37  *
  38  * 2     10/07/98 10:53a Dave
  39  * Initial checkin.
  40  *
  41  * 1     10/07/98 10:49a Dave
  42  *
  43  * 9     4/30/98 3:32p Lawrance
  44  * Cull dead/departed ships from escort ship in hud_update_frame()
  45  *
  46  * 8     3/02/98 11:31p Lawrance
  47  * create functions to access ships on escort list
  48  *
  49  * 7     2/26/98 10:07p Hoffoss
  50  * Rewrote state saving and restoring to fix bugs and simplify the code.
  51  *
  52  * 6     1/20/98 4:45p Allender
  53  * made HUD escorts which arrive late show up on list
  54  *
  55  * 5     11/24/97 10:20p Lawrance
  56  * Add key 'KEY_N' to target next ship on monitoring view
  57  *
  58  * 4     11/18/97 5:58p Lawrance
  59  * flash escort view info when that ship is taking hits
  60  *
  61  * 3     11/13/97 10:46p Lawrance
  62  * implemented new escort view, damage view and weapons
  63  *
  64  * 2     8/19/97 11:46p Lawrance
  65  * adding new hud gauges for shileds, escort view, and weapons
  66  *
  67  * 1     8/19/97 3:13p Lawrance
  68  *
  69  * $NoKeywords: $
  70  */
  71
  72 #ifndef __FREESPACE_HUDESCORT_VIEW_H__
  73 #define __FREESPACE_HUDESCORT_VIEW_H__
  74
  75 void    hud_escort_init();
  76 void    hud_setup_escort_list(int level = 1);
  77 void    hud_display_escort();
  78 void    hud_escort_view_toggle();
  79 void    hud_add_remove_ship_escort(int objnum, int supress_feedback = 0);
  80 void    hud_escort_clear_all();
  81 void    hud_escort_ship_hit(object *objp, int quadrant);
  82 void    hud_escort_target_next();
  83 void    hud_escort_cull_list();
  84 void    hud_add_ship_to_escort(int objnum, int supress_feedback);
  85 void  hud_remove_ship_from_escort(int objnum);
  86 int     hud_escort_num_ships_on_list();
  87 int     hud_escort_return_objnum(int index);
  88 void    hud_escort_add_player(short id);
  89 void    hud_escort_remove_player(short id);
  90
  91 #endif /* __FREESPACE_HUDESCORT_VIEW_H__ */
  92