-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
44 changed files
with
2,262 additions
and
1,089 deletions.
There are no files selected for viewing
305 changes: 305 additions & 0 deletions
305
docs/api/TrinketTinker.Companions.Anim.TinkerAnimSprite.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,305 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Class TinkerAnimSprite | TrinketTinker </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Class TinkerAnimSprite | TrinketTinker "> | ||
|
|
||
| <meta name="description" content="Simplified animated sprite controller. Not a net object and must be built independently in each game instance. Always loops."> | ||
| <link rel="icon" href="../images/favicon.png"> | ||
| <link rel="stylesheet" href="../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../public/main.css"> | ||
| <meta name="docfx:navrel" content="../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
| <meta name="searchOption" content="noindex"> | ||
| <meta name="docfx:rel" content="../"> | ||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/Mushymato/TrinketTinker/new/main/apiSpec/new?filename=TrinketTinker_Companions_Anim_TinkerAnimSprite.md&value=---%0Auid%3A%20TrinketTinker.Companions.Anim.TinkerAnimSprite%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"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
|
|
||
| <script type="module" src="./../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| </head> | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../images/favicon.png" alt="TrinketTinker"> | ||
| TrinketTinker | ||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| <form class="search" role="search" id="search"> | ||
| <i class="bi bi-search"></i> | ||
| <input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="TrinketTinker_Companions_Anim_TinkerAnimSprite" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite" class="text-break"> | ||
| Class TinkerAnimSprite <a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Anim/TinkerAnimSprite.cs/#L14"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="TrinketTinker.html">TrinketTinker</a>.<a class="xref" href="TrinketTinker.Companions.html">Companions</a>.<a class="xref" href="TrinketTinker.Companions.Anim.html">Anim</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>TrinketTinker.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"><p>Simplified animated sprite controller. | ||
| Not a net object and must be built independently in each game instance. | ||
| Always loops.</p> | ||
| </div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public sealed class TinkerAnimSprite</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritance"> | ||
| <dt>Inheritance</dt> | ||
| <dd> | ||
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> | ||
| <div><span class="xref">TinkerAnimSprite</span></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritedMembers"> | ||
| <dt>Inherited Members</dt> | ||
| <dd> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> | ||
| </div> | ||
| </dd></dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="constructors">Constructors | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="TrinketTinker_Companions_Anim_TinkerAnimSprite__ctor_" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.#ctor*"></a> | ||
|
|
||
| <h3 id="TrinketTinker_Companions_Anim_TinkerAnimSprite__ctor_TrinketTinker_Models_VariantData_" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.#ctor(TrinketTinker.Models.VariantData)"> | ||
| TinkerAnimSprite(VariantData) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Anim/TinkerAnimSprite.cs/#L51"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"></div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public TinkerAnimSprite(VariantData vdata)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>vdata</code> <a class="xref" href="TrinketTinker.Models.VariantData.html">VariantData</a></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="TrinketTinker_Companions_Anim_TinkerAnimSprite_AnimatePingPong_" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.AnimatePingPong*"></a> | ||
|
|
||
| <h3 id="TrinketTinker_Companions_Anim_TinkerAnimSprite_AnimatePingPong_Microsoft_Xna_Framework_GameTime_System_Int32_System_Int32_System_Single_System_Boolean__" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.AnimatePingPong(Microsoft.Xna.Framework.GameTime,System.Int32,System.Int32,System.Single,System.Boolean@)"> | ||
| AnimatePingPong(GameTime, int, int, float, ref bool) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Anim/TinkerAnimSprite.cs/#L112"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Reverse the animation from last frame, e.g. 1 2 3 4 3 2 1 2 3 4. | ||
| Ignores <span class="xref">StardewValley.AnimatedSprite.loop</span>.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public void AnimatePingPong(GameTime gameTime, int startFrame, int numberOfFrames, float interval, ref bool isReverse)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>gameTime</code> <span class="xref">GameTime</span></dt> | ||
| <dd><p>game time object from update</p> | ||
| </dd> | ||
| <dt><code>startFrame</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>initial frame</p> | ||
| </dd> | ||
| <dt><code>numberOfFrames</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>length of animation</p> | ||
| </dd> | ||
| <dt><code>interval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt> | ||
| <dd><p>milisecond interval between frames</p> | ||
| </dd> | ||
| <dt><code>isReverse</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> | ||
| <dd><p>flag for whether animation is going forward or backwards, will be updated in this method.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="TrinketTinker_Companions_Anim_TinkerAnimSprite_GetSourceRect_" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.GetSourceRect*"></a> | ||
|
|
||
| <h3 id="TrinketTinker_Companions_Anim_TinkerAnimSprite_GetSourceRect_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="TrinketTinker.Companions.Anim.TinkerAnimSprite.GetSourceRect(System.Int32,System.Int32,System.Int32,System.Int32)"> | ||
| GetSourceRect(int, int, int, int) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/Mushymato/TrinketTinker/blob/main/TrinketTinker/Companions/Anim/TinkerAnimSprite.cs/#L46"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Calculate the source rectangle for a sprite in an NPC spritesheet.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static Rectangle GetSourceRect(int textureWidth, int spriteWidth, int spriteHeight, int frame)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>textureWidth</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>The pixel width of the full spritesheet texture.</p> | ||
| </dd> | ||
| <dt><code>spriteWidth</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>The pixel width of each sprite.</p> | ||
| </dd> | ||
| <dt><code>spriteHeight</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>The pixel height of each sprite.</p> | ||
| </dd> | ||
| <dt><code>frame</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd><p>The frame index, starting at 0 for the top-left corner.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><span class="xref">Rectangle</span></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
| <div class="container-xxl search-results" id="search-results"></div> | ||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| <a href="https://github.com/Mushymato/TrinketTinker">Source Code</a> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.