Skip to main content

Class TitleScreenMenuEntry

Class representing an entry in the title screen menu.

Assembly: Dalamud.dll
Declaration
public class TitleScreenMenuEntry : ITitleScreenMenuEntry, IReadOnlyTitleScreenMenuEntry, IComparable<TitleScreenMenuEntry>

Implements:
Dalamud.Interface.ITitleScreenMenuEntry, Dalamud.Interface.IReadOnlyTitleScreenMenuEntry, System.IComparable<Dalamud.Interface.TitleScreenMenuEntry>

Properties

Priority

Gets the priority of this entry.

Declaration
public ulong Priority { get; init; }

Name

Gets the name of this entry.

Declaration
public string Name { get; set; }

Texture

Gets the texture of this entry.

Declaration
public ISharedImmediateTexture Texture { get; set; }

IsInternal

Gets or sets a value indicating whether this entry is internal.

Declaration
public bool IsInternal { get; set; }

CallingAssembly

Gets the calling assembly of this entry.

Declaration
public Assembly? CallingAssembly { get; init; }

Id

Gets the internal ID of this entry.

Declaration
public Guid Id { get; init; }

ShowConditionKeys

Gets the keys that have to be pressed to show the menu.

Declaration
public IReadOnlySet<VirtualKey> ShowConditionKeys { get; init; }

Methods

CompareTo(TitleScreenMenuEntry?)

Declaration
public int CompareTo(TitleScreenMenuEntry? other)
Returns

System.Int32

Parameters
TypeName
Dalamud.Interface.TitleScreenMenuEntryother

IsShowConditionSatisfied()

Determines the displaying condition of this menu entry is met.

Declaration
public bool IsShowConditionSatisfied()
Returns

System.Boolean: True if met.

Trigger()

Trigger the action associated with this entry.

Declaration
public void Trigger()

Implements