Interface IDtrBar

Class used to interface with the server info bar.

Assembly: Dalamud.dll

Declaration

public interface IDtrBar : IDalamudService

Properties

Entries

Gets a read-only copy of the list of all DTR bar entries.

Declaration

IReadOnlyList<IReadOnlyDtrBarEntry> Entries { get; }

Remarks

If the list changes due to changes in order or insertion/removal, then this property will return a completely new object on getter invocation. The returned object is safe to use from any thread, and will not change.

Methods

Get(string, SeString?)

Get a DTR bar entry. This allows you to add your own text, and users to sort it.

Declaration

IDtrBarEntry Get(string title, SeString? text = null)

Returns

Dalamud.Game.Gui.Dtr.IDtrBarEntry: The entry object used to update, hide and remove the entry.

Parameters

Type	Name	Description
System.String	title	A user-friendly name for sorting.
Dalamud.Game.Text.SeStringHandling.SeString	text	The text the entry shows.

Exceptions

System.ArgumentException
Thrown when an entry with the specified title exists.

Remove(string)

Removes a DTR bar entry from the system.

Declaration

void Remove(string title)

Parameters

Type	Name	Description
System.String	title	Title of the entry to remove.

Remarks

Remove operation is not guaranteed to be immediately effective. Calls to Dalamud.Plugin.Services.IDtrBar.Get(System.String,Dalamud.Game.Text.SeStringHandling.SeString) may result in an entry marked to be remove being revived and used again.