cl_console.c File Reference

Console related code. More...

#include "cl_console.h"
#include "client.h"
#include "cl_game.h"
#include "input/cl_keys.h"
#include "renderer/r_draw.h"

Include dependency graph for cl_console.c:

Go to the source code of this file.

Data Structures
struct	console_t
Defines
#define	CONSOLE_CHAR_ALIGN 4
#define	NUM_CON_TIMES 8
#define	COLORED_TEXT_MASK 128
#define	CON_TEXTSIZE 32768
#define	CONSOLE_CURSOR_CHAR 11
#define	CONSOLE_HISTORY_FILENAME "history"
Functions
static void	Con_DisplayString (int x, int y, const char *s)
static void	Key_ClearTyping (void)
void	Con_ToggleConsole_f (void)
static void	Con_ToggleChat_f (void)
static void	Con_Clear_f (void)
	Clears the console buffer.
void	Con_Scroll (int scroll)
	Scrolls the console.
void	Con_ClearNotify (void)
	Clear the notify times to ensure that every message will disappear from screen.
static void	Con_MessageModeSay_f (void)
static void	Con_MessageModeSayTeam_f (void)
void	Con_CheckResize (void)
	If the line width has changed, reformat the buffer.
void	Con_LoadConsoleHistory (void)
	Load the console history.
void	Con_SaveConsoleHistory (void)
	Stores the console history.
void	Con_Init (void)
static void	Con_Linefeed (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.
void	Con_Close (void)
	Hide the gameconsole if active.
static void	Con_DrawInput (void)
	The input line scrolls horizontally if typing goes beyond the right edge.
void	Con_DrawNotify (void)
	Draws the last few lines of output transparently over the game top.
void	Con_DrawConsole (float frac)
	Draws the console with the solid background.
Variables
static console_t	con
static cvar_t *	con_notifytime
static cvar_t *	con_history
static cvar_t *	con_background
const int	con_fontHeight = 12
const int	con_fontWidth = 10
const int	con_fontShift = 3

Detailed Description

Console related code.

Definition in file cl_console.c.

Define Documentation

#define COLORED_TEXT_MASK 128

Definition at line 37 of file cl_console.c.

#define CON_TEXTSIZE 32768

Definition at line 38 of file cl_console.c.

Referenced by Con_CheckResize().

#define CONSOLE_CHAR_ALIGN 4

Definition at line 35 of file cl_console.c.

Referenced by Con_DrawConsole(), and Con_DrawInput().

#define CONSOLE_CURSOR_CHAR 11

Definition at line 39 of file cl_console.c.

Referenced by Con_DrawInput().

#define CONSOLE_HISTORY_FILENAME "history"

Definition at line 40 of file cl_console.c.

Referenced by Con_LoadConsoleHistory(), and Con_SaveConsoleHistory().

#define NUM_CON_TIMES 8

Definition at line 36 of file cl_console.c.

Referenced by Con_ClearNotify(), Con_DrawNotify(), and Con_Print().

Function Documentation

void Con_CheckResize ( void )

If the line width has changed, reformat the buffer.

Definition at line 162 of file cl_console.c.

References Con_ClearNotify(), con_fontShift, CON_TEXTSIZE, console_t::currentLine, console_t::displayLine, i, console_t::lineWidth, console_t::text, console_t::totalLines, viddef, and viddef_t::width.

Referenced by SCR_DrawConsole().

static void Con_Clear_f ( void ) [static]

Clears the console buffer.

Definition at line 110 of file cl_console.c.

References console_t::text.

Referenced by Con_Init().

void Con_ClearNotify ( void )

Clear the notify times to ensure that every message will disappear from screen.

Definition at line 131 of file cl_console.c.

References i, NUM_CON_TIMES, and console_t::times.

Referenced by Con_CheckResize(), Con_ToggleChat_f(), Con_ToggleConsole_f(), and SCR_EndLoadingPlaque().

void Con_Close ( void )

Hide the gameconsole if active.

Definition at line 376 of file cl_console.c.

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

static void Con_DisplayString	(	int	x,
		int	y,
		const char *	s
	)			`[static]`

Definition at line 67 of file cl_console.c.

References con_fontWidth, and R_DrawChar().

Referenced by Con_DrawNotify().

void Con_DrawConsole ( float frac )

Draws the console with the solid background.

Parameters:

[in] frac

Definition at line 484 of file cl_console.c.

References Com_sprintf(), Con_DrawInput(), con_fontHeight, con_fontShift, con_fontWidth, CONSOLE_CHAR_ALIGN, CONSOLE_COLORED_TEXT_MASK, console_t::currentLine, console_t::displayLine, viddef_t::height, i, cvar_s::integer, it_pic, len, console_t::lineWidth, R_DrawChar(), R_DrawStretchImage(), R_FindImage(), console_t::text, console_t::totalLines, UFO_VERSION, viddef, viddef_t::virtualHeight, viddef_t::virtualWidth, console_t::visLines, and viddef_t::width.

Referenced by SCR_DrawConsole().

static void Con_DrawInput ( void ) [static]

The input line scrolls horizontally if typing goes beyond the right edge.

Definition at line 385 of file cl_console.c.

References ca_active, CL_Milliseconds(), cls, con_fontHeight, con_fontShift, CONSOLE_CHAR_ALIGN, CONSOLE_COLORED_TEXT_MASK, CONSOLE_CURSOR_CHAR, editLine, i, key_console, client_static_s::keyDest, keyLinePos, keyLines, console_t::lineWidth, MAXCMDLINE, Q_strncpyz(), R_DrawChar(), client_static_s::state, and console_t::visLines.

Referenced by Con_DrawConsole().

void Con_DrawNotify ( void )

Draws the last few lines of output transparently over the game top.

See also:: SCR_DrawConsole

Definition at line 425 of file cl_console.c.

References CL_Milliseconds(), cls, Con_DisplayString(), con_fontHeight, con_fontShift, CONSOLE_COLORED_TEXT_MASK, console_t::currentLine, developer, i, cvar_s::integer, key_message, client_static_s::keyDest, console_t::lineWidth, MSG_SAY, MSG_SAY_TEAM, msgBuffer, msgBufferLen, msgMode, NUM_CON_TIMES, qfalse, qtrue, R_DrawChar(), viddef_t::rx, viddef_t::ry, console_t::text, console_t::times, console_t::totalLines, viddef, and viddef_t::width.

Referenced by SCR_DrawConsole().

void Con_Init ( void )

Definition at line 264 of file cl_console.c.

References _, Cmd_AddCommand(), Com_Printf(), Con_Clear_f(), con_fontWidth, Con_LoadConsoleHistory(), Con_MessageModeSay_f(), Con_MessageModeSayTeam_f(), Con_ToggleChat_f(), Con_ToggleConsole_f(), CVAR_ARCHIVE, Cvar_Get(), console_t::initialized, console_t::lineWidth, qtrue, console_t::text, console_t::totalLines, and VID_NORM_WIDTH.

Referenced by CL_Init().

static void Con_Linefeed ( void ) [static]

Definition at line 291 of file cl_console.c.

References console_t::currentLine, console_t::displayLine, console_t::lineWidth, console_t::pos, console_t::text, and console_t::totalLines.

Referenced by Con_Print().

void Con_LoadConsoleHistory ( void )

Load the console history.

See also:: Con_SaveConsoleHistory

Definition at line 204 of file cl_console.c.

References CONSOLE_HISTORY_FILENAME, editLine, qFILE_s::f, f, FILE_READ, FS_CloseFile(), FS_OpenFile(), historyLine, cvar_s::integer, keyLines, MAXCMDLINE, MAXKEYLINES, and Q_strncpyz().

Referenced by Con_Init().

static void Con_MessageModeSay_f ( void ) [static]

Definition at line 139 of file cl_console.c.

References CL_OnBattlescape(), GAME_IsSingleplayer, key_message, Key_SetDest(), MSG_SAY, and msgMode.

Referenced by Con_Init().

static void Con_MessageModeSayTeam_f ( void ) [static]

Definition at line 149 of file cl_console.c.

References CL_OnBattlescape(), GAME_IsSingleplayer, key_message, Key_SetDest(), MSG_SAY_TEAM, and msgMode.

Referenced by Con_Init().

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.