#include <console.h>

Inherits Container, ActionListener, and FocusListener.

Collaboration diagram for FIFE::Console:

Public Member Functions
	Console ()
	Constructor. More...

virtual	~Console ()
	Destructor. More...

void	println (const std::string &s)
	Print one or more lines to the console output. More...

void	show ()
	Show the console Adds the Console to the fifechan toplevel container and pushes an input Context so that keys are not send to the rest of the game. More...

void	hide ()
	Hide the console Removes itself from the toplevel container and pops it's input context. More...

void	clear ()
	Clear the console output. More...

void	toggleShowHide ()
	Toggle the console Toggles whether the Console is shown or not. More...

void	execute (std::string cmd)
	Execute a command Normally just sends the command to runString() Checks whether the cmd is just one token and print it's value rather than throw an useless error. More...

void	updateCaption ()
	Update the FPS caption. More...

void	updateAnimation ()
	Update the scroll in/out animation. More...

void	action (const fcn::ActionEvent &event)
	Callback from fifechan to respond to button press. More...

void	setConsoleExecuter (ConsoleExecuter *const consoleexec)
	Sets executer for the console. More...

void	removeConsoleExecuter ()
	Removes executer for the console. More...

void	reLayout ()
	Layouts the console to match e.g. More...

void	setIOFont (GuiFont *font)
	Sets the font used for the input and output areas. More...

void	focusLost (const fcn::Event &event)
	Hide if we loose focus. More...

Private Member Functions
void	doShow ()

void	doHide ()

Private Attributes
bool	m_isAttached

ConsoleExecuter *	m_consoleexec

CommandLine *	m_input

fcn::TextBox *	m_output

fcn::ScrollArea *	m_outputscrollarea

fcn::Label *	m_status

fcn::Button *	m_toolsbutton

std::string	m_prompt

int32_t	m_hiddenPos

int32_t	m_animationDelta

bool	m_hiding

Timer	m_fpsTimer

Timer	m_animationTimer

Static Private Attributes
static const unsigned	m_maxOutputRows = 50

Detailed Description

Ingame Console.

Definition at line 64 of file console.h.

Constructor & Destructor Documentation

◆ Console()

FIFE::Console::Console ( )

Constructor.

Definition at line 46 of file console.cpp.

References FIFE::FifechanManager::createFont(), execute(), FIFE::DynamicSingleton< FifechanManager >::instance(), m_animationTimer, m_fpsTimer, m_hiding, m_input, m_isAttached, m_outputscrollarea, m_prompt, m_status, m_toolsbutton, reLayout(), FIFE::CommandLine::setCallback(), FIFE::Timer::setCallback(), FIFE::GuiFont::setColor(), FIFE::Timer::setInterval(), setIOFont(), updateAnimation(), and updateCaption().

◆ ~Console()

FIFE::Console::~Console ( )

virtual

Destructor.

Definition at line 141 of file console.cpp.

References doHide(), m_input, m_output, m_outputscrollarea, m_status, and m_toolsbutton.

Member Function Documentation

◆ action()

void FIFE::Console::action ( const fcn::ActionEvent & event )

Callback from fifechan to respond to button press.

Definition at line 277 of file console.cpp.

References FIFE::_log, FL_WARN, m_consoleexec, and FIFE::ConsoleExecuter::onToolsClick().

◆ clear()

void FIFE::Console::clear ( )

Clear the console output.

Definition at line 178 of file console.cpp.

References m_output.

◆ doHide()

void FIFE::Console::doHide ( )

private

Definition at line 194 of file console.cpp.

References FIFE::DynamicSingleton< FifechanManager >::instance(), m_fpsTimer, m_isAttached, FIFE::FifechanManager::remove(), and FIFE::Timer::stop().

Referenced by updateAnimation(), and ~Console().

Here is the caller graph for this function:

◆ doShow()

void FIFE::Console::doShow ( )

private

Definition at line 182 of file console.cpp.

References FIFE::FifechanManager::add(), FIFE::FifechanManager::getTopContainer(), FIFE::DynamicSingleton< FifechanManager >::instance(), m_fpsTimer, m_input, m_isAttached, and FIFE::Timer::start().

Referenced by show(), and toggleShowHide().

Here is the caller graph for this function:

◆ execute()

void FIFE::Console::execute ( std::string cmd )

Execute a command Normally just sends the command to runString() Checks whether the cmd is just one token and print it's value rather than throw an useless error.

Definition at line 224 of file console.cpp.

References FIFE::_log, FL_DBG, FL_WARN, m_consoleexec, m_prompt, FIFE::ConsoleExecuter::onConsoleCommand(), println(), and FIFE::Exception::what().

Referenced by Console().

Here is the caller graph for this function: