Rename files in Docs, and add new Doc about print statements.

This commit is contained in:
2026-02-09 16:07:15 -05:00
parent db35967fb9
commit bf7cb9d258
21 changed files with 188 additions and 30 deletions

View File

@@ -4,21 +4,34 @@
#include "ConsoleOutput.generated.h"
//////////////////////////////////////////////////////////////
//
// ConsoleOutput
//
// This class stores the text that's in the unreal console.
// It stores it as one great big string, which contains
// newlines to denote line breaks.
// When the lua code executes a print statement, the text
// eventually gets passed to the GameMode blueprint: see
// Docs/Print-Statement-Handling.md for more information.
//
// The GameMode blueprint is expected to create a virtual
// console of some sort to display the print statements.
// This class, ConsoleOutput, is a class that the GameMode
// can optionally use to help implement that virtual console.
//
// This class just collects the print statements and keeps
// a record of what text is in the virtual console. The
// text is stored as one big string.
//
// This class also contains a 'dirty' bit. Each time somebody
// appends a line of text to the console, the dirty bit is
// automatically set. The bit can be checked using 'IsDirty'
// and cleared using 'ClearDirty'. This makes it so that
// you don't have to update the unreal widget unless the
// text has actually changed.
// and cleared using 'ClearDirty'. Assuming that the GameMode
// is maintaining a text widget of some sort, the GameMode
// can transfer the contents of this buffer into the text
// widget only when the dirty bit is set.
//
// Note that the GameMode is not obligated to use this class.
// If the GameMode wants to use some other framework to
// implement the virtual console, that's perfectly fine.
//
//////////////////////////////////////////////////////////////