Class LoggingConfig

Namespace

MonkeyLoader.Logging

Assembly

MonkeyLoader.dll

public sealed class LoggingConfig : ConfigSection, INestedIdentifiable<Config>, INestedIdentifiable, IIdentifiableOwner<ConfigSection, IDefiningConfigKey>, IIdentifiableOwner<IDefiningConfigKey>, IIdentifiable, IPrioritizable

Inheritance

object

ConfigSection

LoggingConfig

Implements

INestedIdentifiable<Config>

INestedIdentifiable

IIdentifiableOwner<ConfigSection, IDefiningConfigKey>

IIdentifiableOwner<IDefiningConfigKey>

IIdentifiable

IPrioritizable

Inherited Members

ConfigSection.Config

ConfigSection.FullId

ConfigSection.HasChanges

ConfigSection.InternalAccessOnly

ConfigSection.Keys

ConfigSection.Name

ConfigSection.Saveable

ConfigSection.Equals(object)

ConfigSection.GetDefinedKey(IConfigKey)

ConfigSection.GetDefinedKey<T>(IDefiningConfigKey<T>)

ConfigSection.GetHashCode()

ConfigSection.OnItemChanged(IConfigKeyChangedEventArgs)

ConfigSection.Reset()

ConfigSection.TryGetDefinedKey<T>(ITypedConfigKey<T>, out IDefiningConfigKey<T>)

ConfigSection.TryGetDefinedKey(IConfigKey, out IDefiningConfigKey)

ConfigSection.ItemChanged

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable)

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>, out TParentIdentifiable?)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, out TParentIdentifiable?)

IdentifiableExtensions.Get<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.TryGet<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.Get<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

IdentifiableExtensions.TryGet<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

Constructors

LoggingConfig()

public LoggingConfig()

Fields

DirectoryPathKey

public readonly DefiningConfigKey<string?> DirectoryPathKey

Field Value

DefiningConfigKey<string>

FileExtension

public const string FileExtension = ".log"

Field Value

string

FileNamePrefix

public const string FileNamePrefix = "MonkeyLog_"

Field Value

string

FileSearchPattern

public const string FileSearchPattern = "*.log"

Field Value

string

FilesToPreserveKey

public readonly DefiningConfigKey<int> FilesToPreserveKey

Field Value

DefiningConfigKey<int>

LevelKey

public readonly DefiningConfigKey<LoggingLevel> LevelKey

Field Value

DefiningConfigKey<LoggingLevel>

ShouldLogToConsoleKey

public readonly DefiningConfigKey<bool> ShouldLogToConsoleKey

Field Value

DefiningConfigKey<bool>

TimestampFormat

public const string TimestampFormat = "yyyy-MM-ddTHH-mm-ss"

Field Value

string

Properties

Controller

Gets the LoggingController used by the loader that owns this config and everything loaded by it.

public LoggingController Controller { get; }

Property Value

LoggingController

CurrentLogFilePath

public string? CurrentLogFilePath { get; }

Property Value

string

Description

Gets a description of the config items found in this section.

public override string Description { get; }

Property Value

string

DirectoryPath

public string? DirectoryPath { get; }

Property Value

string

FilesToPreserve

public int FilesToPreserve { get; }

Property Value

int

Id

Gets the mod-unique identifier of this section.

public override string Id { get; }

Property Value

string

Priority

Gets the priority of this item. Use an agreed standard as a base.

public override int Priority { get; }

Property Value

int

An interger used to sort the prioritizable items.
Higher comes first with the default comparer.

Remarks

Controls in which order the sections of a Config are listed.

ShouldCleanLogDirectory

public bool ShouldCleanLogDirectory { get; }

Property Value

bool

ShouldLogToConsole

public bool ShouldLogToConsole { get; }

Property Value

bool

ShouldWriteLogFile

public bool ShouldWriteLogFile { get; }

Property Value

bool

Version

Gets the semantic version for this config section.
This is used to check if the defined and saved configs are compatible.

public override Version Version { get; }

Property Value

Version

Methods

TryGetTimestamp(string, out DateTime?)

public static bool TryGetTimestamp(string logFile, out DateTime? timestamp)

Parameters

logFile string

timestamp DateTime?

Returns

bool