Class BaseModule

Namespace

Shard.Modding.SDK.Module

Assembly

Shard.Modding.SDK.dll

Convenience base for a module's Module class. Stores the module context and re-exposes host events, registries, and logging through Events, Registries, and Log. Override the On* lifecycle hooks; only Manifest is required. Subclasses that own resources before setup completes may implement IDisposable; the host disposes them even when later lifecycle hooks are skipped.

public abstract class BaseModule : IModule

Inheritance

object

BaseModule

Implements

IModule

Derived

AssetsModule

I18nModule

ExampleModule

Module

AudioModule

BlocksModule

CameraModule

CosmeticsModule

CraftingModule

EntityStatsModule

EntityUiAssetsModule

FluidsModule

InteractionsModule

ItemsModule

ModelsModule

ProjectilesModule

TagsModule

TimeModule

VisualEffectsModule

WeatherModule

InventoryModule

UniverseAssetsModule

ClientFeatureModuleBase

UniverseModule

NetworkAuthModule

NetworkModule

AccessControlModule

PermissionsModule

UpdateModule

TelemetryModule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Context

Gets the module context, available from OnSetup() onward.

protected IModuleContext Context { get; }

Property Value

IModuleContext

Events

Gets the server event bus scoped to this module.

protected IEventBus Events { get; }

Property Value

IEventBus

Log

Gets the logger tagged with this module's identifier.

protected IShardLogger Log { get; }

Property Value

IShardLogger

Manifest

Gets the module's identity and dependency declaration.

public abstract ModuleManifest Manifest { get; }

Property Value

ModuleManifest

Services

Gets the host service provider used to resolve services exposed to this module.

protected IServiceRegistry Services { get; }

Property Value

IServiceRegistry

Methods

OnPreloadAsync(CancellationToken)

Performs asynchronous preload work that must complete before this module can start.

protected virtual Task OnPreloadAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A token that is canceled when server startup is interrupted.

Returns

Task

A task representing the asynchronous preload operation.

OnQuiesceAsync()

Stops new work and completes work already accepted by the module.

protected virtual Task OnQuiesceAsync()

Returns

Task

OnSetup()

Called during synchronous module setup after the module context has been assigned.

protected virtual void OnSetup()

OnShutdown()

Called in reverse load order after quiescence. This hook is skipped if setup does not complete; use IDisposable for cleanup required on every ownership path.

protected virtual void OnShutdown()

OnStart()

Called after preload and required dependencies start. The ready event is published after all eligible start hooks and failed or blocked module cleanup finish.

protected virtual void OnStart()