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.Game.ClientState.JobGauge.Types.SAMGauge.html
goat 6fd636c26c
docs: regenerate
2022-10-29 15:34:04 +02:00

383 lines
18 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 SAMGauge
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SAMGauge
">
<meta name="generator" content="docfx 2.59.4.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.Game.ClientState.JobGauge.Types.SAMGauge">
<h1 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge" class="text-break">Class SAMGauge
</h1>
<div class="markdown level0 summary"><p>In-memory SAM job gauge.</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"><a class="xref" href="Dalamud.Game.ClientState.JobGauge.Types.JobGaugeBase.html">JobGaugeBase</a></div>
<div class="level2"><a class="xref" href="Dalamud.Game.ClientState.JobGauge.Types.JobGaugeBase-1.html">JobGaugeBase</a>&lt;<a class="xref" href="FFXIVClientStructs.FFXIV.Client.Game.Gauge.SamuraiGauge.html">SamuraiGauge</a>&gt;</div>
<div class="level3"><span class="xref">SAMGauge</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Dalamud.Game.ClientState.JobGauge.Types.JobGaugeBase.html#Dalamud_Game_ClientState_JobGauge_Types_JobGaugeBase_Address">JobGaugeBase.Address</a>
</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.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.JobGauge.Types.html">Dalamud.Game.ClientState.JobGauge.Types</a></h6>
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
<h5 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SAMGauge : JobGaugeBase&lt;SamuraiGauge&gt;</code></pre>
</div>
<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_Game_ClientState_JobGauge_Types_SAMGauge_HasGetsu.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasGetsu%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/JobGauge/Types/SAMGauge.cs/#L51">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasGetsu_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasGetsu*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasGetsu" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasGetsu">HasGetsu</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the Getsu Sen is active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasGetsu { 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><p><code>true</code> or <code>false</code>.</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_Game_ClientState_JobGauge_Types_SAMGauge_HasKa.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasKa%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/JobGauge/Types/SAMGauge.cs/#L57">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasKa_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasKa*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasKa" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasKa">HasKa</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the Ka Sen is active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasKa { 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><p><code>true</code> or <code>false</code>.</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_Game_ClientState_JobGauge_Types_SAMGauge_HasSetsu.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasSetsu%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/JobGauge/Types/SAMGauge.cs/#L45">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasSetsu_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasSetsu*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_HasSetsu" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.HasSetsu">HasSetsu</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether the Setsu Sen is active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasSetsu { 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><p><code>true</code> or <code>false</code>.</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_Game_ClientState_JobGauge_Types_SAMGauge_Kaeshi.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kaeshi%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/JobGauge/Types/SAMGauge.cs/#L24">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Kaeshi_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kaeshi*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Kaeshi" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kaeshi">Kaeshi</h4>
<div class="markdown level1 summary"><p>Gets the currently active Kaeshi ability.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Kaeshi Kaeshi { 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><a class="xref" href="Dalamud.Game.ClientState.JobGauge.Enums.Kaeshi.html">Kaeshi</a></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_JobGauge_Types_SAMGauge_Kenki.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kenki%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/JobGauge/Types/SAMGauge.cs/#L29">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Kenki_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kenki*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Kenki" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Kenki">Kenki</h4>
<div class="markdown level1 summary"><p>Gets the current amount of Kenki available.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte Kenki { 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.Byte</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_JobGauge_Types_SAMGauge_MeditationStacks.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.MeditationStacks%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/JobGauge/Types/SAMGauge.cs/#L34">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_MeditationStacks_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.MeditationStacks*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_MeditationStacks" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.MeditationStacks">MeditationStacks</h4>
<div class="markdown level1 summary"><p>Gets the amount of Meditation stacks.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte MeditationStacks { 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.Byte</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_JobGauge_Types_SAMGauge_Sen.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Sen%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/JobGauge/Types/SAMGauge.cs/#L39">View Source</a>
</span>
<a id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Sen_" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Sen*"></a>
<h4 id="Dalamud_Game_ClientState_JobGauge_Types_SAMGauge_Sen" data-uid="Dalamud.Game.ClientState.JobGauge.Types.SAMGauge.Sen">Sen</h4>
<div class="markdown level1 summary"><p>Gets the active Sen.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Sen Sen { 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><a class="xref" href="Dalamud.Game.ClientState.JobGauge.Enums.Sen.html">Sen</a></td>
<td></td>
</tr>
</tbody>
</table>
</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_Game_ClientState_JobGauge_Types_SAMGauge.md&amp;value=---%0Auid%3A%20Dalamud.Game.ClientState.JobGauge.Types.SAMGauge%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/JobGauge/Types/SAMGauge.cs/#L10" 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