Skip to content

API Reference

Thev2Andy edited this page Jan 19, 2022 · 11 revisions

Logger Class API

The class used for writing logs.

• Methods

Logger.Log Method

• Definition

Calls a log, sent over to the OnLog event.

public static void Log(string LogMessage, LogType MessageType, bool SaveLogToFile, bool Timestamp, bool TriggerLogEvent, object LogSender)

• Parameters

LogMessage String

The message of the log.


MessageType LogType

The type of the log.


SaveLogToFile Bool

Save this specific log to the log file?


Timestamp Bool

Timestamp this log in the file?


TriggerLogEvent Bool

Trigger the OnLog event?


LogSender Object

The sender of the log. (Only used when passing the reference to LogEventArgs)


Logger.SaveLogToFile Method

• Definition

Saves the entire log in a file.

public static void SaveLogToFile(object Sender, EventArgs Args)

• Parameters

Sender Object

The event sender.


Args EventArgs

The arguments of the event.


Logger.LogException Method

• Definition

Used internally to log unhandled exceptions.

public static void LogExceptions(object Sender, UnhandledExceptionEventArgs ExceptionArgs)

• Parameters

Sender Object

The event sender.


ExceptionArgs UnhandledExceptionEventArgs

The arguments of the unhandled exception event.



Fields / Properties

Logger.OnLog EventHandler<LogEventArgs>

public static event EventHandler<LogEventArgs> OnLog;

Invoked on Log() call.


Logger.WriteInLogFile Bool

public static bool WriteInLogFile = true;

Toggle writing logs to a file, stored next to the caller assembly.


Logger.Initialized Bool

public static bool Initialized {get; private set;}

Determines if the Logger has been initialized.


Logger.EntireLog String

public static string EntireLog {get; private set;}

Stores all logs, called from the start of the application until now.



LogEventArgs Class API

Log Event Arguments holder.

Fields / Properties

LogMessage String

• Definition

The message of the log.

public string LogMessage;

MessageType LogType

• Definition

The type of the log.

public LogType MessageType;

LogTime DateTime

• Definition

The time the log was sent at.

public DateTime LogTime;

Timestamped Bool

• Definition

Is the log timestamped?

public bool Timestamped;

LogSender Object

• Definition

The sender of the log.

public object LogSender;


LogType Enum

Log type enumeration.

Fields / Properties

Info


Warning


Error


Fatal


Null

Clone this wiki locally