FS2_Open
Open source remastering of the Freespace 2 engine
contexthelp.cpp File Reference

Go to the source code of this file.

Classes

struct  help_line
 
struct  help_pline
 
struct  help_text
 
struct  help_left_bracket
 
struct  help_right_bracket
 
struct  help_overlay
 

Functions

void parse_helptbl (const char *filename)
 
void help_overlay_blit (int overlay_id, int resolution_index)
 
void help_overlay_init ()
 
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 help_overlay_reset_all ()
 
void create_grey_shader ()
 
void context_help_init ()
 
void context_help_grey_screen ()
 
void launch_context_help ()
 
void close_help ()
 
 DCF (help_reload,"Reloads help overlay data from help.tbl")
 
void nudgetext_x (int textnum, int amount)
 
void nudgetext_y (int textnum, int amount)
 
void nudgepline_x (int plinenum, int plinevert, int amount)
 
void nudgepline_y (int plinenum, int plinevert, int amount)
 
void nudgerbracket_x (int num, int amount)
 
void nudgerbracket_y (int num, int amount)
 
void nudgelbracket_x (int num, int amount)
 
void nudgelbracket_y (int num, int amount)
 
void showtextpos (int textnum)
 
void showrbracketpos (int num)
 
void showlbracketpos (int num)
 
void showplinepos (int plinenum)
 
 DCF (help_nudgetext_x,"Use to visually position overlay text.")
 
 DCF (help_nudgetext_y,"Use to visually position overlay text.")
 
 DCF (help_nudgepline_x,"Use to visually position overlay polylines.")
 
 DCF (help_nudgepline_y,"Use to visually position overlay polylines.")
 
 DCF (help_nudgerbracket_x,"Use to visually position overlay right bracket.")
 
 DCF (help_nudgerbracket_y,"Use to visually position overlay right bracket.")
 
 DCF (help_nudgelbracket_x,"Use to visually position overlay left bracket.")
 
 DCF (help_nudgelbracket_y,"Use to visually position overlay left bracket.")
 

Variables

shader Grey_shader
 
int num_help_overlays
 
int Help_overlay_flags
 
int h_textnum =0
 
int h_amt =0
 
int h_vtx = 0
 

Function Documentation

void close_help ( )

Definition at line 286 of file contexthelp.cpp.

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.

void create_grey_shader ( )

Definition at line 165 of file contexthelp.cpp.

DCF ( help_reload  ,
"Reloads help overlay data from help.tbl"   
)

Definition at line 549 of file contexthelp.cpp.

DCF ( help_nudgetext_x  ,
"Use to visually position overlay text."   
)

Definition at line 616 of file contexthelp.cpp.

DCF ( help_nudgetext_y  ,
"Use to visually position overlay text."   
)

Definition at line 635 of file contexthelp.cpp.

DCF ( help_nudgepline_x  ,
"Use to visually position overlay polylines."   
)

Definition at line 653 of file contexthelp.cpp.

DCF ( help_nudgepline_y  ,
"Use to visually position overlay polylines."   
)

Definition at line 673 of file contexthelp.cpp.

DCF ( help_nudgerbracket_x  ,
"Use to visually position overlay right bracket."   
)

Definition at line 693 of file contexthelp.cpp.

DCF ( help_nudgerbracket_y  ,
"Use to visually position overlay right bracket."   
)

Definition at line 711 of file contexthelp.cpp.

DCF ( help_nudgelbracket_x  ,
"Use to visually position overlay left bracket."   
)

Definition at line 732 of file contexthelp.cpp.

DCF ( help_nudgelbracket_y  ,
"Use to visually position overlay left bracket."   
)

Definition at line 751 of file contexthelp.cpp.

int help_overlay_active ( int  overlay_id)

Definition at line 116 of file contexthelp.cpp.

void help_overlay_blit ( int  overlay_id,
int  resolution_index 
)

Definition at line 503 of file contexthelp.cpp.

int help_overlay_get_index ( const char *  overlay_name)

Definition at line 104 of file contexthelp.cpp.

void help_overlay_init ( )

Definition at line 297 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_reset_all ( )

Definition at line 159 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.

void nudgelbracket_x ( int  num,
int  amount 
)

Definition at line 586 of file contexthelp.cpp.

void nudgelbracket_y ( int  num,
int  amount 
)

Definition at line 590 of file contexthelp.cpp.

void nudgepline_x ( int  plinenum,
int  plinevert,
int  amount 
)

Definition at line 570 of file contexthelp.cpp.

void nudgepline_y ( int  plinenum,
int  plinevert,
int  amount 
)

Definition at line 574 of file contexthelp.cpp.

void nudgerbracket_x ( int  num,
int  amount 
)

Definition at line 578 of file contexthelp.cpp.

void nudgerbracket_y ( int  num,
int  amount 
)

Definition at line 582 of file contexthelp.cpp.

void nudgetext_x ( int  textnum,
int  amount 
)

Definition at line 562 of file contexthelp.cpp.

void nudgetext_y ( int  textnum,
int  amount 
)

Definition at line 566 of file contexthelp.cpp.

void parse_helptbl ( const char *  filename)

Definition at line 321 of file contexthelp.cpp.

void showlbracketpos ( int  num)

Definition at line 602 of file contexthelp.cpp.

void showplinepos ( int  plinenum)

Definition at line 606 of file contexthelp.cpp.

void showrbracketpos ( int  num)

Definition at line 598 of file contexthelp.cpp.

void showtextpos ( int  textnum)

Definition at line 594 of file contexthelp.cpp.

Variable Documentation

shader Grey_shader

Definition at line 84 of file contexthelp.cpp.

int h_amt =0

Definition at line 560 of file contexthelp.cpp.

int h_textnum =0

Definition at line 560 of file contexthelp.cpp.

int h_vtx = 0

Definition at line 560 of file contexthelp.cpp.

int Help_overlay_flags

Definition at line 96 of file contexthelp.cpp.

int num_help_overlays

Definition at line 92 of file contexthelp.cpp.