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.Data.DataManager.html
goat 0c8e15a39f docs: regenerate
2021-04-07 20:41:53 +02:00

823 lines
35 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 DataManager
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DataManager
">
<meta name="generator" content="docfx 2.56.6.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.Data.DataManager">
<h1 id="Dalamud_Data_DataManager" data-uid="Dalamud.Data.DataManager" class="text-break">Class DataManager
</h1>
<div class="markdown level0 summary"><p>This class provides data for Dalamud-internal features, but can also be used by plugins if needed.</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">DataManager</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.ToString()</span>
</div>
<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.ReferenceEquals(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>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Data.html">Dalamud.Data</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Data_DataManager_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DataManager : IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L40">View Source</a>
</span>
<a id="Dalamud_Data_DataManager__ctor_" data-uid="Dalamud.Data.DataManager.#ctor*"></a>
<h4 id="Dalamud_Data_DataManager__ctor_Dalamud_ClientLanguage_" data-uid="Dalamud.Data.DataManager.#ctor(Dalamud.ClientLanguage)">DataManager(ClientLanguage)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Data.DataManager.html">DataManager</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DataManager(ClientLanguage language)</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.ClientLanguage.html">ClientLanguage</a></td>
<td><span class="parametername">language</span></td>
<td><p>The language to load data with by default.</p>
</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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_ClientOpCodes.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.ClientOpCodes%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/#L56">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_ClientOpCodes_" data-uid="Dalamud.Data.DataManager.ClientOpCodes*"></a>
<h4 id="Dalamud_Data_DataManager_ClientOpCodes" data-uid="Dalamud.Data.DataManager.ClientOpCodes">ClientOpCodes</h4>
<div class="markdown level1 summary"><p>Gets the OpCodes sent by the client to the server.</p>
</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; ClientOpCodes { 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>
<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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L61">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>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>
<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">ExcelModule</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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L66">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"><p>Gets a value indicating whether Game Data is ready to be read.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsDataReady { 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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L51">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"><p>Gets the OpCodes sent by the server to the client.</p>
</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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.Dispose%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/#L263">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_Dispose_" data-uid="Dalamud.Data.DataManager.Dispose*"></a>
<h4 id="Dalamud_Data_DataManager_Dispose" data-uid="Dalamud.Data.DataManager.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Dispose this DataManager.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</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_Data_DataManager_FileExists_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.FileExists(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/Data/DataManager.cs/#L201">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_FileExists_" data-uid="Dalamud.Data.DataManager.FileExists*"></a>
<h4 id="Dalamud_Data_DataManager_FileExists_System_String_" data-uid="Dalamud.Data.DataManager.FileExists(System.String)">FileExists(String)</h4>
<div class="markdown level1 summary"><p>Check if the file with the given path exists within the game's index files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool FileExists(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">System.Boolean</span></td>
<td><p>True if the file exists.</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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L148">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 <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;()
where T : ExcelRow</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">ExcelSheet</span>&lt;T&gt;</td>
<td><p>The <see cref="!:ExcelSheet&lt;T>"></see>, 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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetExcelSheet__1_Dalamud_ClientLanguage_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetExcelSheet%60%601(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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L159">View Source</a>
</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 <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)
where T : ExcelRow</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.ClientLanguage.html">ClientLanguage</a></td>
<td><span class="parametername">language</span></td>
<td><p>Language of the sheet to get.</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">ExcelSheet</span>&lt;T&gt;</td>
<td><p>The <see cref="!:ExcelSheet&lt;T>"></see>, 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/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L176">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 <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>
</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">FileResource</span></td>
<td><p>The <see cref="!:FileResource"></see> of the file.</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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L187">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 <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>
<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 <see cref="!:FileResource"></see> 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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Data_DataManager_GetIcon_Dalamud_ClientLanguage_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetIcon(Dalamud.ClientLanguage%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/Data/DataManager.cs/#L222">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_Dalamud_ClientLanguage_System_Int32_" data-uid="Dalamud.Data.DataManager.GetIcon(Dalamud.ClientLanguage,System.Int32)">GetIcon(ClientLanguage, Int32)</h4>
<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, int iconId)</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.ClientLanguage.html">ClientLanguage</a></td>
<td><span class="parametername">iconLanguage</span></td>
<td><p>The requested language.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">iconId</span></td>
<td><p>The icon ID.</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">TexFile</span></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_GetIcon_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetIcon(System.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/Data/DataManager.cs/#L211">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_System_Int32_" data-uid="Dalamud.Data.DataManager.GetIcon(System.Int32)">GetIcon(Int32)</h4>
<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(int iconId)</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.Int32</span></td>
<td><span class="parametername">iconId</span></td>
<td><p>The icon ID.</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">TexFile</span></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_GetIcon_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.GetIcon(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/Data/DataManager.cs/#L241">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_GetIcon_" data-uid="Dalamud.Data.DataManager.GetIcon*"></a>
<h4 id="Dalamud_Data_DataManager_GetIcon_System_String_System_Int32_" data-uid="Dalamud.Data.DataManager.GetIcon(System.String,System.Int32)">GetIcon(String, Int32)</h4>
<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, int iconId)</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">type</span></td>
<td><p>The type of the icon (e.g. 'hq' to get the HQ variant of an item icon).</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">iconId</span></td>
<td><p>The icon ID.</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">TexFile</span></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_Initialize_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Data.DataManager.Initialize(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/Data/DataManager.cs/#L72">View Source</a>
</span>
<a id="Dalamud_Data_DataManager_Initialize_" data-uid="Dalamud.Data.DataManager.Initialize*"></a>
<h4 id="Dalamud_Data_DataManager_Initialize_System_String_" data-uid="Dalamud.Data.DataManager.Initialize(System.String)">Initialize(String)</h4>
<div class="markdown level1 summary"><p>Initialize this data manager.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Initialize(string baseDir)</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">baseDir</span></td>
<td><p>The directory to load data from.</p>
</td>
</tr>
</tbody>
</table>
<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_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/goatcorp/Dalamud/blob/master/Dalamud/Data/DataManager.cs/#L20" 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