ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Dalamud.Game.Gui.GameGui.html
goaaats a3686d9c93
docs: regenerate
2022-01-29 05:15:26 +01:00

828 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class GameGui
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class GameGui
">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Dalamud.Game.Gui.GameGui">
<h1 id="Dalamud_Game_Gui_GameGui" data-uid="Dalamud.Game.Gui.GameGui" class="text-break">Class GameGui
</h1>
<div class="markdown level0 summary"><p>A class handling many aspects of the in-game UI.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">GameGui</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.Gui.html">Dalamud.Game.Gui</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_Gui_GameGui_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class GameGui : IDisposable</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_GameUiHidden.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.GameUiHidden%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L153">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_GameUiHidden_" data-uid="Dalamud.Game.Gui.GameGui.GameUiHidden*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_GameUiHidden" data-uid="Dalamud.Game.Gui.GameGui.GameUiHidden">GameUiHidden</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the game UI is hidden.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool GameUiHidden { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_HoveredAction.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.HoveredAction%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L164">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_HoveredAction_" data-uid="Dalamud.Game.Gui.GameGui.HoveredAction*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_HoveredAction" data-uid="Dalamud.Game.Gui.GameGui.HoveredAction">HoveredAction</h4>
<div class="markdown level1 summary"><p>Gets the action ID that is current hovered by the player. 0 when no action is hovered.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HoveredAction HoveredAction { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Gui.HoveredAction.html">HoveredAction</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_HoveredItem.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.HoveredItem%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L159">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_HoveredItem_" data-uid="Dalamud.Game.Gui.GameGui.HoveredItem*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_HoveredItem" data-uid="Dalamud.Game.Gui.GameGui.HoveredItem">HoveredItem</h4>
<div class="markdown level1 summary"><p>Gets or sets the item ID that is currently hovered by the player. 0 when no item is hovered.
If &gt; 1.000.000, subtract 1.000.000 and treat it as HQ.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ulong HoveredItem { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_Enable.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.Enable%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L441">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_Enable_" data-uid="Dalamud.Game.Gui.GameGui.Enable*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_Enable" data-uid="Dalamud.Game.Gui.GameGui.Enable">Enable()</h4>
<div class="markdown level1 summary"><p>Enables the hooks and submodules of this module.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Enable()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_IntPtr_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(System.IntPtr)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L395">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_IntPtr_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.IntPtr)">FindAgentInterface(IntPtr)</h4>
<div class="markdown level1 summary"><p>Find the agent associated with an addon, if possible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr FindAgentInterface(IntPtr addon)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><span class="parametername">addon</span></td>
<td><p>The addon address.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>A pointer to the agent interface.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L377">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_String_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.String)">FindAgentInterface(String)</h4>
<div class="markdown level1 summary"><p>Find the agent associated with an addon, if possible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr FindAgentInterface(string addonName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">addonName</span></td>
<td><p>The addon name.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>A pointer to the agent interface.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_FindAgentInterface_System_Void__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.FindAgentInterface(System.Void*)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L388">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_FindAgentInterface_" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_FindAgentInterface_System_Void__" data-uid="Dalamud.Game.Gui.GameGui.FindAgentInterface(System.Void*)">FindAgentInterface(Void*)</h4>
<div class="markdown level1 summary"><p>Find the agent associated with an addon, if possible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr FindAgentInterface(void *addon)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Void</span>*</td>
<td><span class="parametername">addon</span></td>
<td><p>The addon address.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>A pointer to the agent interface.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_GetAddonByName_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.GetAddonByName(System.String%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L355">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_GetAddonByName_" data-uid="Dalamud.Game.Gui.GameGui.GetAddonByName*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_GetAddonByName_System_String_System_Int32_" data-uid="Dalamud.Game.Gui.GameGui.GetAddonByName(System.String,System.Int32)">GetAddonByName(String, Int32)</h4>
<div class="markdown level1 summary"><p>Gets the pointer to the Addon with the given name and index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GetAddonByName(string name, int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>Name of addon to find.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>Index of addon to find (1-indexed).</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>IntPtr.Zero if unable to find UI, otherwise IntPtr pointing to the start of the addon.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_GetUIModule.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.GetUIModule%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L336">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_GetUIModule_" data-uid="Dalamud.Game.Gui.GameGui.GetUIModule*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_GetUIModule" data-uid="Dalamud.Game.Gui.GameGui.GetUIModule">GetUIModule()</h4>
<div class="markdown level1 summary"><p>Gets a pointer to the game's UI module.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IntPtr GetUIModule()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IntPtr</span></td>
<td><p>IntPtr pointing to UI module.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_OpenMapWithMapLink_Dalamud_Game_Text_SeStringHandling_Payloads_MapLinkPayload_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.OpenMapWithMapLink(Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L171">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_OpenMapWithMapLink_" data-uid="Dalamud.Game.Gui.GameGui.OpenMapWithMapLink*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_OpenMapWithMapLink_Dalamud_Game_Text_SeStringHandling_Payloads_MapLinkPayload_" data-uid="Dalamud.Game.Gui.GameGui.OpenMapWithMapLink(Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload)">OpenMapWithMapLink(MapLinkPayload)</h4>
<div class="markdown level1 summary"><p>Opens the in-game map with a flag on the location of the parameter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool OpenMapWithMapLink(MapLinkPayload mapLink)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload.html">MapLinkPayload</a></td>
<td><span class="parametername">mapLink</span></td>
<td><p>Link to the map to be opened.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if there were no errors and it could open the map.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_ScreenToWorld_System_Numerics_Vector2_System_Numerics_Vector3__System_Single_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.ScreenToWorld(System.Numerics.Vector2%2CSystem.Numerics.Vector3%40%2CSystem.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L247">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_ScreenToWorld_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_ScreenToWorld_System_Numerics_Vector2_System_Numerics_Vector3__System_Single_" data-uid="Dalamud.Game.Gui.GameGui.ScreenToWorld(System.Numerics.Vector2,System.Numerics.Vector3@,System.Single)">ScreenToWorld(Vector2, out Vector3, Single)</h4>
<div class="markdown level1 summary"><p>Converts screen coordinates to in-world coordinates via raycasting.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ScreenToWorld(Vector2 screenPos, out Vector3 worldPos, float rayDistance = 100000F)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Numerics.Vector2</span></td>
<td><span class="parametername">screenPos</span></td>
<td><p>Screen coordinates.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Numerics.Vector3</span></td>
<td><span class="parametername">worldPos</span></td>
<td><p>Converted coordinates.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">rayDistance</span></td>
<td><p>How far to search for a collision.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if successful. On false, worldPos's contents are undefined.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_SetBgm_System_UInt16_.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.SetBgm(System.UInt16)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L436">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_SetBgm_" data-uid="Dalamud.Game.Gui.GameGui.SetBgm*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_SetBgm_System_UInt16_" data-uid="Dalamud.Game.Gui.GameGui.SetBgm(System.UInt16)">SetBgm(UInt16)</h4>
<div class="markdown level1 summary"><p>Set the current background music.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetBgm(ushort bgmKey)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt16</span></td>
<td><span class="parametername">bgmKey</span></td>
<td><p>The background music key.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_WorldToScreen_System_Numerics_Vector3_System_Numerics_Vector2__.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.WorldToScreen(System.Numerics.Vector3%2CSystem.Numerics.Vector2%40)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L206">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_WorldToScreen_" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_WorldToScreen_System_Numerics_Vector3_System_Numerics_Vector2__" data-uid="Dalamud.Game.Gui.GameGui.WorldToScreen(System.Numerics.Vector3,System.Numerics.Vector2@)">WorldToScreen(Vector3, out Vector2)</h4>
<div class="markdown level1 summary"><p>Converts in-world coordinates to screen coordinates (upper left corner origin).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Numerics.Vector3</span></td>
<td><span class="parametername">worldPos</span></td>
<td><p>Coordinates in the world.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Numerics.Vector2</span></td>
<td><span class="parametername">screenPos</span></td>
<td><p>Converted coordinates.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if worldPos corresponds to a position in front of the camera.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="events">Events
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_HoveredActionChanged.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.HoveredActionChanged%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L148">View Source</a>
</span>
<h4 id="Dalamud_Game_Gui_GameGui_HoveredActionChanged" data-uid="Dalamud.Game.Gui.GameGui.HoveredActionChanged">HoveredActionChanged</h4>
<div class="markdown level1 summary"><p>Event that is fired when the currently hovered action changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;HoveredAction&gt; HoveredActionChanged</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.EventHandler</span>&lt;<a class="xref" href="Dalamud.Game.Gui.HoveredAction.html">HoveredAction</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_HoveredItemChanged.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.HoveredItemChanged%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L143">View Source</a>
</span>
<h4 id="Dalamud_Game_Gui_GameGui_HoveredItemChanged" data-uid="Dalamud.Game.Gui.GameGui.HoveredItemChanged">HoveredItemChanged</h4>
<div class="markdown level1 summary"><p>Event that is fired when the currently hovered item changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ulong&gt; HoveredItemChanged</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.EventHandler</span>&lt;<span class="xref">System.UInt64</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_UiHideToggled.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.UiHideToggled%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L138">View Source</a>
</span>
<h4 id="Dalamud_Game_Gui_GameGui_UiHideToggled" data-uid="Dalamud.Game.Gui.GameGui.UiHideToggled">UiHideToggled</h4>
<div class="markdown level1 summary"><p>Event which is fired when the game UI hiding is toggled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;bool&gt; UiHideToggled</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.EventHandler</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="eii">Explicit Interface Implementations
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui_System_IDisposable_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui.System%23IDisposable%23Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L469">View Source</a>
</span>
<a id="Dalamud_Game_Gui_GameGui_System_IDisposable_Dispose_" data-uid="Dalamud.Game.Gui.GameGui.System#IDisposable#Dispose*"></a>
<h4 id="Dalamud_Game_Gui_GameGui_System_IDisposable_Dispose" data-uid="Dalamud.Game.Gui.GameGui.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
<div class="markdown level1 summary"><p>Disables the hooks and submodules of this module.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void IDisposable.Dispose()</code></pre>
</div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Gui_GameGui.md&amp;value=---%0Auid%3A%20Dalamud.Game.Gui.GameGui%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/Gui/GameGui.cs/#L26" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink