Interface for logging operations based on IMiniLog. Notes: Logging in CryEngine should be done using the following global functions: CryLog (eMessage) CryLogAlways (eAlways) CryError (eError) CryWarning (eWarning) CryComment (eComment) ILog gives you more control on logging operations.

struct ILog : public IMiniLog {
  class CLogIndenter;
  class CLogAssetScopeName;
};

ILog.h

IMiniLog, CryLog, CryLogAlways, CryError, CryWarning

class CLogAssetScopeName;

ILog.h

~CLogAssetScopeName();

CLogAssetScopeName(ILog * pLog, const char* sAssetType, const char * sAssetName);

class CLogIndenter;

ILog.h

~CLogIndenter();

CLogIndenter(ILog * log);

void DisplaySectionText();

void Enable(bool enable = true, const char * sectionTextFormat = NULL, ...);

CLogIndenter * GetNextIndenter();

void SetNextIndenter(CLogIndenter * indenter);

virtual void AddCallback(ILogCallback * pCallback) = 0;

virtual const char* GetAssetScopeString();

Gets the filename where the current log backup was copied to on disk

virtual const char* GetBackupFileName() = 0;

Gets the filename used to log to disk.

virtual const char* GetFileName() = 0;

virtual void GetMemoryUsage(ICrySizer * pSizer) const = 0;

Notes: Collect memory statistics in CrySizer

virtual const char* GetModuleFilter() = 0;

virtual int GetVerbosityLevel() = 0;

Logs the text both to file and console.

virtual void Log(const char * szCommand, ...);

virtual void LogAlways(const char * szCommand, ...);

virtual void LogError(const char * szCommand, ...);

Logs the text both to the end of file and console.

virtual void LogPlus(const char * command, ...);

Logs to console only.

virtual void LogToConsole(const char * command, ...);

virtual void LogToConsolePlus(const char * command, ...);

Logs to the file specified in SetFileName.

virtual void LogToFile(const char * command, ...);

SetFileName

virtual void LogToFilePlus(const char * command, ...);

virtual void LogWarning(const char * szCommand, ...);

virtual void PopAssetScopeName();

virtual void PushAssetScopeName(const char * sAssetType, const char * sName);

Asset scope strings help to figure out asset dependencies in case of asset loading errors. Should not be used directly, only by using define CRY_DEFINE_ASSET_SCOPE @see CRY_DEFINE_ASSET_SCOPE

virtual void RegisterConsoleVariables();

virtual void Release() = 0;

virtual void RemoveCallback(ILogCallback * pCallback) = 0;

Sets the file used to log to disk.

virtual bool SetFileName(const char * command = NULL) = 0;

virtual void SetVerbosity(int verbosity) = 0;

Notes: Full logging (to console and file) can be enabled with verbosity 4. In the console 'log_Verbosity 4' command can be used.

virtual void UnregisterConsoleVariables();

virtual void Update() = 0;

Notes: The function called every frame by system.

virtual void UpdateLoadingScreen(const char * command, ...);