Skip to main content

Class UiBuilder

This class represents the Dalamud UI that is drawn on top of the game. It can be used to draw custom windows and overlays.

Assembly: Dalamud.dll​
View Source​
Declaration
public sealed class UiBuilder : IDisposable, IUiBuilder

Implements:
System.IDisposable, Dalamud.Interface.IUiBuilder

Properties​

DefaultFontSizePt​

Gets the default Dalamud font size in points.

View Source​
Declaration
public static float DefaultFontSizePt { get; }

DefaultFontSizePx​

Gets the default Dalamud font size in pixels.

View Source​
Declaration
public static float DefaultFontSizePx { get; }

DefaultFont​

Gets the default Dalamud font - supporting all game languages and icons.

<strong>Accessing this static property outside of Dalamud.Interface.UiBuilder.Draw is dangerous and not supported.</strong>

View Source​
Declaration
public static ImFontPtr DefaultFont { get; }

IconFont​

Gets the default Dalamud icon font based on FontAwesome 5 Free solid.

<strong>Accessing this static property outside of Dalamud.Interface.UiBuilder.Draw is dangerous and not supported.</strong>

View Source​
Declaration
public static ImFontPtr IconFont { get; }

MonoFont​

Gets the default Dalamud monospaced font based on Inconsolata Regular.

<strong>Accessing this static property outside of Dalamud.Interface.UiBuilder.Draw is dangerous and not supported.</strong>

View Source​
Declaration
public static ImFontPtr MonoFont { get; }

DefaultFontSpec​

Gets the default font specifications.

View Source​
Declaration
public IFontSpec DefaultFontSpec { get; }

DefaultFontHandle​

Gets the handle to the default Dalamud font - supporting all game languages and icons.

View Source​
Declaration
public IFontHandle DefaultFontHandle { get; }

IconFontHandle​

Gets the default Dalamud icon font based on FontAwesome 5 Free solid.

View Source​
Declaration
public IFontHandle IconFontHandle { get; }

IconFontFixedWidthHandle​

Gets the default Dalamud icon font based on FontAwesome 5 free solid with a fixed width and vertically centered glyphs.

View Source​
Declaration
public IFontHandle IconFontFixedWidthHandle { get; }

MonoFontHandle​

Gets the default Dalamud monospaced font based on Inconsolata Regular.

View Source​
Declaration
public IFontHandle MonoFontHandle { get; }

Device​

Gets the game's active Direct3D device.

View Source​
Declaration
public Device Device { get; }

WindowHandlePtr​

Gets the game's main window handle.

View Source​
Declaration
public nint WindowHandlePtr { get; }

DisableAutomaticUiHide​

Gets or sets a value indicating whether this plugin should hide its UI automatically when the game's UI is hidden.

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

DisableUserUiHide​

Gets or sets a value indicating whether this plugin should hide its UI automatically when the user toggles the UI.

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

DisableCutsceneUiHide​

Gets or sets a value indicating whether this plugin should hide its UI automatically during cutscenes.

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

DisableGposeUiHide​

Gets or sets a value indicating whether this plugin should hide its UI automatically while gpose is active.

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

OverrideGameCursor​

Gets or sets a value indicating whether or not the game's cursor should be overridden with the ImGui cursor.

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

FrameCount​

Gets the count of Draw calls made since plugin creation.

View Source​
Declaration
public ulong FrameCount { get; }

CutsceneActive​

Gets a value indicating whether or not a cutscene is playing.

View Source​
Declaration
public bool CutsceneActive { get; }

ShouldModifyUi​

Gets a value indicating whether this plugin should modify the game's interface at this time.

View Source​
Declaration
public bool ShouldModifyUi { get; }

UiPrepared​

Gets a value indicating whether UI functions can be used.

View Source​
Declaration
public bool UiPrepared { get; }

FontAtlas​

Gets the plugin-private font atlas.

View Source​
Declaration
public IFontAtlas FontAtlas { get; }

ShouldUseReducedMotion​

Gets a value indicating whether or not to use "reduced motion". This usually means that you should use less intrusive animations, or disable them entirely.

View Source​
Declaration
public bool ShouldUseReducedMotion { get; }

Methods​

LoadUld(string)​

Loads an ULD file that can load textures containing multiple icons in a single texture.

View Source​
Declaration
public UldWrapper LoadUld(string uldPath)
Returns​

Dalamud.Interface.UldWrapper: A wrapper around said ULD file.

Parameters​
TypeNameDescription
System.StringuldPathThe path of the requested ULD file.

WaitForUi()​

Waits for UI to become available for use.

View Source​
Declaration
public Task WaitForUi()
Returns​

System.Threading.Tasks.Task: A task that completes when the game's Present has been called at least once.### RunWhenUiPrepared<T>(Func<T>, bool) Waits for UI to become available for use.

View Source​
Declaration
public Task<T> RunWhenUiPrepared<T>(Func<T> func, bool runInFrameworkThread = false)
Returns​

System.Threading.Tasks.Task<<T>>: A task that completes when the game's Present has been called at least once.

Parameters​
TypeNameDescription
System.Func<<T>>funcFunction to call.
System.BooleanrunInFrameworkThreadSpecifies whether to call the function from the framework thread.
Type Parameters​
NameDescription
TReturn type.

RunWhenUiPrepared<T>(Func<Task<T>>, bool)​

Waits for UI to become available for use.

View Source​
Declaration
public Task<T> RunWhenUiPrepared<T>(Func<Task<T>> func, bool runInFrameworkThread = false)
Returns​

System.Threading.Tasks.Task<<T>>: A task that completes when the game's Present has been called at least once.

Parameters​
TypeNameDescription
System.Func<System.Threading.Tasks.Task<<T>>>funcFunction to call.
System.BooleanrunInFrameworkThreadSpecifies whether to call the function from the framework thread.
Type Parameters​
NameDescription
TReturn type.

CreateFontAtlas(FontAtlasAutoRebuildMode, bool, string?)​

Creates an isolated Dalamud.Interface.ManagedFontAtlas.IFontAtlas.

View Source​
Declaration
public IFontAtlas CreateFontAtlas(FontAtlasAutoRebuildMode autoRebuildMode, bool isGlobalScaled = true, string? debugName = null)
Returns​

Dalamud.Interface.ManagedFontAtlas.IFontAtlas: A new instance of Dalamud.Interface.ManagedFontAtlas.IFontAtlas.

Parameters​
TypeNameDescription
Dalamud.Interface.ManagedFontAtlas.FontAtlasAutoRebuildModeautoRebuildModeSpecify when and how to rebuild this atlas.
System.BooleanisGlobalScaledWhether the fonts in the atlas is global scaled.
System.StringdebugNameName for debugging purposes.

Events​

Draw​

The event that gets called when Dalamud is ready to draw your windows or overlays. When it is called, you can use static ImGui calls.

View Source​
Declaration
public event Action? Draw
Event Type​

System.Action

ResizeBuffers​

The event that is called when the game's DirectX device is requesting you to resize your buffers.

View Source​
Declaration
public event Action? ResizeBuffers
Event Type​

System.Action

OpenConfigUi​

Event that is fired when the plugin should open its configuration interface.

View Source​
Declaration
public event Action? OpenConfigUi
Event Type​

System.Action

OpenMainUi​

Event that is fired when the plugin should open its main interface.

View Source​
Declaration
public event Action? OpenMainUi
Event Type​

System.Action

ShowUi​

Gets or sets an action that is called when plugin UI or interface modifications are supposed to be shown. These may be fired consecutively.

View Source​
Declaration
public event Action? ShowUi
Event Type​

System.Action

HideUi​

Gets or sets an action that is called when plugin UI or interface modifications are supposed to be hidden. These may be fired consecutively.

View Source​
Declaration
public event Action? HideUi
Event Type​

System.Action

Implements​