Interface ITitleScreenMenu

Interface for class responsible for managing elements in the title screen menu.

Assembly: Dalamud.dll

Declaration

public interface ITitleScreenMenu : IDalamudService

Properties

Entries

Gets the list of read only entries in the title screen menu.

Declaration

IReadOnlyList<IReadOnlyTitleScreenMenuEntry> Entries { get; }

Methods

AddEntry(string, ISharedImmediateTexture, Action)

Adds a new entry to the title screen menu.

Declaration

IReadOnlyTitleScreenMenuEntry AddEntry(string text, ISharedImmediateTexture texture, Action onTriggered)

Returns

Dalamud.Interface.IReadOnlyTitleScreenMenuEntry: A Dalamud.Interface.IReadOnlyTitleScreenMenuEntry object that can be reference the entry.

Parameters

Type	Name	Description
System.String	text	The text to show.
Dalamud.Interface.Textures.ISharedImmediateTexture	texture	The texture to show. The texture must be 64x64 or the entry will be removed and an error will be logged.
System.Action	onTriggered	The action to execute when the option is selected.

Exceptions

System.ArgumentException
Thrown when the texture provided does not match the required resolution(64x64).

AddEntry(ulong, string, ISharedImmediateTexture, Action)

Adds a new entry to the title screen menu.

Declaration

IReadOnlyTitleScreenMenuEntry AddEntry(ulong priority, string text, ISharedImmediateTexture texture, Action onTriggered)

Returns

Dalamud.Interface.IReadOnlyTitleScreenMenuEntry: A Dalamud.Interface.IReadOnlyTitleScreenMenuEntry object that can be used to reference the entry.

Parameters

Type	Name	Description
System.UInt64	priority	Priority of the entry.
System.String	text	The text to show.
Dalamud.Interface.Textures.ISharedImmediateTexture	texture	The texture to show. The texture must be 64x64 or the entry will be removed and an error will be logged.
System.Action	onTriggered	The action to execute when the option is selected.

Exceptions

System.ArgumentException
Thrown when the texture provided does not match the required resolution(64x64).

RemoveEntry(IReadOnlyTitleScreenMenuEntry)

Remove an entry from the title screen menu.

Declaration

void RemoveEntry(IReadOnlyTitleScreenMenuEntry entry)

Parameters

Type	Name	Description
Dalamud.Interface.IReadOnlyTitleScreenMenuEntry	entry	The entry to remove.