mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-13 12:14:16 +01:00
docs: regenerate, include docfx config
This commit is contained in:
goat
parent
6e486d0cea
commit
c59f53db2f
384 changed files with 248388 additions and 1052 deletions
|
|
@ -10,13 +10,13 @@
|
|||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class ClientState
|
||||
">
|
||||
<meta name="generator" content="docfx 2.43.1.0">
|
||||
<meta name="generator" content="docfx 2.48.1.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="../toc.html">
|
||||
<meta property="docfx:navrel" content="">
|
||||
<meta property="docfx:tocrel" content="toc.html">
|
||||
|
||||
|
||||
|
|
@ -117,16 +117,21 @@
|
|||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</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_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_DalamudStartInfo_Dalamud_Game_SigScanner_System_Diagnostics_ProcessModule_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.%23ctor(Dalamud.Dalamud%2CDalamud.DalamudStartInfo%2CDalamud.Game.SigScanner%2CSystem.Diagnostics.ProcessModule)%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/Game/ClientState/ClientState.cs/#L65">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState__ctor_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_Game_SigScanner_System_Diagnostics_ProcessModule_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor(Dalamud.Dalamud,Dalamud.Game.SigScanner,System.Diagnostics.ProcessModule)">ClientState(Dalamud, SigScanner, ProcessModule)</h4>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_DalamudStartInfo_Dalamud_Game_SigScanner_System_Diagnostics_ProcessModule_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor(Dalamud.Dalamud,Dalamud.DalamudStartInfo,Dalamud.Game.SigScanner,System.Diagnostics.ProcessModule)">ClientState(Dalamud, DalamudStartInfo, SigScanner, ProcessModule)</h4>
|
||||
<div class="markdown level1 summary"><p>Set up client state access.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ClientState(Dalamud dalamud, SigScanner scanner, ProcessModule targetModule)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ClientState(Dalamud dalamud, DalamudStartInfo startInfo, SigScanner scanner, ProcessModule targetModule)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -142,6 +147,12 @@
|
|||
<td><span class="xref">Dalamud.Dalamud</span></td>
|
||||
<td><span class="parametername">dalamud</span></td>
|
||||
<td><p>Dalamud instance</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">Dalamud.DalamudStartInfo</span></td>
|
||||
<td><span class="parametername">startInfo</span></td>
|
||||
<td><p>StartInfo of the current Dalamud launch</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -160,15 +171,20 @@
|
|||
</table>
|
||||
<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_Game_ClientState_ClientState_Actors.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Actors%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/Game/ClientState/ClientState.cs/#L30">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_Actors" data-uid="Dalamud.Game.ClientState.ClientState.Actors">Actors</h4>
|
||||
<div class="markdown level1 summary"><p>The table of all present actors.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ActorTable Actors</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public readonly ActorTable Actors</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field Value</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -185,10 +201,105 @@
|
|||
</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_Game_ClientState_ClientState_ClientLanguage.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.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/Game/ClientState/ClientState.cs/#L25">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_ClientLanguage" data-uid="Dalamud.Game.ClientState.ClientState.ClientLanguage">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 readonly ClientLanguage ClientLanguage</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">Dalamud.ClientLanguage</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_Game_ClientState_ClientState_JobGauges.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.JobGauges%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/Game/ClientState/ClientState.cs/#L56">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_JobGauges" data-uid="Dalamud.Game.ClientState.ClientState.JobGauges">JobGauges</h4>
|
||||
<div class="markdown level1 summary"><p>The class facilitating Job Gauge data access</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public JobGauges JobGauges</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><a class="xref" href="Dalamud.Game.ClientState.JobGauges.html">JobGauges</a></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_Game_ClientState_ClientState_LocalContentId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.LocalContentId%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/Game/ClientState/ClientState.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState_LocalContentId_" data-uid="Dalamud.Game.ClientState.ClientState.LocalContentId*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_LocalContentId" data-uid="Dalamud.Game.ClientState.ClientState.LocalContentId">LocalContentId</h4>
|
||||
<div class="markdown level1 summary"><p>The content ID of the local character.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ulong LocalContentId { 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.UInt64</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_Game_ClientState_ClientState_LocalPlayer.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.LocalPlayer%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/Game/ClientState/ClientState.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState_LocalPlayer_" data-uid="Dalamud.Game.ClientState.ClientState.LocalPlayer*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_LocalPlayer" data-uid="Dalamud.Game.ClientState.ClientState.LocalPlayer">LocalPlayer</h4>
|
||||
<div class="markdown level1 summary"><p>The local player character, if one is present.</p>
|
||||
|
|
@ -215,8 +326,13 @@
|
|||
</table>
|
||||
<h3 id="events">Events
|
||||
</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_Game_ClientState_ClientState_PropertyChanged.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.PropertyChanged%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/Game/ClientState/ClientState.cs/#L21">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_PropertyChanged" data-uid="Dalamud.Game.ClientState.ClientState.PropertyChanged">PropertyChanged</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
|
@ -250,6 +366,12 @@
|
|||
<div class="sideaffix">
|
||||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState%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/Game/ClientState/ClientState.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">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue