mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
394 lines
19 KiB
HTML
394 lines
19 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>Struct MJIWorkshops
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Struct MJIWorkshops
|
|
">
|
|
<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.MJIWorkshops">
|
|
|
|
|
|
<h1 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops" class="text-break">Struct MJIWorkshops
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>A struct representing a list of workshops present in the Island Sanctuary.</p>
|
|
<p>The struct provides a helper method to retrieve information about a single workshop (referenced by ID), but will
|
|
otherwise allow querying a specific field by ID directly.</p>
|
|
</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.html">FFXIVClientStructs.FFXIV.Client.Game</a></h6>
|
|
<h6><strong>Assembly</strong>: FFXIVClientStructs.dll</h6>
|
|
<h5 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public struct MJIWorkshops</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_MJIWorkshops_BuildingLevel.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.BuildingLevel%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/MJIManager.cs/#L369">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_BuildingLevel" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.BuildingLevel">BuildingLevel</h4>
|
|
<div class="markdown level1 summary"><p>The true level of a particular building. Like GlamourLevel, also refers to a specific sub-row of 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 *BuildingLevel</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_MJIWorkshops_BuildingLevel_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This level is one less than the building's level; Workshop III will report 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_MJIWorkshops_GlamourLevel.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.GlamourLevel%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/MJIManager.cs/#L354">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_GlamourLevel" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.GlamourLevel">GlamourLevel</h4>
|
|
<div class="markdown level1 summary"><p>The glamour level of a particular building. This value refers to a specific sub-row of 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 *GlamourLevel</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_MJIWorkshops_GlamourLevel_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This level is one less than the building's level; Workshop III will report 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_MJIWorkshops_HoursToCompletion.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.HoursToCompletion%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/MJIManager.cs/#L361">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_HoursToCompletion" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.HoursToCompletion">HoursToCompletion</h4>
|
|
<div class="markdown level1 summary"><p>Hours remaining in the construction/upgrade of a building.</p>
|
|
<p>If the building is done or is not under construction, this value will be zero.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte *HoursToCompletion</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_MJIWorkshops_PlaceId.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.PlaceId%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/MJIManager.cs/#L346">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_PlaceId" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.PlaceId">PlaceId</h4>
|
|
<div class="markdown level1 summary"><p>The MJIBuildingPlace in which this particular building resides.</p>
|
|
<p>If this building is not built, this value will be zero.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte *PlaceId</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_MJIWorkshops_UnderConstruction.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.UnderConstruction%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/MJIManager.cs/#L379">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_UnderConstruction" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.UnderConstruction">UnderConstruction</h4>
|
|
<div class="markdown level1 summary"><p>Report if a specific building is currently under construction.</p>
|
|
<p>May report 1 while HoursToCompletion is 0 if the building needs to be "finalized" through user interaction.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public byte *UnderConstruction</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_MJIWorkshops_UnderConstruction_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>So far the only observed value for this field is 0 or 1, but more values may exist (?).</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_MJIWorkshops_vtbl.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.vtbl%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/MJIManager.cs/#L339">View Source</a>
|
|
</span>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_vtbl" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.vtbl">vtbl</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 *vtbl</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.Void</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/goatcorp/FFXIVClientStructs/new/main/apiSpec/new?filename=FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_Item_System_Int32_.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.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/FFXIVClientStructs/blob/main/FFXIVClientStructs/FFXIV/Client/Game/MJIManager.cs/#L385">View Source</a>
|
|
</span>
|
|
<a id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_Item_" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.Item*"></a>
|
|
<h4 id="FFXIVClientStructs_FFXIV_Client_Game_MJIWorkshops_Item_System_Int32_" data-uid="FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops.Item(System.Int32)">Item[Int32]</h4>
|
|
<div class="markdown level1 summary"><p>Helper method to return all known information about a specific building at once.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public readonly (byte PlaceId, byte GlamourLevel, byte HoursToCompletion, byte BuildingLevel, bool UnderConstruction) this[int idx] { 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">idx</span></td>
|
|
<td><p>The index of the building to retrieve</p>
|
|
</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.ValueTuple</span><<span class="xref">System.Byte</span>, <span class="xref">System.Byte</span>, <span class="xref">System.Byte</span>, <span class="xref">System.Byte</span>, <span class="xref">System.Boolean</span>></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_MJIWorkshops.md&value=---%0Auid%3A%20FFXIVClientStructs.FFXIV.Client.Game.MJIWorkshops%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/MJIManager.cs/#L335" 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>
|