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