Class GameGui

Inheritance
System.Object
GameGui
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Dalamud.Game.Internal.Gui
Assembly: Dalamud.dll
Syntax
public sealed class GameGui : IDisposable

Constructors

| Improve this Doc View Source

GameGui(IntPtr, SigScanner, Dalamud)

Declaration
public GameGui(IntPtr baseAddress, SigScanner scanner, Dalamud dalamud)
Parameters
Type Name Description
System.IntPtr baseAddress
SigScanner scanner
Dalamud.Dalamud dalamud

Properties

| Improve this Doc View Source

Chat

Declaration
public ChatGui Chat { get; }
Property Value
Type Description
ChatGui
| Improve this Doc View Source

HoveredItem

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

Declaration
public ulong HoveredItem { get; set; }
Property Value
Type Description
System.UInt64
| Improve this Doc View Source

HoveredItemChanged

Event that is fired when the currently hovered item changes.

Declaration
public EventHandler<ulong> HoveredItemChanged { get; set; }
Property Value
Type Description
System.EventHandler<System.UInt64>

Methods

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Enable()

Declaration
public void Enable()
| Improve this Doc View Source

OpenMapWithMapLink(MapLinkPayload)

Opens the in-game map with a flag on the location of the parameter

Declaration
public bool OpenMapWithMapLink(MapLinkPayload mapLink)
Parameters
Type Name Description
MapLinkPayload mapLink

Link to the map to be opened
Returns
Type Description
System.Boolean

True if there were no errors and it could open the map
| Improve this Doc View Source

ScreenToWorld(Vector2, out Vector3, Single)

Converts screen coordinates to in-world coordinates via raycasting.

Declaration
public bool ScreenToWorld(Vector2 screenPos, out Vector3 worldPos, float rayDistance = 100000F)
Parameters
Type Name Description
SharpDX.Vector2 screenPos

Screen coordinates
SharpDX.Vector3 worldPos

Converted coordinates
System.Single rayDistance

How far to search for a collision
Returns
Type Description
System.Boolean

True if successful. On false, worldPos's contents are undefined
| Improve this Doc View Source

SetBgm(UInt16)

Declaration
public void SetBgm(ushort bgmKey)
Parameters
Type Name Description
System.UInt16 bgmKey
| Improve this Doc View Source

WorldToScreen(Vector3, out Vector2)

Converts in-world coordinates to screen coordinates (upper left corner origin).

Declaration
public bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos)
Parameters
Type Name Description
SharpDX.Vector3 worldPos

Coordinates in the world
SharpDX.Vector2 screenPos

Converted coordinates
Returns
Type Description
System.Boolean

True if worldPos corresponds to a position in front of the camera

Implements

System.IDisposable