Class ModBase

Namespace: WukongMp.Sdk
Assembly: WukongMp.Sdk.dll

Base class for WukongMP SDK mods. Each mod should have exactly one class extending from this, which will be instantiated by the mod loader.

public abstract class ModBase : ICSharpModExV2, ICSharpModEx, ICSharpMod

Inheritance

object ← ModBase

Implements

ICSharpModExV2, ICSharpModEx, ICSharpMod

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

ModBase()

protected ModBase()

Properties

IsDebug

Indicates whether the mod is running in a debug build. Can be used to enable debug-only features or logging.

public bool IsDebug { get; }

Property Value

bool

Logger

protected ILogger Logger { get; }

Property Value

ILogger

Name

Mod name, used for logging and patching.

public abstract string Name { get; }

Property Value

string

Methods

DeInit()

Called by the mod loader on game closing.

public virtual void DeInit()

GetReloadContext()

Called by the mod loader. Used in hot reload.

public virtual object? GetReloadContext()

Returns

object?

Init()

Called by the mod loader on game start.

public void Init()

Initialize(IDependencyContainer)

protected abstract void Initialize(IDependencyContainer services)

Parameters

services IDependencyContainer

LateInit()

Called by the mod loader after all Init calls.

public virtual void LateInit()

Reload(object?)

Called by the mod loader. Used in hot reload.

public virtual void Reload(object? context)

Parameters

context object?

SetLoggerFactory(ILoggerFactory)

Called by the mod loader.

public void SetLoggerFactory(ILoggerFactory loggerFactory)

Parameters

loggerFactory ILoggerFactory