Class TitleAddon

Namespace

Nautilus.Handlers.TitleScreen

Assembly

Nautilus.dll

A custom title addon for the main menu. Inherit from this class to create your own main menu functionality.

public abstract class TitleAddon

Inheritance

object

TitleAddon

Derived

MusicTitleAddon

SkyChangeTitleAddon

WorldObjectTitleAddon

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

JsonExtensions.LoadJsonAsync<T>(T, string, bool, params JsonConverter[])

JsonExtensions.LoadJson<T>(T, string, bool, params JsonConverter[])

JsonExtensions.SaveJsonAsync<T>(T, string, params JsonConverter[])

JsonExtensions.SaveJson<T>(T, string, params JsonConverter[])

ReflectionHelper.CopyFields<T>(T, T, BindingFlags)

ReflectionHelper.GetInstanceField<T>(T, string, BindingFlags)

ReflectionHelper.GetInstanceMethod<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticField<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticMethod<T>(T, string, BindingFlags)

ReflectionHelper.SetInstanceField<T>(T, string, object, BindingFlags)

ReflectionHelper.SetStaticField<T>(T, string, object, BindingFlags)

Constructors

TitleAddon()

Creates a new instance of TitleAddon.

protected TitleAddon()

TitleAddon(string[])

Creates a new instance of TitleAddon.

protected TitleAddon(string[] requiredGUIDs)

Parameters

requiredGUIDs string[]

The required mod GUIDs for this addon to enable. Each required mod must approve this addon by using ApproveTitleCollaboration(BaseUnityPlugin, CollaborationData).

Properties

IsEnabled

Whether the addon is currently enabled.

public bool IsEnabled { get; }

Property Value

bool

ModGuid

The GUID of the mod that owns this addon.

public string ModGuid { get; }

Property Value

string

RequiredGUIDs

The required mod GUIDs for this addon to be enabled.

public string[] RequiredGUIDs { get; }

Property Value

string[]

Methods

OnDisable()

Called when the addon is disabled. This occurs when your mod is deselected as the current theme, or if the addon inherits from MusicTitleAddon and the game starts.

protected abstract void OnDisable()

OnEnable()

Called when the addon is enabled. This occurs when your mod is selected as the current theme.

protected abstract void OnEnable()

OnEnterLoadScreen()

Is called when the player clicks on a save, and the loading screen is enabled.

protected virtual void OnEnterLoadScreen()

OnInitialize()

Runs initialization code once before the main menu is loaded to set up required fields.

protected virtual void OnInitialize()