Class SonsMod

Inheritance
object
ModBase
ModTypeBase<SonsMod>
SonsMod
Inherited Members
Namespace: SonsSdk
Assembly: SonsSdk.dll
Syntax
public abstract class SonsMod : ModTypeBase<SonsMod>

Constructors

SonsMod()

Declaration
protected SonsMod()

Properties

Manifest

Declaration
public ManifestData Manifest { get; }
Property Value
Type Description
ManifestData

Methods

Configure(ModConfigurator)

Configure mod settings and subscribe to events.

Declaration
public virtual void Configure(SonsMod.ModConfigurator config)
Parameters
Type Name Description
SonsMod.ModConfigurator config

Log(Color, object)

Declaration
protected void Log(Color color, object obj)
Parameters
Type Name Description
Color color
object obj

Log(object)

Declaration
protected void Log(object obj)
Parameters
Type Name Description
object obj

Log(object, Color?)

Declaration
protected void Log(object msg, Color? color = null)
Parameters
Type Name Description
object msg
Color? color

OnGameStart()

Runs when the game scene is loaded (right before the player gains control).

Declaration
protected virtual void OnGameStart()

OnSceneWasInitialized(int, string)

Runs once a Scene is initialized.

Declaration
public virtual void OnSceneWasInitialized(int buildIndex, string sceneName)
Parameters
Type Name Description
int buildIndex
string sceneName

OnSceneWasLoaded(int, string)

Runs when a new Scene is loaded.

Declaration
public virtual void OnSceneWasLoaded(int buildIndex, string sceneName)
Parameters
Type Name Description
int buildIndex
string sceneName

OnSceneWasUnloaded(int, string)

Runs once a Scene unloads.

Declaration
public virtual void OnSceneWasUnloaded(int buildIndex, string sceneName)
Parameters
Type Name Description
int buildIndex
string sceneName

OnSdkInitialized()

Runs when the SDK is fully initialized. SDK usage like creation of custom UI should be done here.

Declaration
protected virtual void OnSdkInitialized()

OnSonsSceneInitialized(ESonsScene)

Runs when a scene is initialized. But with an enum parameter to check for sons scenes.

Declaration
protected virtual void OnSonsSceneInitialized(SdkEvents.ESonsScene sonsScene)
Parameters
Type Name Description
SdkEvents.ESonsScene sonsScene

RegisterCommand(string, Func<string, bool>)

Declaration
protected void RegisterCommand(string command, Func<string, bool> callback)
Parameters
Type Name Description
string command
Func<string, bool> callback

StartPropDebugging()

Declaration
protected void StartPropDebugging()

StopDebugging()

Declaration
protected void StopDebugging()