Page tree
Skip to end of metadata
Go to start of metadata

#include <ILog.h>

Inherits IMiniLog.

Public Member Functions

virtual void Release ()=0
 
virtual bool SetFileName (const char *command=NULL)=0
 Set the file used to log to disk.
 
virtual const char * GetFileName () const =0
 Get the filename used to log to disk.
 
virtual const char * GetBackupFileName () const =0
 Get the filename where the current log backup was copied to on disk.
 
virtual void Log (const char *szCommand,...) PRINTF_PARAMS(2
 All the following functions will be removed are here just to be able to compile the project. More...
 
virtual void virtual void LogAlways (const char *szCommand,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void LogWarning (const char *szCommand,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void virtual void LogError (const char *szCommand,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void virtual void virtual void LogPlus (const char *command,...) PRINTF_PARAMS(2
 Logs the text both to the end of file and console.
 
virtual void virtual void virtual void virtual void virtual void virtual void LogToFile (const char *command,...) PRINTF_PARAMS(2
 Logs to the file specified in SetFileName.
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void LogToFilePlus (const char *command,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void LogToConsole (const char *command,...) PRINTF_PARAMS(2
 Logs to console only.
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void LogToConsolePlus (const char *command,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void UpdateLoadingScreen (const char *command,...) PRINTF_PARAMS(2
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void virtual void RegisterConsoleVariables ()
 
virtual void UnregisterConsoleVariables ()
 
virtual void SetVerbosity (int verbosity)=0
 
virtual int GetVerbosityLevel () const =0
 
virtual void AddCallback (ILogCallback *pCallback)=0
 
virtual void RemoveCallback (ILogCallback *pCallback)=0
 
virtual void SetLogMode (ELogMode eLogMode)=0
 
virtual ELogMode GetLogMode () const =0
 
virtual void ThreadExclusiveLogAccess (bool state)=0
 Wait for all other threads to finish writing. Then only allow calling thread to write to log.
 
virtual void Update ()=0
 
virtual const char * GetModuleFilter ()=0
 
virtual void GetMemoryUsage (ICrySizer *pSizer) const =0
 Collect memory statistics in CrySizer.
 
virtual void PushAssetScopeName (const char *sAssetType, const char *sName)
 
virtual void PopAssetScopeName ()
 
virtual const char * GetAssetScopeString ()
 
virtual void Flush ()=0
 
virtual void FlushAndClose ()=0
 

Detailed Description

Interface for logging operations based on IMiniLog. 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.

Member Function Documentation

◆ Log()

virtual void ILog::Log ( const char *  szCommand,
  ... 
)
virtual

All the following functions will be removed are here just to be able to compile the project.

Logs the text both to file and console.

◆ PushAssetScopeName()

virtual void ILog::PushAssetScopeName ( const char *  sAssetType,
const char *  sName 
)
inlinevirtual

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 also
CRY_DEFINE_ASSET_SCOPE.

◆ SetVerbosity()

virtual void ILog::SetVerbosity ( int  verbosity)
pure virtual

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

◆ Update()

virtual void ILog::Update ( )
pure virtual
Note
This is called on every frame by the system.
  • No labels