Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@PrashantMohta
PrashantMohta committed Aug 21, 2024
1 parent 470d24f commit 23195b6
Show file tree
Hide file tree
Showing 171 changed files with 3,690 additions and 325 deletions.
12 changes: 6 additions & 6 deletions docs/api_reference/CustomKnight.Cinematic.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/ck3.0/apiSpec/new?filename=CustomKnight_Cinematic.md&amp;value=---%0Auid%3A%20CustomKnight.Cinematic%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/master/apiSpec/new?filename=CustomKnight_Cinematic.md&amp;value=---%0Auid%3A%20CustomKnight.Cinematic%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -77,7 +77,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<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>

Expand All @@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="CustomKnight_Cinematic" data-uid="CustomKnight.Cinematic" class="text-break">
Class Cinematic <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Cinematics/Cinematic.cs/#L9"><i class="bi bi-code-slash"></i></a>
Class Cinematic <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Cinematics/Cinematic.cs/#L9"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2 class="section" id="constructors">Constructors

<h3 id="CustomKnight_Cinematic__ctor_System_String_" data-uid="CustomKnight.Cinematic.#ctor(System.String)">
Cinematic(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Cinematics/Cinematic.cs/#L21"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Cinematics/Cinematic.cs/#L21"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Ctor</p>
Expand Down Expand Up @@ -193,7 +193,7 @@ <h2 class="section" id="properties">Properties

<h3 id="CustomKnight_Cinematic_ClipName" data-uid="CustomKnight.Cinematic.ClipName">
ClipName
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Cinematics/Cinematic.cs/#L14"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Cinematics/Cinematic.cs/#L14"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Name of the current Cinematic</p>
Expand Down Expand Up @@ -225,7 +225,7 @@ <h4 class="section">Property Value</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Cinematics/Cinematic.cs/#L9" class="edit-link">Edit this page</a>
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Cinematics/Cinematic.cs/#L9" class="edit-link">Edit this page</a>
</div>


Expand Down
50 changes: 25 additions & 25 deletions docs/api_reference/CustomKnight.CustomKnight.html
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/api_reference/CustomKnight.CustomKnightTexture.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/ck3.0/apiSpec/new?filename=CustomKnight_CustomKnightTexture.md&amp;value=---%0Auid%3A%20CustomKnight.CustomKnightTexture%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/master/apiSpec/new?filename=CustomKnight_CustomKnightTexture.md&amp;value=---%0Auid%3A%20CustomKnight.CustomKnightTexture%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -77,7 +77,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<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>

Expand All @@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="CustomKnight_CustomKnightTexture" data-uid="CustomKnight.CustomKnightTexture" class="text-break">
Class CustomKnightTexture <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L7"><i class="bi bi-code-slash"></i></a>
Class CustomKnightTexture <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L7"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -157,7 +157,7 @@ <h2 class="section" id="constructors">Constructors

<h3 id="CustomKnight_CustomKnightTexture__ctor_System_String_System_Boolean_UnityEngine_Texture2D_UnityEngine_Texture2D_" data-uid="CustomKnight.CustomKnightTexture.#ctor(System.String,System.Boolean,UnityEngine.Texture2D,UnityEngine.Texture2D)">
CustomKnightTexture(string, bool, Texture2D, Texture2D)
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L58"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L58"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>ctor</p>
Expand Down Expand Up @@ -198,7 +198,7 @@ <h2 class="section" id="fields">Fields

<h3 id="CustomKnight_CustomKnightTexture_defaultSprite" data-uid="CustomKnight.CustomKnightTexture.defaultSprite">
defaultSprite
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L20"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L20"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>defaultSprite of the texture pulled from game</p>
Expand Down Expand Up @@ -229,7 +229,7 @@ <h4 class="section">Field Value</h4>

<h3 id="CustomKnight_CustomKnightTexture_defaultTex" data-uid="CustomKnight.CustomKnightTexture.defaultTex">
defaultTex
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L24"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L24"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>default texture of the CKT pulled from the game</p>
Expand Down Expand Up @@ -260,7 +260,7 @@ <h4 class="section">Field Value</h4>

<h3 id="CustomKnight_CustomKnightTexture_fileName" data-uid="CustomKnight.CustomKnightTexture.fileName">
fileName
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L16"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L16"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>filename of the texture</p>
Expand Down Expand Up @@ -291,7 +291,7 @@ <h4 class="section">Field Value</h4>

<h3 id="CustomKnight_CustomKnightTexture_missing" data-uid="CustomKnight.CustomKnightTexture.missing">
missing
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L12"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>is the texture missing</p>
Expand Down Expand Up @@ -322,7 +322,7 @@ <h4 class="section">Field Value</h4>

<h3 id="CustomKnight_CustomKnightTexture_tex" data-uid="CustomKnight.CustomKnightTexture.tex">
tex
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L28"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L28"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>the loaded texture</p>
Expand Down Expand Up @@ -358,7 +358,7 @@ <h2 class="section" id="properties">Properties

<h3 id="CustomKnight_CustomKnightTexture_IsSprite" data-uid="CustomKnight.CustomKnightTexture.IsSprite">
IsSprite
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L32"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L32"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>is a sprite or a texture</p>
Expand Down Expand Up @@ -390,7 +390,7 @@ <h4 class="section">Property Value</h4>

<h3 id="CustomKnight_CustomKnightTexture_currentTexture" data-uid="CustomKnight.CustomKnightTexture.currentTexture">
currentTexture
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L36"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L36"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets the tex or defaultTex depending on availablilty</p>
Expand Down Expand Up @@ -422,7 +422,7 @@ <h4 class="section">Property Value</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L7" class="edit-link">Edit this page</a>
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Base/CustomKnightTexture.cs/#L7" class="edit-link">Edit this page</a>
</div>


Expand Down
12 changes: 6 additions & 6 deletions docs/api_reference/CustomKnight.DumpEvent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<meta name="docfx:rel" content="../">


<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/ck3.0/apiSpec/new?filename=CustomKnight_DumpEvent.md&amp;value=---%0Auid%3A%20CustomKnight.DumpEvent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/PrashantMohta/HollowKnight.CustomKnight/new/master/apiSpec/new?filename=CustomKnight_DumpEvent.md&amp;value=---%0Auid%3A%20CustomKnight.DumpEvent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -77,7 +77,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<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>

Expand All @@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="CustomKnight_DumpEvent" data-uid="CustomKnight.DumpEvent" class="text-break">
Class DumpEvent <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Swapper/DumpManager.cs/#L13"><i class="bi bi-code-slash"></i></a>
Class DumpEvent <a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Swapper/DumpManager.cs/#L13"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h2 class="section" id="properties">Properties

<h3 id="CustomKnight_DumpEvent_go" data-uid="CustomKnight.DumpEvent.go">
go
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Swapper/DumpManager.cs/#L22"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Swapper/DumpManager.cs/#L22"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>The dump GameObject</p>
Expand Down Expand Up @@ -193,7 +193,7 @@ <h4 class="section">Property Value</h4>

<h3 id="CustomKnight_DumpEvent_scene" data-uid="CustomKnight.DumpEvent.scene">
scene
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Swapper/DumpManager.cs/#L18"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Swapper/DumpManager.cs/#L18"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Scene of the dump object</p>
Expand Down Expand Up @@ -225,7 +225,7 @@ <h4 class="section">Property Value</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/ck3.0/CustomKnight/Skin/Swapper/DumpManager.cs/#L13" class="edit-link">Edit this page</a>
<a href="https://github.com/PrashantMohta/HollowKnight.CustomKnight/blob/master/CustomKnight/Skin/Swapper/DumpManager.cs/#L13" class="edit-link">Edit this page</a>
</div>


Expand Down
Loading

0 comments on commit 23195b6

Please sign in to comment.