docs: gamedata changes

This commit is contained in:
goat 2020-02-16 20:08:21 +09:00
parent e1b29a2797
commit 9194239317
8 changed files with 4089 additions and 434 deletions

View file

@ -115,91 +115,80 @@
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager__ctor.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.%23ctor%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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager__ctor_Dalamud_ClientLanguage_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.%23ctor(Dalamud.ClientLanguage)%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L24">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L44">View Source</a>
</span>
<a id="Dalamud_Data_DataManager__ctor_" data-uid="Dalamud.Data.DataManager.#ctor*"></a>
<h4 id="Dalamud_Data_DataManager__ctor" data-uid="Dalamud.Data.DataManager.#ctor">DataManager()</h4>
<h4 id="Dalamud_Data_DataManager__ctor_Dalamud_ClientLanguage_" data-uid="Dalamud.Data.DataManager.#ctor(Dalamud.ClientLanguage)">DataManager(ClientLanguage)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DataManager()</code></pre>
<pre><code class="lang-csharp hljs">public DataManager(ClientLanguage language)</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_ContentFinderCondition.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.ContentFinderCondition%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L20">View Source</a>
</span>
<h4 id="Dalamud_Data_DataManager_ContentFinderCondition" data-uid="Dalamud.Data.DataManager.ContentFinderCondition">ContentFinderCondition</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReadOnlyDictionary&lt;uint, JObject&gt; ContentFinderCondition</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<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.Collections.ObjectModel.ReadOnlyDictionary</span>&lt;<span class="xref">System.UInt32</span>, <span class="xref">Newtonsoft.Json.Linq.JObject</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_ServerOpCodes.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.ServerOpCodes%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L19">View Source</a>
</span>
<h4 id="Dalamud_Data_DataManager_ServerOpCodes" data-uid="Dalamud.Data.DataManager.ServerOpCodes">ServerOpCodes</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReadOnlyDictionary&lt;string, ushort&gt; ServerOpCodes</code></pre>
</div>
<h5 class="fieldValue">Field 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.Collections.ObjectModel.ReadOnlyDictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.UInt16</span>&gt;</td>
<td><span class="xref">Dalamud.ClientLanguage</span></td>
<td><span class="parametername">language</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_Excel.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.Excel%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L30">View Source</a>
</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>An <span class="xref">Lumina.Excel.ExcelModule</span> 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>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ExcelModule Excel { 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">Lumina.Excel.ExcelModule</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_IsDataReady.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.IsDataReady%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L22">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L35">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_IsDataReady_" data-uid="Dalamud.Data.DataManager.IsDataReady*"></a>
<h4 id="Dalamud_Data_DataManager_IsDataReady" data-uid="Dalamud.Data.DataManager.IsDataReady">IsDataReady</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Indicates whether Game Data is ready to be read.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -220,14 +209,210 @@
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_ServerOpCodes.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.ServerOpCodes%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L25">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_ServerOpCodes_" data-uid="Dalamud.Data.DataManager.ServerOpCodes*"></a>
<h4 id="Dalamud_Data_DataManager_ServerOpCodes" data-uid="Dalamud.Data.DataManager.ServerOpCodes">ServerOpCodes</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReadOnlyDictionary&lt;string, ushort&gt; ServerOpCodes { 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.Collections.ObjectModel.ReadOnlyDictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.UInt16</span>&gt;</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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetExcelSheet__1.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetExcelSheet%60%601%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L113">View Source</a>
</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>
<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;()
where T : IExcelRow</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">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>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The excel sheet type to get.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetFile_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetFile(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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L123">View Source</a>
</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>
<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>
</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">path</span></td>
<td><p>The path inside of the game files.</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">Lumina.Data.FileResource</span></td>
<td><p>The <span class="xref">Lumina.Data.FileResource</span> of the file.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetFile__1_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetFile%60%601(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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L134">View Source</a>
</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>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T GetFile&lt;T&gt;(string path)
where T : FileResource</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">path</span></td>
<td><p>The path inside of the game files.</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">T</span></td>
<td><p>The <span class="xref">Lumina.Data.FileResource</span> of the file.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The type of resource</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_Initialize.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.Initialize%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L30">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L52">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_Initialize_" data-uid="Dalamud.Data.DataManager.Initialize*"></a>
<h4 id="Dalamud_Data_DataManager_Initialize" data-uid="Dalamud.Data.DataManager.Initialize">Initialize()</h4>
@ -263,7 +448,7 @@
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager%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/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L16" class="contribution-link">View Source</a>
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L22" class="contribution-link">View Source</a>
</li>
</ul>
</div>