Class representing a console history entry. More...

#include <console.h>

Collaboration diagram for BlamConsoleHistoryEntry:

Public Member Functions
	BlamConsoleHistoryEntry ()

	~BlamConsoleHistoryEntry ()

void	Reconfigure (BlamLogMessage _message)
	Reconfigures this console history entry. More...

void	Deconfigure ()
	Deconfigures this console history entry. More...

Public Attributes
uint64_t	creation_tick = 0
	The tick when this entry was created. More...

BlamUIWidget_Text *	text_element = nullptr
	The UI widget used for displaying the message. More...

byte	opacity = 255
	The opacity of the message text. More...

BlamLogMessage	message
	The message that this entry is displaying. More...

int	visible_ticks = 0
	The amount of ticks that the message has been visible. More...

Detailed Description

Class representing a console history entry.

Constructor & Destructor Documentation

◆ BlamConsoleHistoryEntry()

BlamConsoleHistoryEntry::BlamConsoleHistoryEntry ( )

Here is the call graph for this function:

◆ ~BlamConsoleHistoryEntry()

BlamConsoleHistoryEntry::~BlamConsoleHistoryEntry ( )

Member Function Documentation

◆ Deconfigure()

void BlamConsoleHistoryEntry::Deconfigure ( )

Deconfigures this console history entry.

This will effectively clear all data from the entry. This is usually done when the item is hidden and should no longer be displayed.

Here is the caller graph for this function:

◆ Reconfigure()

void BlamConsoleHistoryEntry::Reconfigure ( BlamLogMessage _message )

Reconfigures this console history entry.

This will update all properties of the entry to essentially reconstruct it as a new entry. This is used to avoid deleting/re-creating a large amount of entries.

Parameters

_message - The log message to reconfigure this entry as.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ creation_tick

uint64_t BlamConsoleHistoryEntry::creation_tick = 0

The tick when this entry was created.

◆ message

BlamLogMessage BlamConsoleHistoryEntry::message

The message that this entry is displaying.

◆ opacity

byte BlamConsoleHistoryEntry::opacity = 255

The opacity of the message text.

◆ text_element

BlamUIWidget_Text* BlamConsoleHistoryEntry::text_element = nullptr

The UI widget used for displaying the message.

◆ visible_ticks

int BlamConsoleHistoryEntry::visible_ticks = 0

The amount of ticks that the message has been visible.

The documentation for this class was generated from the following files:

blam/components/ui/blam/widgets/advanced/console.h
blam/components/ui/blam/widgets/advanced/BlamConsoleHistoryEntry.cpp

Public Member Functions

Public Attributes