Class SystemModule

The system module. This is Socially Distant itself.

Inheritance
object
GameModule
SystemModule
Inherited Members
Namespace: SociallyDistant
Assembly: SociallyDistant.dll
Syntax
public class SystemModule : GameModule

Constructors

SystemModule()

Creates a new instance of the SystemModule class.

Declaration
public SystemModule()
Exceptions
Type Condition
InvalidOperationException

Occurs when two instances of SystemModule try to co-exist. Don't.

Properties

IsCoreModule

Gets a value indicating whether this module is a core module. If true, then the user can't enable or disable this module during runtime.

Declaration
public override bool IsCoreModule { get; }
Property Value
Type Description
bool
Overrides

ModuleId

Gets a unique module ID for this module. Please use reverse domain name notation.

Declaration
public override string ModuleId { get; }
Property Value
Type Description
string
Overrides

Methods

GetSystemModule()

Checks that the SystemModule has been activated by Socially Distant's internal codebase, and returns a reference to it if so.

Declaration
public static SystemModule GetSystemModule()
Returns
Type Description
SystemModule

The global instance of SystemModule
Exceptions
Type Condition
InvalidOperationException

Socially Distant hasn't finished initializing yet.

OnInitialize()

Declaration
protected override Task OnInitialize()
Returns
Type Description
Task
Overrides

OnShutdown()

Declaration
protected override Task OnShutdown()
Returns
Type Description
Task
Overrides