Skip to main content

Class TitleScreenMenuEntry

Class representing an entry in the title screen menu.

Assembly: Dalamud.dll​
View Source​
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.

View Source​
Declaration
public ulong Priority { get; init; }

Name​

Gets the name of this entry.

View Source​
Declaration
public string Name { get; set; }

Texture​

Gets the texture of this entry.

View Source​
Declaration
public IDalamudTextureWrap Texture { get; set; }

IsInternal​

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

View Source​
Declaration
public bool IsInternal { get; set; }

CallingAssembly​

Gets the calling assembly of this entry.

View Source​
Declaration
public Assembly? CallingAssembly { get; init; }

Id​

Gets the internal ID of this entry.

View Source​
Declaration
public Guid Id { get; init; }

ShowConditionKeys​

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

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

Methods​

CompareTo(TitleScreenMenuEntry?)​

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

View Source​
Declaration
public int CompareTo(TitleScreenMenuEntry? other)
Returns​

System.Int32: A value that indicates the relative order of the objects being compared. The return value has these meanings:

<table><thead><tr><th class="term"> Value</th><th class="description"> Meaning</th></tr></thead><tbody><tr><td class="term"> Less than zero</td><td class="description"> This instance precedes <code class="paramref">other</code> in the sort order.</td></tr><tr><td class="term"> Zero</td><td class="description"> This instance occurs in the same position in the sort order as <code class="paramref">other</code>.</td></tr><tr><td class="term"> Greater than zero</td><td class="description"> This instance follows <code class="paramref">other</code> in the sort order.</td></tr></tbody></table>

Parameters​
TypeNameDescription
Dalamud.Interface.TitleScreenMenuEntryotherAn object to compare with this instance.

IsShowConditionSatisfied()​

Determines the displaying condition of this menu entry is met.

View Source​
Declaration
public bool IsShowConditionSatisfied()
Returns​

System.Boolean: True if met.### Trigger() Trigger the action associated with this entry.

View Source​
Declaration
public void Trigger()

Implements​