Interface IGameGui
A class handling many aspects of the in-game UI.
Assembly: Dalamud.dll
public interface IGameGui : IDalamudService
Properties
GameUiHidden
Gets a value indicating whether the game UI is hidden.
bool GameUiHidden { get; }
HoveredItem
Gets or sets the item ID that is currently hovered by the player. 0 when no item is hovered. If > 1.000.000, subtract 1.000.000 and treat it as HQ.
ulong HoveredItem { get; set; }
HoveredAction
Gets the action ID that is current hovered by the player. 0 when no action is hovered.
HoveredAction HoveredAction { get; }
Methods
OpenMapWithMapLink(MapLinkPayload)
Opens the in-game map with a flag on the location of the parameter.
bool OpenMapWithMapLink(MapLinkPayload mapLink)
Returns
System.Boolean: True if there were no errors and it could open the map.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload | mapLink | Link to the map to be opened. |
OpenMapWithMapLink(uint, uint, Vector3)
Opens the in-game map with a flag on the location of the parameter.
bool OpenMapWithMapLink(uint territory, uint map, Vector3 worldPos)
Returns
System.Boolean: True if there were no errors and it could open the map.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | territory | Territory to link. |
System.UInt32 | map | Map to link. |
System.Numerics.Vector3 | worldPos | Position of the link. |
WorldToScreen(Vector3, out Vector2)
Converts in-world coordinates to screen coordinates (upper left corner origin).
bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos)
Returns
System.Boolean: True if worldPos corresponds to a position in front of the camera and screenPos is in the viewport.
Parameters
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector3 | worldPos | Coordinates in the world. |
System.Numerics.Vector2 | screenPos | Converted coordinates. |
WorldToScreen(Vector3, out Vector2, out bool)
Converts in-world coordinates to screen coordinates (upper left corner origin).
bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos, out bool inView)
Returns
System.Boolean: True if worldPos corresponds to a position in front of the camera.
Parameters
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector3 | worldPos | Coordinates in the world. |
System.Numerics.Vector2 | screenPos | Converted coordinates. |
System.Boolean | inView | True if screenPos corresponds to a position inside the camera viewport. |
ScreenToWorld(Vector2, out Vector3, float)
Converts screen coordinates to in-world coordinates via raycasting.
bool ScreenToWorld(Vector2 screenPos, out Vector3 worldPos, float rayDistance = 100000)
Returns
System.Boolean: True if successful. On false, worldPos's contents are undefined.
Parameters
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector2 | screenPos | Screen coordinates. |
System.Numerics.Vector3 | worldPos | Converted coordinates. |
System.Single | rayDistance | How far to search for a collision. |
GetUIModule()
Gets a pointer to the game's UIModule instance.
UIModulePtr GetUIModule()
Returns
Dalamud.Game.NativeWrapper.UIModulePtr: A pointer wrapper to UIModule.
GetAddonByName(string, int)
Gets the pointer to the Addon with the given name and index.
AtkUnitBasePtr GetAddonByName(string name, int index = 1)
Returns
Dalamud.Game.NativeWrapper.AtkUnitBasePtr: A pointer wrapper to the addon.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | name | Name of addon to find. |
System.Int32 | index | Index of addon to find (1-indexed). |
GetAddonByName<T>(string, int)
Gets the pointer to the Addon with the given name and index.
T* GetAddonByName<T>(string name, int index = 1) where T : unmanaged
Returns
<T>*: A pointer wrapper to the addon.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | name | Name of addon to find. |
System.Int32 | index | Index of addon to find (1-indexed). |
Type Parameters
| Name | Description |
|---|---|
T | Type of addon pointer AtkUnitBase or any derived struct. |
GetAgentById(int)
Find the agent associated with an addon, if possible.
AgentInterfacePtr GetAgentById(int id)
Returns
Dalamud.Game.NativeWrapper.AgentInterfacePtr: A pointer wrapper to the agent interface.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | id | The agent id. |
FindAgentInterface(string)
Find the agent associated with an addon, if possible.
AgentInterfacePtr FindAgentInterface(string addonName)
Returns
Dalamud.Game.NativeWrapper.AgentInterfacePtr: A pointer wrapper to the agent interface.
Parameters
| Type | Name | Description |
|---|---|---|
System.String | addonName | The addon name. |
FindAgentInterface(AtkUnitBasePtr)
Find the agent associated with an addon, if possible.
AgentInterfacePtr FindAgentInterface(AtkUnitBasePtr addon)
Returns
Dalamud.Game.NativeWrapper.AgentInterfacePtr: A pointer wrapper to the agent interface.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.NativeWrapper.AtkUnitBasePtr | addon | The addon address. |
Events
UiHideToggled
Event which is fired when the game UI hiding is toggled.
event EventHandler<bool> UiHideToggled
Event Type
System.EventHandler<System.Boolean>
HoveredItemChanged
Event that is fired when the currently hovered item changes.
event EventHandler<ulong> HoveredItemChanged
Event Type
System.EventHandler<System.UInt64>
HoveredActionChanged
Event that is fired when the currently hovered action changes.
event EventHandler<HoveredAction> HoveredActionChanged
Event Type
System.EventHandler<Dalamud.Game.Gui.HoveredAction>
AgentUpdate
Fired when the game sets one or more Dalamud.Game.Gui.AgentUpdateFlag values, used by agents to conditionally update their addons.
event Action<AgentUpdateFlag> AgentUpdate
Event Type
System.Action<Dalamud.Game.Gui.AgentUpdateFlag>