Update docs to 3.0.x

kionell · Jun 18, 2023 · 7feeb44 · 7feeb44
1 parent b0e06ec
commit 7feeb44
Show file tree

Hide file tree

Showing 172 changed files with 1,756 additions and 1,451 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,7 +1,7 @@
 :root {
     --light-hl-0: #000000;
     --dark-hl-0: #D4D4D4;
-    --light-code-background: #FFFFFF;
+    --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
 

diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -152,6 +152,15 @@ body.dark {
     --external-icon: var(--dark-external-icon);
 }
 
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+    line-height: 1.2;
+}
+
 h1 {
     font-size: 2em;
     margin: 0.67em 0;
@@ -641,6 +650,10 @@ footer {
     border-top: 1px solid var(--color-panel-divider);
     background-color: var(--color-panel);
 }
+footer:after {
+    content: "";
+    display: table;
+}
 footer.with-border-bottom {
     border-bottom: 1px solid var(--color-panel-divider);
 }
@@ -753,12 +766,13 @@ footer .tsd-legend {
 
 .tsd-flag {
     display: inline-block;
-    padding: 1px 5px;
+    padding: 0.25em 0.4em;
     border-radius: 4px;
     color: var(--color-comment-tag-text);
     background-color: var(--color-comment-tag);
     text-indent: 0;
-    font-size: 14px;
+    font-size: 75%;
+    line-height: 1;
     font-weight: normal;
 }
 
@@ -1382,3 +1396,19 @@ input[type="checkbox"]:checked + .tsd-widget:before {
 img {
     max-width: 100%;
 }
+
+.tsd-anchor-icon {
+    margin-left: 10px;
+    vertical-align: middle;
+    color: var(--color-text);
+}
+
+.tsd-anchor-icon svg {
+    width: 1em;
+    height: 1em;
+    visibility: hidden;
+}
+
+.tsd-anchor-link:hover > .tsd-anchor-icon svg {
+    visibility: visible;
+}
diff --git a/docs/classes/Autoplay.html b/docs/classes/Autoplay.html
diff --git a/docs/classes/Beatmap.html b/docs/classes/Beatmap.html
diff --git a/docs/classes/BeatmapBreakEvent.html b/docs/classes/BeatmapBreakEvent.html
diff --git a/docs/classes/BeatmapColorSection.html b/docs/classes/BeatmapColorSection.html
diff --git a/docs/classes/BeatmapConverter.html b/docs/classes/BeatmapConverter.html
diff --git a/docs/classes/BeatmapDifficultySection.html b/docs/classes/BeatmapDifficultySection.html
diff --git a/docs/classes/BeatmapEditorSection.html b/docs/classes/BeatmapEditorSection.html
diff --git a/docs/classes/BeatmapEventSection.html b/docs/classes/BeatmapEventSection.html
diff --git a/docs/classes/BeatmapGeneralSection.html b/docs/classes/BeatmapGeneralSection.html
diff --git a/docs/classes/BeatmapInfo.html b/docs/classes/BeatmapInfo.html
diff --git a/docs/classes/BeatmapMetadataSection.html b/docs/classes/BeatmapMetadataSection.html
diff --git a/docs/classes/BeatmapProcessor.html b/docs/classes/BeatmapProcessor.html
diff --git a/docs/classes/BlendingParameters.html b/docs/classes/BlendingParameters.html
diff --git a/docs/classes/Cinema.html b/docs/classes/Cinema.html
diff --git a/docs/classes/CircularArcProperties.html b/docs/classes/CircularArcProperties.html
diff --git a/docs/classes/Color4.html b/docs/classes/Color4.html
diff --git a/docs/classes/Command.html b/docs/classes/Command.html
diff --git a/docs/classes/CommandLoop.html b/docs/classes/CommandLoop.html
diff --git a/docs/classes/CommandTimeline.html b/docs/classes/CommandTimeline.html
diff --git a/docs/classes/CommandTimelineGroup.html b/docs/classes/CommandTimelineGroup.html
diff --git a/docs/classes/CommandTrigger.html b/docs/classes/CommandTrigger.html
diff --git a/docs/classes/ControlPoint.html b/docs/classes/ControlPoint.html
diff --git a/docs/classes/ControlPointGroup.html b/docs/classes/ControlPointGroup.html
diff --git a/docs/classes/ControlPointInfo.html b/docs/classes/ControlPointInfo.html
diff --git a/docs/classes/DifficultyAttributes.html b/docs/classes/DifficultyAttributes.html
diff --git a/docs/classes/DifficultyCalculator.html b/docs/classes/DifficultyCalculator.html
diff --git a/docs/classes/DifficultyHitObject.html b/docs/classes/DifficultyHitObject.html
diff --git a/docs/classes/DifficultyPoint.html b/docs/classes/DifficultyPoint.html
diff --git a/docs/classes/DifficultyRange.html b/docs/classes/DifficultyRange.html
diff --git a/docs/classes/DoubleTime.html b/docs/classes/DoubleTime.html
diff --git a/docs/classes/Easy.html b/docs/classes/Easy.html
diff --git a/docs/classes/EffectPoint.html b/docs/classes/EffectPoint.html
diff --git a/docs/classes/EventGenerator.html b/docs/classes/EventGenerator.html
diff --git a/docs/classes/FastRandom.html b/docs/classes/FastRandom.html
diff --git a/docs/classes/Flashlight.html b/docs/classes/Flashlight.html
diff --git a/docs/classes/Grades.html b/docs/classes/Grades.html
diff --git a/docs/classes/HalfTime.html b/docs/classes/HalfTime.html
diff --git a/docs/classes/HardRock.html b/docs/classes/HardRock.html
diff --git a/docs/classes/Hidden.html b/docs/classes/Hidden.html
diff --git a/docs/classes/HighestRank.html b/docs/classes/HighestRank.html
diff --git a/docs/classes/HitObject.html b/docs/classes/HitObject.html
diff --git a/docs/classes/HitSample.html b/docs/classes/HitSample.html
diff --git a/docs/classes/HitStatistics.html b/docs/classes/HitStatistics.html
diff --git a/docs/classes/HitWindows.html b/docs/classes/HitWindows.html
diff --git a/docs/classes/LegacyReplayFrame.html b/docs/classes/LegacyReplayFrame.html
diff --git a/docs/classes/LegacyScoreExtensions.html b/docs/classes/LegacyScoreExtensions.html
diff --git a/docs/classes/LevelInfo.html b/docs/classes/LevelInfo.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LevelInfo | osu-classes</title><meta name="description" content="Documentation for osu-classes"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">osu-classes</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">osu-classes</a></li><li><a href="LevelInfo.html">LevelInfo</a></li></ul><h1>Class LevelInfo </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A level information of a user.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LevelInfo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="LevelInfo.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="LevelInfo.html#current" class="tsd-kind-icon">current</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="LevelInfo.html#progress" class="tsd-kind-icon">progress</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="LevelInfo.html#clone" class="tsd-kind-icon">clone</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LevelInfo.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Level<wbr/>Info<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/b0e06ec/src/Users/LevelInfo.ts#L15">src/Users/LevelInfo.ts:15</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="current" class="tsd-anchor"></a><h3 class="tsd-anchor-link">current<a href="#current" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">current<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/b0e06ec/src/Users/LevelInfo.ts#L8">src/Users/LevelInfo.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Current level of a user as integer.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="progress" class="tsd-anchor"></a><h3 class="tsd-anchor-link">progress<a href="#progress" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/b0e06ec/src/Users/LevelInfo.ts#L13">src/Users/LevelInfo.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Progress to the next level as integer in range of 0-100.</p>
+</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link">clone<a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/b0e06ec/src/Users/LevelInfo.ts#L24">src/Users/LevelInfo.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Creates a deep copy of the level info.</p>
+</div></div><h4 class="tsd-returns-title">Returns <a href="LevelInfo.html" class="tsd-signature-type" data-tsd-kind="Class">LevelInfo</a></h4><div><p>Cloned level info.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link">to<wbr/>String<a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/b0e06ec/src/Users/LevelInfo.ts#L31">src/Users/LevelInfo.ts:31</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Stringified level information.</p>
+</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/Accuracy.html">Accuracy</a></li><li class=" tsd-kind-namespace"><a href="../modules/BinarySearch.html">Binary<wbr/>Search</a></li><li class=" tsd-kind-namespace"><a href="../modules/Easing.html">Easing</a></li><li class=" tsd-kind-namespace"><a href="../modules/Interpolation.html">Interpolation</a></li><li class=" tsd-kind-namespace"><a href="../modules/MathUtils.html">Math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/Rank.html">Rank</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="LevelInfo.html" class="tsd-kind-icon">Level<wbr/>Info</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="LevelInfo.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="LevelInfo.html#current" class="tsd-kind-icon">current</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="LevelInfo.html#progress" class="tsd-kind-icon">progress</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LevelInfo.html#clone" class="tsd-kind-icon">clone</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LevelInfo.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>