UFO: Alien Invasion
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cl_console.h File Reference

Console header file. More...

Go to the source code of this file.

Macros

#define CONSOLE_PROMPT_CHAR   ']'
 

Functions

void Con_DrawString (const char *text, int x, int y, unsigned int width)
 
void Con_Scroll (int scroll)
 Scrolls the console. More...
 
void Con_CheckResize (void)
 If the line width has changed, reformat the buffer. More...
 
void Con_Init (void)
 
void Con_DrawConsole (float frac)
 Draws the console with the solid background. More...
 
void Con_Print (const char *txt)
 Handles cursor positioning, line wrapping, etc All console printing must go through this in order to be logged to disk If no console is visible, the text will appear at the top of the game window. More...
 
void Con_ToggleConsole_f (void)
 
void Con_Close (void)
 Hide the gameconsole if active. More...
 
void Con_SaveConsoleHistory (void)
 Stores the console history. More...
 
void Con_LoadConsoleHistory (void)
 Load the console history. More...
 

Variables

const int con_fontHeight
 
const int con_fontWidth
 
const int con_fontShift
 

Detailed Description

Console header file.

Definition in file cl_console.h.

Macro Definition Documentation

#define CONSOLE_PROMPT_CHAR   ']'

Definition at line 43 of file cl_console.h.

Referenced by Key_Console(), and Key_Init().

Function Documentation

void Con_CheckResize ( void  )
void Con_Close ( void  )

Hide the gameconsole if active.

Definition at line 393 of file cl_console.cpp.

References cls, key_console, key_game, Key_SetDest(), and client_static_s::keyDest.

void Con_DrawString ( const char *  txt,
int  x,
int  y,
unsigned int  width 
)
Parameters
txtThe character buffer to draw
x,yThe coordinates on the screen
widthCharacters to draw

Definition at line 105 of file cl_console.cpp.

References ColorIndex, CON_COLOR_WHITE, Con_DrawText(), lengthof, Q_IsColorString, and Sys_Error().

Referenced by SCR_DrawString().

void Con_LoadConsoleHistory ( void  )
void Con_Print ( const char *  txt)

Handles cursor positioning, line wrapping, etc All console printing must go through this in order to be logged to disk If no console is visible, the text will appear at the top of the game window.

See also
Sys_ConsoleOutput

Definition at line 318 of file cl_console.cpp.

void Con_SaveConsoleHistory ( void  )
void Con_Scroll ( int  scroll)

Scrolls the console.

Parameters
[in]scrollLines to scroll

Definition at line 172 of file cl_console.cpp.

References console_t::currentLine, and console_t::displayLine.

Referenced by Key_Console().

void Con_ToggleConsole_f ( void  )

Variable Documentation

const int con_fontHeight

Definition at line 75 of file cl_console.cpp.

Referenced by Con_DrawConsole(), Con_DrawInput(), R_DrawChar(), and SCR_UpdateScreen().

const int con_fontShift

Definition at line 77 of file cl_console.cpp.

Referenced by Con_CheckResize(), Con_DrawConsole(), and Con_DrawText().

const int con_fontWidth

Definition at line 76 of file cl_console.cpp.

Referenced by Con_DrawConsole(), Con_Init(), R_DrawChar(), and SCR_UpdateScreen().