console_information_td Struct Reference

#include <SDL_console.h>

---

Detailed Description

This is a struct for each consoles data

Data Fields
int	Visible
int	WasUnicode
int	RaiseOffset
int	HideKey
char **	ConsoleLines
char **	CommandLines
int	TotalConsoleLines
int	ConsoleScrollBack
int	TotalCommands
int	FontNumber
int	LineBuffer
int	VChars
int	BackX
int	BackY
char *	Prompt
char	Command [CON_CHARS_PER_LINE+1]
char	RCommand [CON_CHARS_PER_LINE+1]
char	LCommand [CON_CHARS_PER_LINE+1]
char	VCommand [CON_CHARS_PER_LINE+1]
int	CursorPos
int	Offset
int	InsMode
SDL_Surface *	ConsoleSurface
SDL_Surface *	OutputScreen
SDL_Surface *	BackgroundImage
SDL_Surface *	InputBackground
int	DispX
int	DispY
unsigned char	ConsoleAlpha
int	CommandScrollBack
void(*	CmdFunction )(struct console_information_td *console, char *command)
char *(*	TabFunction )(char *command)
int	FontHeight
int	FontWidth

---

Field Documentation

int console_information_td::Visible

int console_information_td::WasUnicode

enum that tells which visible state we are in CON_CLOSED, CON_OPEN, CON_CLOSING, CON_OPENING

int console_information_td::RaiseOffset

stores the UNICODE value before the console was shown. On Hide() the UNICODE value is restored.

int console_information_td::HideKey

Offset used in show/hide animation

char** console_information_td::ConsoleLines

the key that can hide the console

char** console_information_td::CommandLines

List of all the past lines

int console_information_td::TotalConsoleLines

List of all the past commands

int console_information_td::ConsoleScrollBack

Total number of lines in the console

int console_information_td::TotalCommands

How much the user scrolled back in the console

int console_information_td::FontNumber

Number of commands that were typed in before (which are now in the CommandLines array)

int console_information_td::LineBuffer

This is the number of the font for the console (DT_* specific; will hopefully disappear in future releases)

int console_information_td::VChars

The number of visible lines in the console (autocalculated on CON_UpdateConsole())

int console_information_td::BackX

The number of visible characters in one console line (autocalculated on CON_Init() and recalc. on CON_Resize())

int console_information_td::BackY

The number of visible characters in one console line (autocalculated on CON_Init() and recalc. on CON_Resize())

char* console_information_td::Prompt

Background image x and y coords

char console_information_td::Command[CON_CHARS_PER_LINE+1]

Prompt displayed in command line

char console_information_td::RCommand[CON_CHARS_PER_LINE+1]

current command in command line = lcommand + rcommand (Get's updated in AssembleCommand())

char console_information_td::LCommand[CON_CHARS_PER_LINE+1]

left hand side of cursor

char console_information_td::VCommand[CON_CHARS_PER_LINE+1]

right hand side of cursor

int console_information_td::CursorPos

current visible command line

int console_information_td::Offset

Current cursor position relative to the currently typed in command

int console_information_td::InsMode

First visible character relative to the currently typed in command (used if command is too long to fit into console)

SDL_Surface* console_information_td::ConsoleSurface

Boolean that tells us whether we are in Insert- or Overwrite-Mode

SDL_Surface* console_information_td::OutputScreen

THE Surface of the console

SDL_Surface* console_information_td::BackgroundImage

This is the screen to draw the console to (normally you VideoSurface)

SDL_Surface* console_information_td::InputBackground

Background image for the console

int console_information_td::DispX

Dirty rectangle that holds the part of the background image that is behind the commandline

int console_information_td::DispY

Dirty rectangle that holds the part of the background image that is behind the commandline

unsigned char console_information_td::ConsoleAlpha

The top left x and y coords of the console on the display screen

int console_information_td::CommandScrollBack

The consoles alpha level

void(* console_information_td::CmdFunction)(struct console_information_td *console, char* command)

How much the users scrolled back in the command lines

char*(* console_information_td::TabFunction)(char* command)

The Function that is executed if you press 'Return' in the console

int console_information_td::FontHeight

The Function that is executed if you press 'Tab' in the console

int console_information_td::FontWidth

The height of the font used in the console

---

The documentation for this struct was generated from the following file:

• SDL_console.h

---