mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-13 12:14:16 +01:00
docs: document UiBuilder
This commit is contained in:
parent
3ff201c79b
commit
a11d9eb8bd
1 changed files with 17 additions and 1 deletions
|
|
@ -8,13 +8,26 @@ using ImGuiScene;
|
||||||
|
|
||||||
namespace Dalamud.Interface
|
namespace Dalamud.Interface
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// This class represents the Dalamud UI that is drawn on top of the game.
|
||||||
|
/// It can be used to draw custom windows and overlays.
|
||||||
|
/// </summary>
|
||||||
public class UiBuilder : IDisposable {
|
public class UiBuilder : IDisposable {
|
||||||
private readonly string namespaceName;
|
private readonly string namespaceName;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The delegate that gets called when Dalamud is ready to draw your windows or overlays.
|
||||||
|
/// When it is called, you can use static ImGui calls.
|
||||||
|
/// </summary>
|
||||||
public event RawDX11Scene.BuildUIDelegate OnBuildUi;
|
public event RawDX11Scene.BuildUIDelegate OnBuildUi;
|
||||||
|
|
||||||
private InterfaceManager interfaceManager;
|
private readonly InterfaceManager interfaceManager;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Create a new UiBuilder and register it. You do not have to call this manually.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="interfaceManager">The interface manager to register on.</param>
|
||||||
|
/// <param name="namespaceName">The plugin namespace.</param>
|
||||||
public UiBuilder(InterfaceManager interfaceManager, string namespaceName) {
|
public UiBuilder(InterfaceManager interfaceManager, string namespaceName) {
|
||||||
this.namespaceName = namespaceName;
|
this.namespaceName = namespaceName;
|
||||||
|
|
||||||
|
|
@ -22,6 +35,9 @@ namespace Dalamud.Interface
|
||||||
this.interfaceManager.OnDraw += OnDraw;
|
this.interfaceManager.OnDraw += OnDraw;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Unregister the UiBuilder. Do not call this in plugin code.
|
||||||
|
/// </summary>
|
||||||
public void Dispose() {
|
public void Dispose() {
|
||||||
this.interfaceManager.OnDraw -= OnDraw;
|
this.interfaceManager.OnDraw -= OnDraw;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue