Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kionell
kionell committed Dec 13, 2021
1 parent 40ca0b8 commit d1fe60c
Show file tree
Hide file tree
Showing 133 changed files with 959 additions and 955 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/classes/Autoplay.html
View file

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/classes/Beatmap.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/BeatmapBreakEvent.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/classes/BeatmapColoursSection.html
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BeatmapColoursSection | 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(&quot;tsd-theme&quot;) || &quot;os&quot;)</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><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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="BeatmapColoursSection.html">BeatmapColoursSection</a></li></ul><h1>Class BeatmapColoursSection</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 beatmap colours section.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BeatmapColoursSection</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="BeatmapColoursSection.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="BeatmapColoursSection.html#comboColours" class="tsd-kind-icon">combo<wbr/>Colours</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BeatmapColoursSection.html#sliderBorderColor" class="tsd-kind-icon">slider<wbr/>Border<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BeatmapColoursSection.html#sliderTrackColor" class="tsd-kind-icon">slider<wbr/>Track<wbr/>Color</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="BeatmapColoursSection.html#clone" class="tsd-kind-icon">clone</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>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Beatmap<wbr/>Colours<wbr/>Section<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"></aside><h4 class="tsd-returns-title">Returns <a href="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</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="comboColours" class="tsd-anchor"></a><h3>combo<wbr/>Colours</h3><div class="tsd-signature tsd-kind-icon">combo<wbr/>Colours<span class="tsd-signature-symbol">:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/cb4a7e4/src/Beatmaps/Sections/BeatmapColoursSection.ts#L10">Beatmaps/Sections/BeatmapColoursSection.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BeatmapColoursSection</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="BeatmapColoursSection.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="BeatmapColoursSection.html#comboColours" class="tsd-kind-icon">combo<wbr/>Colours</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BeatmapColoursSection.html#sliderBorderColor" class="tsd-kind-icon">slider<wbr/>Border<wbr/>Color</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="BeatmapColoursSection.html#sliderTrackColor" class="tsd-kind-icon">slider<wbr/>Track<wbr/>Color</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="BeatmapColoursSection.html#clone" class="tsd-kind-icon">clone</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>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Beatmap<wbr/>Colours<wbr/>Section<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"></aside><h4 class="tsd-returns-title">Returns <a href="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</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="comboColours" class="tsd-anchor"></a><h3>combo<wbr/>Colours</h3><div class="tsd-signature tsd-kind-icon">combo<wbr/>Colours<span class="tsd-signature-symbol">:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/40ca0b8/src/Beatmaps/Sections/BeatmapColoursSection.ts#L10">Beatmaps/Sections/BeatmapColoursSection.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Additive combo colours.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sliderBorderColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slider<wbr/>Border<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">slider<wbr/>Border<wbr/>Color<span class="tsd-signature-symbol">?:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/cb4a7e4/src/Beatmaps/Sections/BeatmapColoursSection.ts#L20">Beatmaps/Sections/BeatmapColoursSection.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sliderBorderColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slider<wbr/>Border<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">slider<wbr/>Border<wbr/>Color<span class="tsd-signature-symbol">?:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/40ca0b8/src/Beatmaps/Sections/BeatmapColoursSection.ts#L20">Beatmaps/Sections/BeatmapColoursSection.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Slider border colour.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sliderTrackColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slider<wbr/>Track<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">slider<wbr/>Track<wbr/>Color<span class="tsd-signature-symbol">?:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/cb4a7e4/src/Beatmaps/Sections/BeatmapColoursSection.ts#L15">Beatmaps/Sections/BeatmapColoursSection.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sliderTrackColor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> slider<wbr/>Track<wbr/>Color</h3><div class="tsd-signature tsd-kind-icon">slider<wbr/>Track<wbr/>Color<span class="tsd-signature-symbol">?:</span> <a href="Colour.html" class="tsd-signature-type" data-tsd-kind="Class">Colour</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kionell/osu-classes/blob/40ca0b8/src/Beatmaps/Sections/BeatmapColoursSection.ts#L15">Beatmaps/Sections/BeatmapColoursSection.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Additive slider track colour.</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>clone</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="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</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/cb4a7e4/src/Beatmaps/Sections/BeatmapColoursSection.ts#L27">Beatmaps/Sections/BeatmapColoursSection.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</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>clone</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="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</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/40ca0b8/src/Beatmaps/Sections/BeatmapColoursSection.ts#L27">Beatmaps/Sections/BeatmapColoursSection.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a copy of this beatmap colours section.
Non-primitive properties will be copied via their own clone() method.</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="BeatmapColoursSection.html" class="tsd-signature-type" data-tsd-kind="Class">BeatmapColoursSection</a></h4><div><p>A copied information about control points.</p>
Expand Down
Loading

0 comments on commit d1fe60c

Please sign in to comment.