docs: regenerate

This commit is contained in:
goaaats 2022-04-03 04:09:45 +02:00
parent 10c7cee542
commit 077c1bca96
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
1010 changed files with 17458 additions and 9354 deletions

View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DataManager
">
<meta name="generator" content="docfx 2.59.0.0">
<meta name="generator" content="docfx 2.59.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -131,8 +131,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[UsedImplicitly]
public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></pre>
<pre><code class="lang-csharp hljs">public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
@ -158,7 +157,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_Excel_" data-uid="Dalamud.Data.DataManager.Excel*"></a>
<h4 id="Dalamud_Data_DataManager_Excel" data-uid="Dalamud.Data.DataManager.Excel">Excel</h4>
<div class="markdown level1 summary"><p>Gets an <span class="xref">Lumina.Excel.ExcelModule</span> object which gives access to any of the game's sheet data.</p>
<div class="markdown level1 summary"><p>Gets an <see cref="!:ExcelModule"></see> object which gives access to any of the game's sheet data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -175,7 +174,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Excel.ExcelModule</span></td>
<td><span class="xref">ExcelModule</span></td>
<td></td>
</tr>
</tbody>
@ -189,7 +188,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GameData_" data-uid="Dalamud.Data.DataManager.GameData*"></a>
<h4 id="Dalamud_Data_DataManager_GameData" data-uid="Dalamud.Data.DataManager.GameData">GameData</h4>
<div class="markdown level1 summary"><p>Gets a <span class="xref">Lumina</span> object which gives access to any excel/game data.</p>
<div class="markdown level1 summary"><p>Gets a <see cref="!:Lumina"></see> object which gives access to any excel/game data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -206,7 +205,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.GameData</span></td>
<td><span class="xref">GameData</span></td>
<td></td>
</tr>
</tbody>
@ -365,12 +364,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetExcelSheet_" data-uid="Dalamud.Data.DataManager.GetExcelSheet*"></a>
<h4 id="Dalamud_Data_DataManager_GetExcelSheet__1" data-uid="Dalamud.Data.DataManager.GetExcelSheet``1">GetExcelSheet&lt;T&gt;()</h4>
<div class="markdown level1 summary"><p>Get an <span class="xref">Lumina.Excel.ExcelSheet&lt;T&gt;</span> with the given Excel sheet row type.</p>
<div class="markdown level1 summary"><p>Get an <see cref="!:ExcelSheet&lt;T>"></see> with the given Excel sheet row type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelSheet&lt;T&gt; GetExcelSheet&lt;T&gt;()
<pre><code class="lang-csharp hljs">public ExcelSheet&lt;T&gt;? GetExcelSheet&lt;T&gt;()
where T : ExcelRow</code></pre>
</div>
<h5 class="returns">Returns</h5>
@ -383,8 +382,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Excel.ExcelSheet</span>&lt;T&gt;</td>
<td><p>The <span class="xref">Lumina.Excel.ExcelSheet&lt;T&gt;</span>, giving access to game rows.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">ExcelSheet</span>&lt;T&gt;&gt;</td>
<td><p>The <see cref="!:ExcelSheet&lt;T>"></see>, giving access to game rows.</p>
</td>
</tr>
</tbody>
@ -414,12 +413,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetExcelSheet_" data-uid="Dalamud.Data.DataManager.GetExcelSheet*"></a>
<h4 id="Dalamud_Data_DataManager_GetExcelSheet__1_Dalamud_ClientLanguage_" data-uid="Dalamud.Data.DataManager.GetExcelSheet``1(Dalamud.ClientLanguage)">GetExcelSheet&lt;T&gt;(ClientLanguage)</h4>
<div class="markdown level1 summary"><p>Get an <span class="xref">Lumina.Excel.ExcelSheet&lt;T&gt;</span> with the given Excel sheet row type with a specified language.</p>
<div class="markdown level1 summary"><p>Get an <see cref="!:ExcelSheet&lt;T>"></see> with the given Excel sheet row type with a specified language.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelSheet&lt;T&gt; GetExcelSheet&lt;T&gt;(ClientLanguage language)
<pre><code class="lang-csharp hljs">public ExcelSheet&lt;T&gt;? GetExcelSheet&lt;T&gt;(ClientLanguage language)
where T : ExcelRow</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
@ -450,8 +449,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Excel.ExcelSheet</span>&lt;T&gt;</td>
<td><p>The <span class="xref">Lumina.Excel.ExcelSheet&lt;T&gt;</span>, giving access to game rows.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">ExcelSheet</span>&lt;T&gt;&gt;</td>
<td><p>The <see cref="!:ExcelSheet&lt;T>"></see>, giving access to game rows.</p>
</td>
</tr>
</tbody>
@ -481,12 +480,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetFile_" data-uid="Dalamud.Data.DataManager.GetFile*"></a>
<h4 id="Dalamud_Data_DataManager_GetFile_System_String_" data-uid="Dalamud.Data.DataManager.GetFile(System.String)">GetFile(String)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.FileResource</span> with the given path.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:FileResource"></see> with the given path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FileResource GetFile(string path)</code></pre>
<pre><code class="lang-csharp hljs">public FileResource? GetFile(string path)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -516,8 +515,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.FileResource</span></td>
<td><p>The <span class="xref">Lumina.Data.FileResource</span> of the file.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">FileResource</span>&gt;</td>
<td><p>The <see cref="!:FileResource"></see> of the file.</p>
</td>
</tr>
</tbody>
@ -531,7 +530,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetFile_" data-uid="Dalamud.Data.DataManager.GetFile*"></a>
<h4 id="Dalamud_Data_DataManager_GetFile__1_System_String_" data-uid="Dalamud.Data.DataManager.GetFile``1(System.String)">GetFile&lt;T&gt;(String)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.FileResource</span> with the given path, of the given type.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:FileResource"></see> with the given path, of the given type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -568,7 +567,7 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><p>The <span class="xref">Lumina.Data.FileResource</span> of the file.</p>
<td><p>The <see cref="!:FileResource"></see> of the file.</p>
</td>
</tr>
</tbody>
@ -598,12 +597,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetHqIcon_" data-uid="Dalamud.Data.DataManager.GetHqIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetHqIcon_System_UInt32_" data-uid="Dalamud.Data.DataManager.GetHqIcon(System.UInt32)">GetHqIcon(UInt32)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.Files.TexFile</span> containing the HQ icon with the given ID.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:TexFile"></see> containing the HQ icon with the given ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TexFile GetHqIcon(uint iconId)</code></pre>
<pre><code class="lang-csharp hljs">public TexFile? GetHqIcon(uint iconId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -633,8 +632,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><p>The <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><p>The <see cref="!:TexFile"></see> containing the icon.</p>
</td>
</tr>
</tbody>
@ -648,12 +647,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_Dalamud_ClientLanguage_System_UInt32_" data-uid="Dalamud.Data.DataManager.GetIcon(Dalamud.ClientLanguage,System.UInt32)">GetIcon(ClientLanguage, UInt32)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon with the given ID, of the given language.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:TexFile"></see> containing the icon with the given ID, of the given language.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TexFile GetIcon(ClientLanguage iconLanguage, uint iconId)</code></pre>
<pre><code class="lang-csharp hljs">public TexFile? GetIcon(ClientLanguage iconLanguage, uint iconId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -689,8 +688,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><p>The <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><p>The <see cref="!:TexFile"></see> containing the icon.</p>
</td>
</tr>
</tbody>
@ -704,12 +703,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_System_Boolean_System_UInt32_" data-uid="Dalamud.Data.DataManager.GetIcon(System.Boolean,System.UInt32)">GetIcon(Boolean, UInt32)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon with the given ID, of the given quality.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:TexFile"></see> containing the icon with the given ID, of the given quality.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TexFile GetIcon(bool isHq, uint iconId)</code></pre>
<pre><code class="lang-csharp hljs">public TexFile? GetIcon(bool isHq, uint iconId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -745,8 +744,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><p>The <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><p>The <see cref="!:TexFile"></see> containing the icon.</p>
</td>
</tr>
</tbody>
@ -760,12 +759,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_System_String_System_UInt32_" data-uid="Dalamud.Data.DataManager.GetIcon(System.String,System.UInt32)">GetIcon(String, UInt32)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon with the given ID, of the given type.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:TexFile"></see> containing the icon with the given ID, of the given type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TexFile GetIcon(string type, uint iconId)</code></pre>
<pre><code class="lang-csharp hljs">public TexFile? GetIcon(string type, uint iconId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -801,8 +800,8 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><p>The <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><p>The <see cref="!:TexFile"></see> containing the icon.</p>
</td>
</tr>
</tbody>
@ -816,12 +815,12 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_System_UInt32_" data-uid="Dalamud.Data.DataManager.GetIcon(System.UInt32)">GetIcon(UInt32)</h4>
<div class="markdown level1 summary"><p>Get a <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon with the given ID.</p>
<div class="markdown level1 summary"><p>Get a <see cref="!:TexFile"></see> containing the icon with the given ID.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TexFile GetIcon(uint iconId)</code></pre>
<pre><code class="lang-csharp hljs">public TexFile? GetIcon(uint iconId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -851,27 +850,27 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><p>The <span class="xref">Lumina.Data.Files.TexFile</span> containing the icon.</p>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><p>The <see cref="!:TexFile"></see> containing the icon.</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_Data_DataManager_GetImGuiTexture_Lumina_Data_Files_TexFile_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetImGuiTexture(Lumina.Data.Files.TexFile)%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>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetImGuiTexture_System_Nullable_TexFile__.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetImGuiTexture(System.Nullable%7BTexFile%7D)%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/Data/DataManager.cs/#L213">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_GetImGuiTexture_" data-uid="Dalamud.Data.DataManager.GetImGuiTexture*"></a>
<h4 id="Dalamud_Data_DataManager_GetImGuiTexture_Lumina_Data_Files_TexFile_" data-uid="Dalamud.Data.DataManager.GetImGuiTexture(Lumina.Data.Files.TexFile)">GetImGuiTexture(TexFile)</h4>
<div class="markdown level1 summary"><p>Get the passed <span class="xref">Lumina.Data.Files.TexFile</span> as a drawable ImGui TextureWrap.</p>
<h4 id="Dalamud_Data_DataManager_GetImGuiTexture_System_Nullable_TexFile__" data-uid="Dalamud.Data.DataManager.GetImGuiTexture(System.Nullable{TexFile})">GetImGuiTexture(Nullable&lt;TexFile&gt;)</h4>
<div class="markdown level1 summary"><p>Get the passed <see cref="!:TexFile"></see> as a drawable ImGui TextureWrap.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TextureWrap GetImGuiTexture(TexFile tex)</code></pre>
<pre><code class="lang-csharp hljs">public TextureWrap GetImGuiTexture(TexFile? tex)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
@ -884,9 +883,9 @@ public ReadOnlyDictionary&lt;string, ushort&gt; ClientOpCodes { get; }</code></p
</thead>
<tbody>
<tr>
<td><span class="xref">Lumina.Data.Files.TexFile</span></td>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">TexFile</span>&gt;</td>
<td><span class="parametername">tex</span></td>
<td><p>The Lumina <span class="xref">Lumina.Data.Files.TexFile</span>.</p>
<td><p>The Lumina <see cref="!:TexFile"></see>.</p>
</td>
</tr>
</tbody>