Interface ITitleScreenMenu

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

Assembly: Dalamud.dll

View Source

Declaration

public interface ITitleScreenMenu

Properties

Entries

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

View Source

Declaration

IReadOnlyList<IReadOnlyTitleScreenMenuEntry> Entries { get; }

Methods

AddEntry(string, IDalamudTextureWrap, Action)

Adds a new entry to the title screen menu.

View Source

Declaration

IReadOnlyTitleScreenMenuEntry AddEntry(string text, IDalamudTextureWrap 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.TextureWraps.IDalamudTextureWrap	texture	The texture to show.
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, IDalamudTextureWrap, Action)

Adds a new entry to the title screen menu.

View Source

Declaration

IReadOnlyTitleScreenMenuEntry AddEntry(ulong priority, string text, IDalamudTextureWrap 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.TextureWraps.IDalamudTextureWrap	texture	The texture to show.
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.

View Source

Declaration

void RemoveEntry(IReadOnlyTitleScreenMenuEntry entry)

Parameters

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