include/contexthelp.h

   1 // ContextHelp.h
   2 //
   3 //
   4
   5 #ifndef __CONTEXTHELP_H__
   6 #define __CONTEXTHELP_H__
   7
   8 // Help overlays
   9 //
  10 // Adding a help overlay:    1) Add a #define that uniquely identifies your help overlay
  11 //                                                                        2) Increment MAX_HELP_OVERLAYS
  12 //                                                                        3) Add the filename for the help overlay to Help_overlays[] array in ContextHelp.cpp
  13 //
  14 #define MAX_HELP_OVERLAYS                               16      // Must be kept current
  15
  16 #define SS_OVERLAY                                              0       // ship selection help
  17 #define WL_OVERLAY                                              1       // weapons loadout help
  18 #define BR_OVERLAY                                              2       // briefing help
  19 #define MH_OVERLAY                                              3       // main hall help
  20 #define BARRACKS_OVERLAY                                4       // barracks help
  21 #define CONTROL_CONFIG_OVERLAY          5       // control config help
  22 #define DEBRIEFING_OVERLAY                      6       // debriefing help
  23 #define MULTI_CREATE_OVERLAY                    7       // multi create game help
  24 #define MULTI_START_OVERLAY                     8       // multi start game help overlay
  25 #define MULTI_JOIN_OVERLAY                      9       // join game help overlay
  26 #define MH2_OVERLAY                                             10      // main hall 2 help overlay
  27 #define HOTKEY_OVERLAY                                  11 // hotkey assignment help overlay
  28 #define CAMPAIGN_ROOM_OVERLAY           12 // campaign room help overlay
  29 #define SIM_ROOM_OVERLAY                                13      // sim room help overlay
  30 #define TECH_ROOM_OVERLAY                               14      // tech room (general) help overlay
  31 #define CMD_BRIEF_OVERLAY                               15 // command briefing help overlay
  32
  33 // other help overlay constants
  34 #define HELP_MAX_ITEM                           50                              // max number of screen elements per element type per overlay
  35 #define HELP_PADDING            1                                                       //
  36 #define HELP_MAX_STRING_LENGTH  128                     // max string length for text overlay element
  37 #define HELP_MAX_PLINE_VERTICES 21                              // good for 20 segments, can prolly reduce this (FIXME)
  38 #define HELP_PLINE_THICKNESS            2
  39 #define HELP_OVERLAY_FILENAME           "help.tbl"
  40
  41 // help overlay calls
  42 int     help_overlay_active(int overlay_id);
  43 void    help_overlay_set_state(int overlay_id, int state);
  44 void    help_overlay_load(int overlay_id);
  45 void    help_overlay_unload(int overlay_id);
  46 void    help_overlay_maybe_blit(int overlay_id);
  47
  48 void context_help_init();                       // called once at game startup
  49 void context_help_grey_screen();        // call to grey out a screen (normally when applying a help overlay)
  50
  51 void launch_context_help();
  52
  53
  54 #endif /* __CONTEXTHELP_H__ */
  55