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/FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.html
goat 83586fd46b
docs: regenerate
2023-01-26 23:57:38 +01:00

752 lines
39 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>Struct IslandState
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct IslandState
">
<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="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState">
<h1 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState" class="text-break">Struct IslandState
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.ValueType.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.ValueType.GetHashCode()</span>
</div>
<div>
<span class="xref">System.ValueType.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="FFXIVClientStructs.FFXIV.Client.Game.MJI.html">FFXIVClientStructs.FFXIV.Client.Game.MJI</a></h6>
<h6><strong>Assembly</strong>: FFXIVClientStructs.dll</h6>
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct IslandState</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinGlamour.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CabinGlamour%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L136">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinGlamour" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CabinGlamour">CabinGlamour</h4>
<div class="markdown level1 summary"><p>The current glamour cast on the Cozy Cabin (if any). Relates to the appropriate sub-row in MJIBuilding.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte CabinGlamour</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.Byte</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinGlamour_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This field is <em>not</em> offset by one like CabinLevel; Cabin Level 3 will report here as 2.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinLevel.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CabinLevel%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L128">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinLevel" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CabinLevel">CabinLevel</h4>
<div class="markdown level1 summary"><p>The current level of the Cozy Cabin for the Island Sanctuary.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte CabinLevel</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.Byte</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CabinLevel_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This field is offset by 1 compared to the level present in MJIBuildings. Cabin Level 3 will actually have
a value of 3 in this field. This is <em>probably</em> because Cabin Level 0 is &quot;nonexistent&quot;..?</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentProgress.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentProgress%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L20">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentProgress" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentProgress">CurrentProgress</h4>
<div class="markdown level1 summary"><p>The current progress of the player, as represented by MJIProgress. Appears to be bound to the island
sanctuary &quot;tutorial&quot; more than anything.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte CurrentProgress</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentRank.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentRank%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L9">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentRank" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentRank">CurrentRank</h4>
<div class="markdown level1 summary"><p>The current Sanctuary Rank of the player's island. Controls what buildings/items/recipes are or aren't
available to the player, and represented by MJIRank.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte CurrentRank</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentXP.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentXP%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L14">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_CurrentXP" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.CurrentXP">CurrentXP</h4>
<div class="markdown level1 summary"><p>The XP earned towards the next Island Sanctuary rank. Resets to 0 upon leveling up the Sanctuary.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint CurrentXP</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.UInt32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Farm.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Farm%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L76">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Farm" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Farm">Farm</h4>
<div class="markdown level1 summary"><p>A sub-struct representing the Farm's (Cropland's) current state</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MJIFarmPasture Farm</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="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIFarmPasture.html">MJIFarmPasture</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Granaries.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Granaries%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L119">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Granaries" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Granaries">Granaries</h4>
<div class="markdown level1 summary"><p>A struct representing the current state of granaries present on the island. See the struct documentation
for more information on how to access this data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MJIGranaries Granaries</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="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIGranaries.html">MJIGranaries</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_GroundsGlamourId.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.GroundsGlamourId%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L42">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_GroundsGlamourId" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.GroundsGlamourId">GroundsGlamourId</h4>
<div class="markdown level1 summary"><p>The glamour ID applied to grounds around the Island Sanctuary.
Correlates to a subrow in MJIVillageAppearanceUI, row 2.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte GroundsGlamourId</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkHoursToCompletion.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkHoursToCompletion%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L91">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkHoursToCompletion" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkHoursToCompletion">LandmarkHoursToCompletion</h4>
<div class="markdown level1 summary"><p>The current number of hours remaining until a specific Landmark has finished construction.</p>
<p>This value may be zero when there is either no construction or if construction is finished and the landmark
needs to be &quot;finalized&quot; by the player.</p>
<p>This array is indexed by the RowID of an MJILandmarkPlace.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte *LandmarkHoursToCompletion</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkIds.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkIds%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L98">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkIds" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkIds">LandmarkIds</h4>
<div class="markdown level1 summary"><p>The RowID of the MJILandmark present at a specific MJILandmarkPlace.</p>
<p>This array is indexed by the RowID of an MJILandmarkPlace.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte *LandmarkIds</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkUnderConstruction.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkUnderConstruction%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L105">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LandmarkUnderConstruction" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LandmarkUnderConstruction">LandmarkUnderConstruction</h4>
<div class="markdown level1 summary"><p>The current construction status of a landmark at a specific MJILandmarkPlace.</p>
<p>This array is indexed by the RowID of an MJILandmarkPlace.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte *LandmarkUnderConstruction</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LockedPouchItems.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LockedPouchItems%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L71">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_LockedPouchItems" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.LockedPouchItems">LockedPouchItems</h4>
<div class="markdown level1 summary"><p>An array of booleans representing if a specific item is (un)locked. Locked/unavailable items are set to true,
while those that are unlocked are false. This array is indexed by RowID from the MJIItemPouch table.
An item appears to be unlocked upon being gathered or crafted for the first time.
<a class="xref" href="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIManager.html#FFXIVClientStructs_FFXIV_Client_Game_MJI_MJIManager_IsPouchItemLocked_System_UInt16_">IsPouchItemLocked(UInt16)</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte *LockedPouchItems</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Pasture.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Pasture%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L81">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Pasture" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Pasture">Pasture</h4>
<div class="markdown level1 summary"><p>A sub-struct representing the Pasture's current state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MJIFarmPasture Pasture</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="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIFarmPasture.html">MJIFarmPasture</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_PathsGlamourId.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.PathsGlamourId%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L36">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_PathsGlamourId" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.PathsGlamourId">PathsGlamourId</h4>
<div class="markdown level1 summary"><p>The glamour ID applied to paths around the Island Sanctuary.
Correlates to a subrow in MJIVillageAppearanceUI, row 0.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte PathsGlamourId</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_SlopesGlamourId.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.SlopesGlamourId%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L48">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_SlopesGlamourId" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.SlopesGlamourId">SlopesGlamourId</h4>
<div class="markdown level1 summary"><p>The glamour ID applied to slopes around the Island Sanctuary.
Correlates to a subrow in MJIVillageAppeareanceUI, row 1.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte SlopesGlamourId</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_UnlockedKeyItems.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.UnlockedKeyItems%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L57">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_UnlockedKeyItems" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.UnlockedKeyItems">UnlockedKeyItems</h4>
<div class="markdown level1 summary"><p>A bitfield representing all unlocked key items (MJIKeyItem) for the player. Backing field for
<a class="xref" href="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIManager.html#FFXIVClientStructs_FFXIV_Client_Game_MJI_MJIManager_IsKeyItemUnlocked_System_UInt16_">IsKeyItemUnlocked(UInt16)</a>, which should be used where possible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ushort UnlockedKeyItems</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>
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_UnlockedKeyItems_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The index of this field will be (RowID - 1), so &quot;Islekeep's Stone Hatchet&quot; appears at position 0.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_UnlockedRecipes.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.UnlockedRecipes%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L63">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_UnlockedRecipes" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.UnlockedRecipes">UnlockedRecipes</h4>
<div class="markdown level1 summary"><p>A bitfield representing if a specific recipe (MJIRecipe) is unlocked. Backing field for
<a class="xref" href="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIManager.html#FFXIVClientStructs_FFXIV_Client_Game_MJI_MJIManager_IsRecipeUnlocked_System_UInt16_">IsRecipeUnlocked(UInt16)</a>, which should be used where possible.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte *UnlockedRecipes</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.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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_VillageDevelopmentLevel.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.VillageDevelopmentLevel%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L30">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_VillageDevelopmentLevel" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.VillageDevelopmentLevel">VillageDevelopmentLevel</h4>
<div class="markdown level1 summary"><p>The current development level of the player's village on their island. Controls what building zones are
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 VillageDevelopmentLevel</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.Byte</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_VillageDevelopmentLevel_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Allowed building locations are part of the MJIBuildingPlace (+0x10) and MJILandmarkPlace (+0x10) Lumina
sheets.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Workshops.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Workshops%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L113">View Source</a>
</span>
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState_Workshops" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState.Workshops">Workshops</h4>
<div class="markdown level1 summary"><p>A struct representing the current state of workshops present on the island. See the struct documentation
for more information on how to access this data.</p>
<p>Note that this struct only provides mapping from a workshop ID to other data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MJIWorkshops Workshops</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="FFXIVClientStructs.FFXIV.Client.Game.MJI.MJIWorkshops.html">MJIWorkshops</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/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJI_IslandState.md&amp;value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJI.IslandState%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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJI/IslandState.cs/#L3" 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