Skip to main content

Namespace Dalamud.Plugin.Services

Interfaces

IAddonEventManager

Service provider for addon event management.

IAddonLifecycle

This class provides events for in-game addon lifecycles.

IAetheryteList

This collection represents the list of available Aetherytes in the Teleport window.

IBuddyList

This collection represents the buddies present in your squadron or trust party. It does not include the local player.

IChatGui

This class handles interacting with the native chat UI.

IClientState

This class represents the state of the game client at the time of access.

ICommandManager

This class manages registered in-game slash commands.

ICondition

Provides access to conditions (generally player state). You can check whether a player is in combat, mounted, etc.

IContextMenu

This class provides methods for interacting with the game's context menu.

IDataManager

This class provides data for Dalamud-internal features, but can also be used by plugins if needed.

IDtrBar

Class used to interface with the server info bar.

IDutyState

This class represents the state of the currently occupied duty.

IFateTable

This collection represents the currently available Fate events.

IFlyTextGui

This class facilitates interacting with and creating native in-game "fly text".

IFramework

This class represents the Framework of the native game client and grants access to various subsystems.

IGameConfig

This class represents the game's configuration.

IGameGui

A class handling many aspects of the in-game UI.

IGameInteropProvider

Service responsible for the creation of hooks.

IGameInventory

This class provides events for the in-game inventory.

IGameLifecycle

Class offering cancellation tokens for common gameplay events.

IGameNetwork

This class handles interacting with game network events.

IGamepadState

Exposes the game gamepad state to dalamud.

Will block game's gamepad input if ImGuiNET.ImGuiConfigFlags.NavEnableGamepad is set.

IJobGauges

This class converts in-memory Job gauge data to structs.

IKeyState

Wrapper around the game keystate buffer, which contains the pressed state for all keyboard keys, indexed by virtual vkCode.

ILibcFunction

This class handles creating cstrings utilizing native game methods.

INotificationManager

Manager for notifications provided by Dalamud using ImGui.

IObjectTable

This collection represents the currently spawned FFXIV game objects.

IPartyFinderGui

This class handles interacting with the native PartyFinder window.

IPartyList

This collection represents the actors present in your party or alliance.

IPluginLog

An opinionated service to handle logging for plugins.

ITextureProvider

Service that grants you access to textures you may render via ImGui.

ITextureSubstitutionProvider

Service that grants you the ability to replace texture data that is to be loaded by Dalamud.

ITitleScreenMenu

Interface for class responsible for managing elements in the title screen menu.

IToastGui

This class facilitates interacting with and creating native toast windows.

Enums

IGameInteropProvider.HookBackend

Available hooking backends.

ITextureProvider.IconFlags

Flags describing the icon you wish to receive.

Delegates

IAddonEventManager.AddonEventHandler

Delegate to be called when an event is received.

IAddonLifecycle.AddonEventDelegate

Delegate for receiving addon lifecycle event messages.

IChatGui.OnCheckMessageHandledDelegate

A delegate type used with the Dalamud.Game.Gui.ChatGui.CheckMessageHandled event.

IChatGui.OnMessageDelegate

A delegate type used with the Dalamud.Game.Gui.ChatGui.ChatMessage event.

IChatGui.OnMessageHandledDelegate

A delegate type used with the Dalamud.Game.Gui.ChatGui.ChatMessageHandled event.

IChatGui.OnMessageUnhandledDelegate

A delegate type used with the Dalamud.Game.Gui.ChatGui.ChatMessageUnhandled event.

ICondition.ConditionChangeDelegate

A delegate type used with the Dalamud.Plugin.Services.ICondition.ConditionChange event.

IContextMenu.OnMenuOpenedDelegate

A delegate type used for the Dalamud.Plugin.Services.IContextMenu.OnMenuOpened event.

IFlyTextGui.OnFlyTextCreatedDelegate

The delegate defining the type for the FlyText event.

IFramework.OnUpdateDelegate

A delegate type used with the Dalamud.Plugin.Services.IFramework.Update event.

IGameInventory.InventoryChangedDelegate

Delegate function to be called for each change to inventories. This delegate sends individual events for changes.

IGameInventory.InventoryChangedDelegate<T>

Delegate function to be called for each change to inventories. This delegate sends individual events for changes.

IGameInventory.InventoryChangelogDelegate

Delegate function to be called when inventories have been changed. This delegate sends the entire set of changes recorded.

IGameNetwork.OnNetworkMessageDelegate

The delegate type of a network message event.

IPartyFinderGui.PartyFinderListingEventDelegate

Event type fired each time the game receives an individual Party Finder listing. Cannot modify listings but can hide them.

ITextureSubstitutionProvider.TextureDataInterceptorDelegate

Delegate describing a function that may be used to intercept and replace texture data. The path assigned may point to another texture inside the game's dats, or a .tex file or image on the disk.

IToastGui.OnErrorToastDelegate

A delegate type used when an error toast window appears.

IToastGui.OnNormalToastDelegate

A delegate type used when a normal toast window appears.

IToastGui.OnQuestToastDelegate

A delegate type used when a quest toast window appears.