Skip to content

Commit

Permalink
update docfx gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Mushymato committed Nov 3, 2024
1 parent 234d57f commit bdadf11
Show file tree
Hide file tree
Showing 5 changed files with 102 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h4 class="section">Parameters</h4>

<h3 id="TrinketTinker_Companions_Motions_SerpentMotion_DrawShadow_Microsoft_Xna_Framework_Graphics_SpriteBatch_TrinketTinker_Companions_Anim_DrawSnapshot_" data-uid="TrinketTinker.Companions.Motions.SerpentMotion.DrawShadow(Microsoft.Xna.Framework.Graphics.SpriteBatch,TrinketTinker.Companions.Anim.DrawSnapshot)">
DrawShadow(SpriteBatch, DrawSnapshot)
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Motions/SerpentMotion.cs/#L90"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Motions/SerpentMotion.cs/#L97"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Do not draw shadow for this motion type it looks bad.</p>
Expand Down
69 changes: 68 additions & 1 deletion docs/api/TrinketTinker.Models.MotionArgs.SerpentArgs.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,77 @@ <h1 id="TrinketTinker_Models_MotionArgs_SerpentArgs" data-uid="TrinketTinker.Mod



<h2 class="section" id="fields">Fields
</h2>



<h3 id="TrinketTinker_Models_MotionArgs_SerpentArgs_HasTail" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.HasTail">
HasTail
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/MotionArgs/SerpentArgs.cs/#L11"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Whether the serpent has a tail</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasTail</code></pre>
</div>




<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>









<h2 class="section" id="properties">Properties
</h2>


<a id="TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentAlts_" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts*"></a>

<h3 id="TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentAlts" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts">
SegmentAlts
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/MotionArgs/SerpentArgs.cs/#L9"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Number of alternate segment textures.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int SegmentAlts { get; set; }</code></pre>
</div>





<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>








<a id="TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentCount_" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentCount*"></a>

<h3 id="TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentCount" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentCount">
Expand Down Expand Up @@ -214,7 +281,7 @@ <h4 class="section">Property Value</h4>

<h3 id="TrinketTinker_Models_MotionArgs_SerpentArgs_Sparcity" data-uid="TrinketTinker.Models.MotionArgs.SerpentArgs.Sparcity">
Sparcity
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/MotionArgs/SerpentArgs.cs/#L9"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Models/MotionArgs/SerpentArgs.cs/#L13"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>How spaced out each segment is</p>
Expand Down
14 changes: 13 additions & 1 deletion docs/guide/3.z.004-Serpent.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,19 @@ <h2 id="args"><a href="../api/TrinketTinker.Models.MotionArgs.HopArgs.html">Args
<td><code>SegmentCount</code></td>
<td>int</td>
<td>5</td>
<td>Number of segments to draw, excluding the head. Putting a big number here may cause performance issues.</td>
<td>Number of segments to draw, excluding the head.</td>
</tr>
<tr>
<td><code>SegmentAlts</code></td>
<td>int</td>
<td>1</td>
<td>Number of alternate segment appearanches, default 1 means only 1 kind of segment. Multiple kinds of segments will be drawn in alternating order.</td>
</tr>
<tr>
<td><code>HasTail</code></td>
<td>bool</td>
<td>true</td>
<td>Whether this serpent is capped off by a unique segment that comes immediately after the last (alt) segment.</td>
</tr>
<tr>
<td><code>Sparcity</code></td>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"guide/3.z.004-Serpent.html": {
"href": "guide/3.z.004-Serpent.html",
"title": "Serpent | TrinketTinker",
"keywords": "Serpent Draws additional body segments that follow the base sprite, which is treated as the head. Requires 2 additional sets of sprites for the body segments and tail. The number per set required is the determined by direction and frame length, just like the base sprite number. A minimal serpent would require just 3 sprites (head, segment, tail), using direction mode Single with frame length of 1. Serpent frame To have the head rotate as well, set DirectionRotate to true. Args Property Type Default Notes SegmentCount int 5 Number of segments to draw, excluding the head. Putting a big number here may cause performance issues. Sparcity float 3.5 Factor determining how spaced out each segment is. The default value of 3.5 gives a little bit of overlap between segments. *and all arguments of Lerp"
"keywords": "Serpent Draws additional body segments that follow the base sprite, which is treated as the head. Requires 2 additional sets of sprites for the body segments and tail. The number per set required is the determined by direction and frame length, just like the base sprite number. A minimal serpent would require just 3 sprites (head, segment, tail), using direction mode Single with frame length of 1. Serpent frame To have the head rotate as well, set DirectionRotate to true. Args Property Type Default Notes SegmentCount int 5 Number of segments to draw, excluding the head. SegmentAlts int 1 Number of alternate segment appearanches, default 1 means only 1 kind of segment. Multiple kinds of segments will be drawn in alternating order. HasTail bool true Whether this serpent is capped off by a unique segment that comes immediately after the last (alt) segment. Sparcity float 3.5 Factor determining how spaced out each segment is. The default value of 3.5 gives a little bit of overlap between segments. *and all arguments of Lerp"
},
"guide/3.z.100-Static.html": {
"href": "guide/3.z.100-Static.html",
Expand Down
19 changes: 19 additions & 0 deletions docs/xrefmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5046,6 +5046,25 @@ references:
commentId: T:TrinketTinker.Models.MotionArgs.SerpentArgs
fullName: TrinketTinker.Models.MotionArgs.SerpentArgs
nameWithType: SerpentArgs
- uid: TrinketTinker.Models.MotionArgs.SerpentArgs.HasTail
name: HasTail
href: api/TrinketTinker.Models.MotionArgs.SerpentArgs.html#TrinketTinker_Models_MotionArgs_SerpentArgs_HasTail
commentId: F:TrinketTinker.Models.MotionArgs.SerpentArgs.HasTail
fullName: TrinketTinker.Models.MotionArgs.SerpentArgs.HasTail
nameWithType: SerpentArgs.HasTail
- uid: TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts
name: SegmentAlts
href: api/TrinketTinker.Models.MotionArgs.SerpentArgs.html#TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentAlts
commentId: P:TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts
fullName: TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts
nameWithType: SerpentArgs.SegmentAlts
- uid: TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts*
name: SegmentAlts
href: api/TrinketTinker.Models.MotionArgs.SerpentArgs.html#TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentAlts_
commentId: Overload:TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts
isSpec: "True"
fullName: TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentAlts
nameWithType: SerpentArgs.SegmentAlts
- uid: TrinketTinker.Models.MotionArgs.SerpentArgs.SegmentCount
name: SegmentCount
href: api/TrinketTinker.Models.MotionArgs.SerpentArgs.html#TrinketTinker_Models_MotionArgs_SerpentArgs_SegmentCount
Expand Down

0 comments on commit bdadf11

Please sign in to comment.