Skip to main content

Interface IReadOnlyDtrBarEntry

Interface representing a read-only entry in the server info bar.

Assembly: Dalamud.dll
View Source
Declaration
public interface IReadOnlyDtrBarEntry

Properties

Title

Gets the title of this entry.

View Source
Declaration
string Title { get; }

HasClickAction

Gets a value indicating whether this entry has a click action.

View Source
Declaration
bool HasClickAction { get; }

Text

Gets the text of this entry.

View Source
Declaration
SeString Text { get; }

Tooltip

Gets a tooltip to be shown when the user mouses over the dtr entry.

View Source
Declaration
SeString Tooltip { get; }

Shown

Gets a value indicating whether this entry should be shown.

View Source
Declaration
bool Shown { get; }

UserHidden

Gets a value indicating whether or not the user has hidden this entry from view through the Dalamud settings.

View Source
Declaration
bool UserHidden { get; }

Methods

TriggerClickAction()

Triggers the click action of this entry.

View Source
Declaration
bool TriggerClickAction()
Returns

System.Boolean: True, if a click action was registered and executed.