Skip to content

Commit

Permalink
build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Nov 25, 2022
1 parent d7a5870 commit a50ecdb
Show file tree
Hide file tree
Showing 26 changed files with 200 additions and 102 deletions.
2 changes: 1 addition & 1 deletion docs/typedoc/assets/search.js
View file

Large diffs are not rendered by default.

25 changes: 23 additions & 2 deletions docs/typedoc/classes/GridEngine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ <h3 class="tsd-index-heading">Methods</h3>
<a href="GridEngine.html#getPosition" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Position</span></a>
<a href="GridEngine.html#getSpeed" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Speed</span></a>
<a href="GridEngine.html#getSprite" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Sprite</span></a>
<a href="GridEngine.html#getTilePosInDirection" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Tile<wbr/>Pos<wbr/>In<wbr/>Direction</span></a>
<a href="GridEngine.html#getTransition" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Transition</span></a>
<a href="GridEngine.html#getWalkingAnimationMapping" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Walking<wbr/>Animation<wbr/>Mapping</span></a>
<a href="GridEngine.html#hasCharacter" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>has<wbr/>Character</span></a>
Expand Down Expand Up @@ -431,6 +432,25 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<li>
<h5>charId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Sprite</span></h4></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTilePosInDirection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Tile<wbr/>Pos<wbr/>In<wbr/>Direction</span><a href="#getTilePosInDirection" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature" id="getTilePosInDirection.getTilePosInDirection-1">get<wbr/>Tile<wbr/>Pos<wbr/>In<wbr/>Direction<span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><a href="../interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a>, charLayer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, direction<span class="tsd-signature-symbol">: </span><a href="../enums/Direction.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Direction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/LayerPosition.html" class="tsd-signature-type" data-tsd-kind="Interface">LayerPosition</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Gets the tile position and character layer adjacent to the given
position in the given direction.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>position: <a href="../interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a></h5></li>
<li>
<h5>charLayer: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>direction: <a href="../enums/Direction.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Direction</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/LayerPosition.html" class="tsd-signature-type" data-tsd-kind="Interface">LayerPosition</a></h4></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTransition" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Transition</span><a href="#getTransition" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand Down Expand Up @@ -824,7 +844,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="steppedOn" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>stepped<wbr/>On</span><a href="#steppedOn" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature" id="steppedOn.steppedOn-1">stepped<wbr/>On<span class="tsd-signature-symbol">(</span>charIds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, tiles<span class="tsd-signature-symbol">: </span><a href="../interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a><span class="tsd-signature-symbol">[]</span>, layer<span class="tsd-signature-symbol">?: </span><a href="../types/LayerName.html" class="tsd-signature-type" data-tsd-kind="Type alias">LayerName</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>charId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/PositionChange.html" class="tsd-signature-type" data-tsd-kind="Interface">PositionChange</a><span class="tsd-signature-symbol">&gt;</span></li></ul>
<li class="tsd-signature" id="steppedOn.steppedOn-1">stepped<wbr/>On<span class="tsd-signature-symbol">(</span>charIds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, tiles<span class="tsd-signature-symbol">: </span><a href="../interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a><span class="tsd-signature-symbol">[]</span>, layer<span class="tsd-signature-symbol">?: </span><a href="../types/CharLayer.html" class="tsd-signature-type" data-tsd-kind="Type alias">CharLayer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>charId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/PositionChange.html" class="tsd-signature-type" data-tsd-kind="Interface">PositionChange</a><span class="tsd-signature-symbol">&gt;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
Expand All @@ -839,7 +859,7 @@ <h5>charIds: <span class="tsd-signature-type">string</span><span class="tsd-sign
<li>
<h5>tiles: <a href="../interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a><span class="tsd-signature-symbol">[]</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> layer: <a href="../types/LayerName.html" class="tsd-signature-type" data-tsd-kind="Type alias">LayerName</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> layer: <a href="../types/CharLayer.html" class="tsd-signature-type" data-tsd-kind="Type alias">CharLayer</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>charId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/PositionChange.html" class="tsd-signature-type" data-tsd-kind="Interface">PositionChange</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stopMovement" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>stop<wbr/>Movement</span><a href="#stopMovement" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
Expand Down Expand Up @@ -918,6 +938,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getPosition" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getSpeed" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Speed</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getSprite" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Sprite</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getTilePosInDirection" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Tile<wbr/>Pos<wbr/>In<wbr/>Direction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getTransition" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Transition</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#getWalkingAnimationMapping" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Walking<wbr/>Animation<wbr/>Mapping</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="GridEngine.html#hasCharacter" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>has<wbr/>Character</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/typedoc/enums/CharacterShiftAction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ <h3 class="tsd-anchor-link"><span>ADDED</span><a href="#ADDED" aria-label="Perma
<div class="tsd-comment tsd-typography"><p>added new character</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/4b5949b/src/GridEngine.ts#L283">GridEngine.ts:283</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/d7a5870/src/GridEngine.ts#L292">GridEngine.ts:292</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="REMOVED" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>REMOVED</span><a href="#REMOVED" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">REMOVED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;REMOVED&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>removed existing character</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/4b5949b/src/GridEngine.ts#L281">GridEngine.ts:281</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/d7a5870/src/GridEngine.ts#L290">GridEngine.ts:290</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
4 changes: 2 additions & 2 deletions docs/typedoc/enums/CollisionStrategy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ <h3 class="tsd-anchor-link"><span>BLOCK_<wbr/>ONE_<wbr/>TILE_<wbr/>AHEAD</span><
it will only block the tile it is entering.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/4b5949b/src/Collisions/CollisionStrategy.ts#L19">Collisions/CollisionStrategy.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/d7a5870/src/Collisions/CollisionStrategy.ts#L19">Collisions/CollisionStrategy.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="BLOCK_TWO_TILES" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>BLOCK_<wbr/>TWO_<wbr/>TILES</span><a href="#BLOCK_TWO_TILES" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">BLOCK_<wbr/>TWO_<wbr/>TILES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;BLOCK_TWO_TILES&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>When character is standing, it will block only one tile. If it is moving,
it will block the tile it is leaving and the tile it is entering.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/4b5949b/src/Collisions/CollisionStrategy.ts#L13">Collisions/CollisionStrategy.ts:13</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/Annoraaq/grid-engine/blob/d7a5870/src/Collisions/CollisionStrategy.ts#L13">Collisions/CollisionStrategy.ts:13</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit a50ecdb

Please sign in to comment.