BBPGlue.API.BBPConsole Class Reference

In-game console used for logging messages to a small overlay and capturing history. More...

Static Public Member Functions
static void	Clear ()
	Clears the console history.
static void	CopyAll ()
	Copies the entire console log to the system clipboard.
static void	Error (string message)
	Logs an error message to the BBPGlue console and Unity logger.
static string	GetFullLogText ()
	Returns the full console contents as a single string.
static void	Log (string message)
	Logs an informational message to the BBPGlue console and Unity logger.
static void	OnGUI ()
	Renders the console GUI when visible.
static void	Update ()
	Update loop to handle console visibility hotkeys.
static void	Warn (string message)
	Logs a warning message to the BBPGlue console and Unity logger.

Properties
static bool	Enabled = true [get, set]
static IReadOnlyCollection< BBPConsoleMessage >	Entries [get]
	Read-only view of console message history.
static int	MaxMessages = 512 [get, set]

Detailed Description

In-game console used for logging messages to a small overlay and capturing history.

Member Function Documentation

Clear()

void BBPGlue.API.BBPConsole.Clear ( )

static

Clears the console history.

CopyAll()

void BBPGlue.API.BBPConsole.CopyAll ( )

static

Copies the entire console log to the system clipboard.

Error()

void BBPGlue.API.BBPConsole.Error ( string message )

static

Logs an error message to the BBPGlue console and Unity logger.

Parameters

message

Error message text.

GetFullLogText()

string BBPGlue.API.BBPConsole.GetFullLogText ( )

static

Returns the full console contents as a single string.

Returns

Concatenated log text.

Log()

void BBPGlue.API.BBPConsole.Log ( string message )

static

Logs an informational message to the BBPGlue console and Unity logger.

Parameters

message

Message text to log.

OnGUI()

void BBPGlue.API.BBPConsole.OnGUI ( )

static

Renders the console GUI when visible.

Update()

void BBPGlue.API.BBPConsole.Update ( )

static

Update loop to handle console visibility hotkeys.

Warn()

void BBPGlue.API.BBPConsole.Warn ( string message )

static

Logs a warning message to the BBPGlue console and Unity logger.

Parameters

message

Warning message text.

Property Documentation

Enabled

bool BBPGlue.API.BBPConsole.Enabled = true

staticgetset

Entries

IReadOnlyCollection<BBPConsoleMessage> BBPGlue.API.BBPConsole.Entries

staticget

Read-only view of console message history.

MaxMessages

int BBPGlue.API.BBPConsole.MaxMessages = 512

staticgetset

---

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

• BBPConsole.cs