Regenerated scripting docs

mapeditor · Jun 28, 2023 · cf7d476 · cf7d476
1 parent b4bb0c0
commit cf7d476
Show file tree

Hide file tree

Showing 10 changed files with 1,111 additions and 11 deletions.
diff --git a/docs/scripting/assets/js/search.js b/docs/scripting/assets/js/search.js
diff --git a/docs/scripting/classes/Project.html b/docs/scripting/classes/Project.html
diff --git a/docs/scripting/classes/TileLayer.html b/docs/scripting/classes/TileLayer.html
@@ -169,6 +169,7 @@ <h3>Methods</h3>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TileLayer.html#setProperties" class="tsd-kind-icon">set<wbr>Properties</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TileLayer.html#setProperty" class="tsd-kind-icon">set<wbr>Property</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="TileLayer.html#tileAt" class="tsd-kind-icon">tile<wbr>At</a></li>
+								<li class="tsd-kind-method tsd-parent-kind-class"><a href="TileLayer.html#wangEdit" class="tsd-kind-icon">wang<wbr>Edit</a></li>
 							</ul>
 						</section>
 					</div>
@@ -867,6 +868,30 @@ <h3>tile<wbr>At</h3>
 						</li>
 					</ul>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+					<a name="wangEdit" class="tsd-anchor"></a>
+					<h3>wang<wbr>Edit</h3>
+					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+						<li class="tsd-signature tsd-kind-icon">wang<wbr>Edit<span class="tsd-signature-symbol">(</span>wangSet<span class="tsd-signature-symbol">: </span><a href="WangSet.html" class="tsd-signature-type" data-tsd-kind="Class">WangSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TileLayerWangEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TileLayerWangEdit</a></li>
+					</ul>
+					<ul class="tsd-descriptions">
+						<li class="tsd-description">
+							<aside class="tsd-sources">
+							</aside>
+							<div class="tsd-comment tsd-typography">
+								<div class="lead">
+									<p>Returns an object that enables making modifications to the tile layer
+									using the given <a href="WangSet.html">WangSet</a>.</p>
+								</div>
+								<dl class="tsd-comment-tags">
+									<dt>since</dt>
+									<dd><p>1.10.2</p>
+									</dd>
+								</dl>
+							</div>
+						</li>
+					</ul>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -1007,6 +1032,9 @@ <h3>tile<wbr>At</h3>
 							<li class=" tsd-kind-method tsd-parent-kind-class">
 								<a href="TileLayer.html#tileAt" class="tsd-kind-icon">tile<wbr>At</a>
 							</li>
+							<li class=" tsd-kind-method tsd-parent-kind-class">
+								<a href="TileLayer.html#wangEdit" class="tsd-kind-icon">wang<wbr>Edit</a>
+							</li>
 						</ul>
 					</li>
 				</ul>

diff --git a/docs/scripting/classes/TiledObject.html b/docs/scripting/classes/TiledObject.html
@@ -100,6 +100,9 @@ <h3>Hierarchy</h3>
 					<li>
 						<span class="target">TiledObject</span>
 						<ul class="tsd-hierarchy">
+							<li>
+								<a href="Project.html" class="tsd-signature-type" data-tsd-kind="Class">Project</a>
+							</li>
 							<li>
 								<a href="MapObject.html" class="tsd-signature-type" data-tsd-kind="Class">MapObject</a>
 							</li>

diff --git a/docs/scripting/classes/WangSet.html b/docs/scripting/classes/WangSet.html
@@ -598,7 +598,7 @@ <h3>set<wbr>Wang<wbr>Id</h3>
 								<div class="lead">
 									<p>Sets the Wang ID associated with the given tile.</p>
 								</div>
-								<p>The Wang ID is given by an array of 8 numbers, indicating the colors associated with each index in the following order: [Top, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft].
+								<p>The Wang ID is given by an array of 8 numbers, indicating the colors associated with each index in the following order: [Top, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft] (see <a href="../enums/WangIndex.html">WangIndex</a>).
 								A value of 0 indicates that no color is associated with a given index.</p>
 								<p>Make sure the Wang set color count is set before calling this function, because it will raise an error when the Wang ID refers to non-existing colors.</p>
 							</div>
@@ -619,7 +619,7 @@ <h3>wang<wbr>Id</h3>
 								<div class="lead">
 									<p>Returns the current Wang ID associated with the given tile.</p>
 								</div>
-								<p>The Wang ID is given by an array of 8 numbers, indicating the colors associated with each index in the following order: [Top, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft].
+								<p>The Wang ID is given by an array of 8 numbers, indicating the colors associated with each index in the following order: [Top, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft] (see <a href="../enums/WangIndex.html">WangIndex</a>).
 								A value of 0 indicates that no color is associated with a given index.</p>
 							</div>
 						</li>

diff --git a/docs/scripting/enums/WangIndex.html b/docs/scripting/enums/WangIndex.html
diff --git a/docs/scripting/index.html b/docs/scripting/index.html
@@ -112,6 +112,12 @@ <h3>Namespaces</h3>
 								<li class="tsd-kind-namespace"><a href="modules/tiled.html" class="tsd-kind-icon">tiled</a></li>
 							</ul>
 						</section>
+						<section class="tsd-index-section ">
+							<h3>Enumerations</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-enum"><a href="enums/WangIndex.html" class="tsd-kind-icon">Wang<wbr>Index</a></li>
+							</ul>
+						</section>
 						<section class="tsd-index-section ">
 							<h3>Classes</h3>
 							<ul class="tsd-index-list">
@@ -158,6 +164,7 @@ <h3>Interfaces</h3>
 								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Signal.html" class="tsd-kind-icon">Signal</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/TileCollisionEditor.html" class="tsd-kind-icon">Tile<wbr>Collision<wbr>Editor</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/TileLayerEdit.html" class="tsd-kind-icon">Tile<wbr>Layer<wbr>Edit</a></li>
+								<li class="tsd-kind-interface"><a href="interfaces/TileLayerWangEdit.html" class="tsd-kind-icon">Tile<wbr>Layer<wbr>Wang<wbr>Edit</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/TiledObjectProperties.html" class="tsd-kind-icon">Tiled<wbr>Object<wbr>Properties</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/TilesetEditor.html" class="tsd-kind-icon">Tileset<wbr>Editor</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/TilesetFormat.html" class="tsd-kind-icon">Tileset<wbr>Format</a></li>
@@ -269,6 +276,9 @@ <h3>Tiled<wbr>Object<wbr>Property<wbr>Value</h3>
 			</nav>
 			<nav class="tsd-navigation secondary menu-sticky">
 				<ul class="before-current">
+					<li class=" tsd-kind-enum">
+						<a href="enums/WangIndex.html" class="tsd-kind-icon">Wang<wbr>Index</a>
+					</li>
 					<li class=" tsd-kind-class">
 						<a href="classes/Asset.html" class="tsd-kind-icon">Asset</a>
 					</li>
@@ -383,6 +393,9 @@ <h3>Tiled<wbr>Object<wbr>Property<wbr>Value</h3>
 					<li class=" tsd-kind-interface">
 						<a href="interfaces/TileLayerEdit.html" class="tsd-kind-icon">Tile<wbr>Layer<wbr>Edit</a>
 					</li>
+					<li class=" tsd-kind-interface">
+						<a href="interfaces/TileLayerWangEdit.html" class="tsd-kind-icon">Tile<wbr>Layer<wbr>Wang<wbr>Edit</a>
+					</li>
 					<li class=" tsd-kind-interface">
 						<a href="interfaces/TiledObjectProperties.html" class="tsd-kind-icon">Tiled<wbr>Object<wbr>Properties</a>
 					</li>

diff --git a/docs/scripting/interfaces/MapEditor.html b/docs/scripting/interfaces/MapEditor.html
@@ -159,6 +159,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> current<wbr>Wang<wbr>
 								The value 0 is used to represent the eraser mode, and the first Wang color
 							has index 1.</p>
 						</div>
+						<p>See also <a href="TileLayerWangEdit.html">TileLayerWangEdit</a>.</p>
 						<dl class="tsd-comment-tags">
 							<dt>since</dt>
 							<dd><p>1.8</p>
@@ -193,6 +194,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> current<wbr>Wang<wbr>
 						<div class="lead">
 							<p>Gets the currently selected <a href="../classes/WangSet.html">WangSet</a> in the &quot;Terrain Sets&quot; view.</p>
 						</div>
+						<p>See also <a href="TileLayerWangEdit.html">TileLayerWangEdit</a>.</p>
 						<dl class="tsd-comment-tags">
 							<dt>since</dt>
 							<dd><p>1.8</p>

diff --git a/docs/scripting/interfaces/TileLayerEdit.html b/docs/scripting/interfaces/TileLayerEdit.html
@@ -135,7 +135,8 @@ <h3>mergeable</h3>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>Whether applied edits are mergeable with previous edits. Starts out as false and is automatically set to true by <a href="TileLayerEdit.html#apply">apply</a>.</p>
+							<p>Whether applied edits are mergeable with previous edits. Starts out as
+							<code>false</code> and is automatically set to <code>true</code> by <a href="TileLayerEdit.html#apply">apply</a>.</p>
 						</div>
 					</div>
 				</section>