docs: regenerate

This commit is contained in:
goat 2022-10-29 15:34:04 +02:00
parent 02f90899a3
commit 6fd636c26c
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
1239 changed files with 214126 additions and 66229 deletions

View file

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ClientState
">
<meta name="generator" content="docfx 2.59.1.0">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@ -81,9 +81,10 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ClientState</span></div>
</div>
<div classs="implements">
<div class="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
<div><a class="xref" href="Dalamud.IServiceType.html">IServiceType</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
@ -113,7 +114,7 @@
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_ClientState_ClientState_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class ClientState : IDisposable</code></pre>
<pre><code class="lang-csharp hljs">public sealed class ClientState : IDisposable, IServiceType</code></pre>
</div>
<h3 id="properties">Properties
</h3>
@ -122,7 +123,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_ClientLanguage.md&amp;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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L106">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L93">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_ClientLanguage_" data-uid="Dalamud.Game.ClientState.ClientState.ClientLanguage*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_ClientLanguage" data-uid="Dalamud.Game.ClientState.ClientState.ClientLanguage">ClientLanguage</h4>
@ -153,7 +154,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_IsLoggedIn.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.IsLoggedIn%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/ClientState/ClientState.cs/#L126">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L113">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_IsLoggedIn_" data-uid="Dalamud.Game.ClientState.ClientState.IsLoggedIn*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_IsLoggedIn" data-uid="Dalamud.Game.ClientState.ClientState.IsLoggedIn">IsLoggedIn</h4>
@ -179,12 +180,74 @@
</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_ClientState_ClientState_IsPvP.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.IsPvP%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/ClientState/ClientState.cs/#L118">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_IsPvP_" data-uid="Dalamud.Game.ClientState.ClientState.IsPvP*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_IsPvP" data-uid="Dalamud.Game.ClientState.ClientState.IsPvP">IsPvP</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether or not the user is playing PvP.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPvP { 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_ClientState_ClientState_IsPvPExcludingDen.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.IsPvPExcludingDen%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/ClientState/ClientState.cs/#L123">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_IsPvPExcludingDen_" data-uid="Dalamud.Game.ClientState.ClientState.IsPvPExcludingDen*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_IsPvPExcludingDen" data-uid="Dalamud.Game.ClientState.ClientState.IsPvPExcludingDen">IsPvPExcludingDen</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether or not the user is playing PvP, excluding the Wolves' Den.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPvPExcludingDen { 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_ClientState_ClientState_LocalContentId.md&amp;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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L121">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L108">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>
@ -215,7 +278,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_LocalPlayer.md&amp;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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L116">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L103">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>
@ -246,7 +309,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_TerritoryType.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.TerritoryType%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/ClientState/ClientState.cs/#L111">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L98">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_TerritoryType_" data-uid="Dalamud.Game.ClientState.ClientState.TerritoryType*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_TerritoryType" data-uid="Dalamud.Game.ClientState.ClientState.TerritoryType">TerritoryType</h4>
@ -272,24 +335,6 @@
</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_ClientState_ClientState_Enable.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.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/ClientState/ClientState.cs/#L131">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_Enable_" data-uid="Dalamud.Game.ClientState.ClientState.Enable*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_Enable" data-uid="Dalamud.Game.ClientState.ClientState.Enable">Enable()</h4>
<div class="markdown level1 summary"><p>Enable 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>
<h3 id="events">Events
</h3>
<span class="small pull-right mobile-hide">
@ -297,7 +342,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_CfPop.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.CfPop%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/ClientState/ClientState.cs/#L101">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L88">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_CfPop" data-uid="Dalamud.Game.ClientState.ClientState.CfPop">CfPop</h4>
<div class="markdown level1 summary"><p>Event that gets fired when a duty is ready.</p>
@ -305,7 +350,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;Lumina.Excel.GeneratedSheets.ContentFinderCondition&gt; CfPop</code></pre>
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ContentFinderCondition&gt; CfPop</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
@ -322,12 +367,72 @@
</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_ClientState_ClientState_EnterPvP.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.EnterPvP%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/ClientState/ClientState.cs/#L78">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_EnterPvP" data-uid="Dalamud.Game.ClientState.ClientState.EnterPvP">EnterPvP</h4>
<div class="markdown level1 summary"><p>Event that fires when a character is entering PvP.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action EnterPvP</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.Action</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_ClientState_ClientState_LeavePvP.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.LeavePvP%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/ClientState/ClientState.cs/#L83">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_LeavePvP" data-uid="Dalamud.Game.ClientState.ClientState.LeavePvP">LeavePvP</h4>
<div class="markdown level1 summary"><p>Event that fires when a character is leaving PvP.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action LeavePvP</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.Action</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_ClientState_ClientState_Login.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Login%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/ClientState/ClientState.cs/#L91">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L68">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_Login" data-uid="Dalamud.Game.ClientState.ClientState.Login">Login</h4>
<div class="markdown level1 summary"><p>Event that fires when a character is logging in.</p>
@ -357,7 +462,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Logout.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Logout%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/ClientState/ClientState.cs/#L96">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L73">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_Logout" data-uid="Dalamud.Game.ClientState.ClientState.Logout">Logout</h4>
<div class="markdown level1 summary"><p>Event that fires when a character is logging out.</p>
@ -387,7 +492,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_TerritoryChanged.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.TerritoryChanged%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/ClientState/ClientState.cs/#L86">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L63">View Source</a>
</span>
<h4 id="Dalamud_Game_ClientState_ClientState_TerritoryChanged" data-uid="Dalamud.Game.ClientState.ClientState.TerritoryChanged">TerritoryChanged</h4>
<div class="markdown level1 summary"><p>Event that gets fired when the current Territory changes.</p>
@ -419,7 +524,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_System_IDisposable_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.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/ClientState/ClientState.cs/#L141">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L133">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_ClientState_System_IDisposable_Dispose_" data-uid="Dalamud.Game.ClientState.ClientState.System#IDisposable#Dispose*"></a>
<h4 id="Dalamud_Game_ClientState_ClientState_System_IDisposable_Dispose" data-uid="Dalamud.Game.ClientState.ClientState.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
@ -434,6 +539,9 @@
<div>
<span class="xref">System.IDisposable</span>
</div>
<div>
<a class="xref" href="Dalamud.IServiceType.html">IServiceType</a>
</div>
</article>
</div>
@ -445,7 +553,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState.md&amp;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/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L27" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L21" class="contribution-link">View Source</a>
</li>
</ul>
</div>