mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-01-01 13:23:40 +01:00
7947b896ea
* Add interfaces to non public/sealed classes referenced in public interfaces * Fixed inheritdocs + made most classes internal * Add missing properties to IFate and Fate, fix documentation --------- Co-authored-by: goat <16760685+goaaats@users.noreply.github.com>
44 lines
2 KiB
C#
44 lines
2 KiB
C#
using System.Collections.Generic;
|
|
|
|
using Dalamud.Interface;
|
|
using Dalamud.Interface.Internal;
|
|
|
|
namespace Dalamud.Plugin.Services;
|
|
|
|
/// <summary>
|
|
/// Interface for class responsible for managing elements in the title screen menu.
|
|
/// </summary>
|
|
public interface ITitleScreenMenu
|
|
{
|
|
/// <summary>
|
|
/// Gets the list of read only entries in the title screen menu.
|
|
/// </summary>
|
|
public IReadOnlyList<IReadOnlyTitleScreenMenuEntry> Entries { get; }
|
|
|
|
/// <summary>
|
|
/// Adds a new entry to the title screen menu.
|
|
/// </summary>
|
|
/// <param name="text">The text to show.</param>
|
|
/// <param name="texture">The texture to show.</param>
|
|
/// <param name="onTriggered">The action to execute when the option is selected.</param>
|
|
/// <returns>A <see cref="IReadOnlyTitleScreenMenuEntry"/> object that can be reference the entry.</returns>
|
|
/// <exception cref="ArgumentException">Thrown when the texture provided does not match the required resolution(64x64).</exception>
|
|
public IReadOnlyTitleScreenMenuEntry AddEntry(string text, IDalamudTextureWrap texture, Action onTriggered);
|
|
|
|
/// <summary>
|
|
/// Adds a new entry to the title screen menu.
|
|
/// </summary>
|
|
/// <param name="priority">Priority of the entry.</param>
|
|
/// <param name="text">The text to show.</param>
|
|
/// <param name="texture">The texture to show.</param>
|
|
/// <param name="onTriggered">The action to execute when the option is selected.</param>
|
|
/// <returns>A <see cref="IReadOnlyTitleScreenMenuEntry"/> object that can be used to reference the entry.</returns>
|
|
/// <exception cref="ArgumentException">Thrown when the texture provided does not match the required resolution(64x64).</exception>
|
|
public IReadOnlyTitleScreenMenuEntry AddEntry(ulong priority, string text, IDalamudTextureWrap texture, Action onTriggered);
|
|
|
|
/// <summary>
|
|
/// Remove an entry from the title screen menu.
|
|
/// </summary>
|
|
/// <param name="entry">The entry to remove.</param>
|
|
public void RemoveEntry(IReadOnlyTitleScreenMenuEntry entry);
|
|
}
|