mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-01-03 14:23:40 +01:00
docs: replace mbplugin link with rich presence
This commit is contained in:
goat
parent
8140ddcbfd
commit
fb42419b5d
41 changed files with 1425 additions and 459 deletions
|
|
@ -84,6 +84,7 @@
|
|||
<div classs="implements">
|
||||
<h5>Implements</h5>
|
||||
<div><span class="xref">System.ComponentModel.INotifyPropertyChanged</span></div>
|
||||
<div><span class="xref">System.IDisposable</span></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 class ClientState : INotifyPropertyChanged</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class ClientState : INotifyPropertyChanged, IDisposable</code></pre>
|
||||
</div>
|
||||
<h3 id="constructors">Constructors
|
||||
</h3>
|
||||
|
|
@ -122,7 +123,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_DalamudStartInfo_Dalamud_Game_SigScanner_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.%23ctor(Dalamud.Dalamud%2CDalamud.DalamudStartInfo%2CDalamud.Game.SigScanner)%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/#L60">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L94">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_DalamudStartInfo_Dalamud_Game_SigScanner_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor(Dalamud.Dalamud,Dalamud.DalamudStartInfo,Dalamud.Game.SigScanner)">ClientState(Dalamud, DalamudStartInfo, SigScanner)</h4>
|
||||
|
|
@ -170,7 +171,7 @@
|
|||
<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/#L23">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L27">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>
|
||||
|
|
@ -200,7 +201,7 @@
|
|||
<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/#L18">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L22">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>
|
||||
|
|
@ -229,7 +230,7 @@
|
|||
<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/#L52">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L81">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>
|
||||
|
|
@ -254,6 +255,96 @@
|
|||
</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_KeyState.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.KeyState%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/#L86">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_KeyState" data-uid="Dalamud.Game.ClientState.ClientState.KeyState">KeyState</h4>
|
||||
<div class="markdown level1 summary"><p>Provides access to the keypress state of keyboard keys in game.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public KeyState KeyState</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.KeyState.html">KeyState</a></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_TerritoryChanged.md&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/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L59">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>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EventHandler<ushort> TerritoryChanged</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.EventHandler</span><<span class="xref">System.UInt16</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_TerritoryType.md&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/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L54">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_TerritoryType" data-uid="Dalamud.Game.ClientState.ClientState.TerritoryType">TerritoryType</h4>
|
||||
<div class="markdown level1 summary"><p>The current Territory the player resides in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ushort TerritoryType</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.UInt16</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
|
|
@ -261,7 +352,7 @@
|
|||
<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/#L47">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L76">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>
|
||||
|
|
@ -292,7 +383,7 @@
|
|||
<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/#L28">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L32">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>
|
||||
|
|
@ -318,37 +409,38 @@
|
|||
</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_Game_ClientState_ClientState_TerritoryType.md&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>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Dispose.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.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/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L42">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L122">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>
|
||||
<div class="markdown level1 summary"><p>The current Territory the player resides in.</p>
|
||||
</div>
|
||||
<a id="Dalamud_Game_ClientState_ClientState_Dispose_" data-uid="Dalamud.Game.ClientState.ClientState.Dispose*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_Dispose" data-uid="Dalamud.Game.ClientState.ClientState.Dispose">Dispose()</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 uint TerritoryType { get; }</code></pre>
|
||||
<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/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Enable.md&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/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L117">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"></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>
|
||||
<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.UInt32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="events">Events
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
|
|
@ -356,7 +448,7 @@
|
|||
<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/#L14">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L18">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>
|
||||
|
|
@ -384,6 +476,9 @@
|
|||
<div>
|
||||
<span class="xref">System.ComponentModel.INotifyPropertyChanged</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.IDisposable</span>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
@ -395,7 +490,7 @@
|
|||
<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/#L13" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L17" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue