contexthelp.h File Reference

Go to the source code of this file.

Macros
#define	MAX_HELP_OVERLAYS   30
#define	SS_OVERLAY   "ship"
#define	WL_OVERLAY   "weapon"
#define	BR_OVERLAY   "briefing"
#define	MH_OVERLAY   "main"
#define	BARRACKS_OVERLAY   "barracks"
#define	CONTROL_CONFIG_OVERLAY   "control"
#define	DEBRIEFING_OVERLAY   "debrief"
#define	MULTI_CREATE_OVERLAY   "multicreate"
#define	MULTI_START_OVERLAY   "multistart"
#define	MULTI_JOIN_OVERLAY   "multijoin"
#define	MH2_OVERLAY   "main2"
#define	HOTKEY_OVERLAY   "hotkey"
#define	CAMPAIGN_ROOM_OVERLAY   "campaign"
#define	SIM_ROOM_OVERLAY   "simulator"
#define	TECH_ROOM_OVERLAY   "tech"
#define	CMD_BRIEF_OVERLAY   "command"
#define	HELP_PADDING   1
#define	HELP_MAX_NAME_LENGTH   32
#define	HELP_MAX_STRING_LENGTH   128
#define	HELP_PLINE_THICKNESS   2
#define	HELP_OVERLAY_FILENAME   "help.tbl"

Functions
int	help_overlay_get_index (const char *overlay_name)
int	help_overlay_active (int overlay_id)
void	help_overlay_set_state (int overlay_id, int resolution_index, int state)
void	help_overlay_maybe_blit (int overlay_id, int resolution_index)
void	context_help_init ()
void	context_help_grey_screen ()
void	launch_context_help ()

Macro Definition Documentation

#define BARRACKS_OVERLAY   "barracks"

Definition at line 25 of file contexthelp.h.

#define BR_OVERLAY   "briefing"

Definition at line 23 of file contexthelp.h.

#define CAMPAIGN_ROOM_OVERLAY   "campaign"

Definition at line 33 of file contexthelp.h.

#define CMD_BRIEF_OVERLAY   "command"

Definition at line 36 of file contexthelp.h.

#define CONTROL_CONFIG_OVERLAY   "control"

Definition at line 26 of file contexthelp.h.

#define DEBRIEFING_OVERLAY   "debrief"

Definition at line 27 of file contexthelp.h.

#define HELP_MAX_NAME_LENGTH   32

Definition at line 40 of file contexthelp.h.

#define HELP_MAX_STRING_LENGTH   128

Definition at line 41 of file contexthelp.h.

#define HELP_OVERLAY_FILENAME   "help.tbl"

Definition at line 43 of file contexthelp.h.

#define HELP_PADDING   1

Definition at line 39 of file contexthelp.h.

#define HELP_PLINE_THICKNESS   2

Definition at line 42 of file contexthelp.h.

#define HOTKEY_OVERLAY   "hotkey"

Definition at line 32 of file contexthelp.h.

#define MAX_HELP_OVERLAYS   30

Definition at line 19 of file contexthelp.h.

#define MH2_OVERLAY   "main2"

Definition at line 31 of file contexthelp.h.

#define MH_OVERLAY   "main"

Definition at line 24 of file contexthelp.h.

#define MULTI_CREATE_OVERLAY   "multicreate"

Definition at line 28 of file contexthelp.h.

#define MULTI_JOIN_OVERLAY   "multijoin"

Definition at line 30 of file contexthelp.h.

#define MULTI_START_OVERLAY   "multistart"

Definition at line 29 of file contexthelp.h.

#define SIM_ROOM_OVERLAY   "simulator"

Definition at line 34 of file contexthelp.h.

#define SS_OVERLAY   "ship"

Definition at line 21 of file contexthelp.h.

#define TECH_ROOM_OVERLAY   "tech"

Definition at line 35 of file contexthelp.h.

#define WL_OVERLAY   "weapon"

Definition at line 22 of file contexthelp.h.

Function Documentation

void context_help_grey_screen

(

)

Definition at line 186 of file contexthelp.cpp.

void context_help_init

(

)

Definition at line 179 of file contexthelp.cpp.

int help_overlay_active

(

int

overlay_id

)

Definition at line 116 of file contexthelp.cpp.

int help_overlay_get_index

(

const char *

overlay_name

)

Definition at line 104 of file contexthelp.cpp.

void help_overlay_maybe_blit	(	int	overlay_id,
		int	resolution_index
	)

Definition at line 147 of file contexthelp.cpp.

void help_overlay_set_state	(	int	overlay_id,
		int	resolution_index,
		int	state
	)

Definition at line 128 of file contexthelp.cpp.

void launch_context_help

(

)

Definition at line 193 of file contexthelp.cpp.