mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
554 lines
26 KiB
HTML
554 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class ClientState
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ClientState
|
|
">
|
|
<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="">
|
|
<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.ClientState">
|
|
|
|
|
|
<h1 id="Dalamud_Game_ClientState_ClientState" data-uid="Dalamud.Game.ClientState.ClientState" class="text-break">Class ClientState
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class represents the state of the game client at the time of access.</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"><span class="xref">ClientState</span></div>
|
|
</div>
|
|
<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>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</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.ReferenceEquals(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>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.html">Dalamud.Game.ClientState</a></h6>
|
|
<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, IDisposable</code></pre>
|
|
</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_.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/#L101">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>
|
|
<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, DalamudStartInfo startInfo, SigScanner scanner)</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">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>
|
|
<td><a class="xref" href="Dalamud.Game.SigScanner.html">SigScanner</a></td>
|
|
<td><span class="parametername">scanner</span></td>
|
|
<td><p>Sig scanner</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</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/#L28">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 readonly ActorTable Actors</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.Actors.ActorTable.html">ActorTable</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_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/#L23">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/#L83">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>
|
|
<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/#L93">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_PartyList.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.PartyList%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/#L88">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Game_ClientState_ClientState_PartyList" data-uid="Dalamud.Game.ClientState.ClientState.PartyList">PartyList</h4>
|
|
<div class="markdown level1 summary"><p>The class facilitating party list 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 PartyList PartyList</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.PartyList.html">PartyList</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/#L61">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/#L56">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">
|
|
<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/#L78">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/#L33">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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[CanBeNull]
|
|
public PlayerCharacter LocalPlayer { 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.Actors.Types.PlayerCharacter.html">PlayerCharacter</a></td>
|
|
<td></td>
|
|
</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_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/#L131">View Source</a>
|
|
</span>
|
|
<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 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/#L126">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>
|
|
<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/#L19">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>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event PropertyChangedEventHandler PropertyChanged</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.ComponentModel.PropertyChangedEventHandler</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.ComponentModel.INotifyPropertyChanged</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.IDisposable</span>
|
|
</div>
|
|
</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/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/#L18" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</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>
|