mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
docs: regenerate
This commit is contained in:
parent
dd72261893
commit
c050e83210
997 changed files with 51585 additions and 22166 deletions
|
|
@ -10,7 +10,7 @@
|
|||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Condition
|
||||
">
|
||||
<meta name="generator" content="docfx 2.58.0.0">
|
||||
<meta name="generator" content="docfx 2.58.4.0">
|
||||
|
||||
<link rel="shortcut icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
||||
|
|
@ -81,6 +81,10 @@
|
|||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Condition</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>
|
||||
|
|
@ -109,16 +113,16 @@
|
|||
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
||||
<h5 id="Dalamud_Game_ClientState_Conditions_Condition_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Condition</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public sealed class Condition : IDisposable</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_Game_ClientState_Conditions_Condition_MaxConditionEntries.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.MaxConditionEntries%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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Conditions_Condition_MaxConditionEntries.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.MaxConditionEntries%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/Conditions/Condition.cs/#L18">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Conditions/Condition.cs/#L19">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_MaxConditionEntries" data-uid="Dalamud.Game.ClientState.Conditions.Condition.MaxConditionEntries">MaxConditionEntries</h4>
|
||||
<div class="markdown level1 summary"><p>The current max number of conditions. You can get this just by looking at the condition sheet and how many rows it has.</p>
|
||||
|
|
@ -147,10 +151,41 @@
|
|||
</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_Conditions_Condition_Item_Dalamud_Game_ClientState_Conditions_ConditionFlag_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Item(Dalamud.Game.ClientState.Conditions.ConditionFlag)%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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Conditions_Condition_Address.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Address%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/Conditions/Condition.cs/#L39">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Conditions/Condition.cs/#L48">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Address_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Address*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Address" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Address">Address</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the condition array base pointer.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IntPtr Address { 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.IntPtr</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_Conditions_Condition_Item_Dalamud_Game_ClientState_Conditions_ConditionFlag_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Item(Dalamud.Game.ClientState.Conditions.ConditionFlag)%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/Conditions/Condition.cs/#L66">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Item_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Item*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Item_Dalamud_Game_ClientState_Conditions_ConditionFlag_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Item(Dalamud.Game.ClientState.Conditions.ConditionFlag)">Item[ConditionFlag]</h4>
|
||||
|
|
@ -174,6 +209,54 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Game.ClientState.Conditions.ConditionFlag.html">ConditionFlag</a></td>
|
||||
<td><span class="parametername">flag</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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_Conditions_Condition_Item_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Item(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/Game/ClientState/Conditions/Condition.cs/#L54">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Item_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Item*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Item_System_Int32_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Item(System.Int32)">Item[Int32]</h4>
|
||||
<div class="markdown level1 summary"><p>Check the value of a specific condition/state flag.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool this[int flag] { get; }</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">flag</span></td>
|
||||
<td><p>The condition flag to check.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -198,10 +281,10 @@
|
|||
</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_Conditions_Condition_Any.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Any%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/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Conditions_Condition_Any.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Any%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/Conditions/Condition.cs/#L56">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Conditions/Condition.cs/#L73">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Any_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Any*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Any" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Any">Any()</h4>
|
||||
|
|
@ -228,6 +311,91 @@
|
|||
</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_Conditions_Condition_Dispose.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.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/Game/ClientState/Conditions/Condition.cs/#L139">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Dispose_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Dispose*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Dispose" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Dispose">Dispose()</h4>
|
||||
<div class="markdown level1 summary"><p>Disposes this instance, alongside its hooks.</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_Game_ClientState_Conditions_Condition_Enable.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.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/Conditions/Condition.cs/#L89">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Enable_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Enable*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Enable" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Enable">Enable()</h4>
|
||||
<div class="markdown level1 summary"><p>Enables the hooks of the Condition class function.</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>
|
||||
<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_Conditions_Condition_Finalize.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.Finalize%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/Conditions/Condition.cs/#L131">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Conditions_Condition_Finalize_" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Finalize*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_Finalize" data-uid="Dalamud.Game.ClientState.Conditions.Condition.Finalize">Finalize()</h4>
|
||||
<div class="markdown level1 summary"><p>Finalizes an instance of the <a class="xref" href="Dalamud.Game.ClientState.Conditions.Condition.html">Condition</a> class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
|
||||
</div>
|
||||
<h3 id="events">Events
|
||||
</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_Conditions_Condition_ConditionChange.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition.ConditionChange%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/Conditions/Condition.cs/#L43">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Conditions_Condition_ConditionChange" data-uid="Dalamud.Game.ClientState.Conditions.Condition.ConditionChange">ConditionChange</h4>
|
||||
<div class="markdown level1 summary"><p>Event that gets fired when a condition is set.
|
||||
Should only get fired for actual changes, so the previous value will always be !value.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Condition.ConditionChangeDelegate ConditionChange</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><a class="xref" href="Dalamud.Game.ClientState.Conditions.Condition.ConditionChangeDelegate.html">Condition.ConditionChangeDelegate</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="implements">Implements</h3>
|
||||
<div>
|
||||
<span class="xref">System.IDisposable</span>
|
||||
</div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
@ -236,10 +404,10 @@
|
|||
<div class="contribution">
|
||||
<ul class="nav">
|
||||
<li>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Conditions_Condition.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition%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>
|
||||
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Conditions_Condition.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Conditions.Condition%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/Conditions/Condition.cs/#L11" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Game/ClientState/Conditions/Condition.cs/#L124" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue