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 the 6 * source. 7 * 8 */ 9 10 // ContextHelp.h 11 // 12 // 13 14 #ifndef __CONTEXTHELP_H__ 15 #define __CONTEXTHELP_H__ 16 17 // Help overlays 18 // 19 #define SS_OVERLAY "ship" // ship selection help 20 #define WL_OVERLAY "weapon" // weapons loadout help 21 #define BR_OVERLAY "briefing" // briefing help 22 #define MH_OVERLAY "main" // main hall help 23 #define BARRACKS_OVERLAY "barracks" // barracks help 24 #define CONTROL_CONFIG_OVERLAY "control" // control config help 25 #define DEBRIEFING_OVERLAY "debrief" // debriefing help 26 #define MULTI_CREATE_OVERLAY "multicreate" // multi create game help 27 #define MULTI_START_OVERLAY "multistart" // multi start game help overlay 28 #define MULTI_JOIN_OVERLAY "multijoin" // join game help overlay 29 #define MH2_OVERLAY "main2" // main hall 2 help overlay 30 #define HOTKEY_OVERLAY "hotkey" // hotkey assignment help overlay 31 #define CAMPAIGN_ROOM_OVERLAY "campaign" // campaign room help overlay 32 #define SIM_ROOM_OVERLAY "simulator" // sim room help overlay 33 #define TECH_ROOM_OVERLAY "tech" // tech room (general) help overlay 34 #define CMD_BRIEF_OVERLAY "command" // command briefing help overlay 35 36 // other help overlay constants 37 #define HELP_PADDING 1 // 38 #define HELP_MAX_NAME_LENGTH 32 // max string length for overlay name 39 #define HELP_MAX_STRING_LENGTH 128 // max string length for text overlay element 40 #define HELP_PLINE_THICKNESS 2 41 #define HELP_OVERLAY_FILENAME "help.tbl" 42 43 // help overlay calls 44 int help_overlay_get_index(const char* overlay_name); 45 int help_overlay_active(int overlay_id); 46 void help_overlay_set_state(int overlay_id, int resolution_index, int state); 47 void help_overlay_maybe_blit(int overlay_id, int resolution_index); 48 49 void context_help_init(); // called once at game startup 50 void context_help_grey_screen(); // call to grey out a screen (normally when applying a help overlay) 51 52 void launch_context_help(); 53 54 55 #endif /* __CONTEXTHELP_H__ */ 56