nodesu
Version:
a node.js osu! api wrapper
1,054 lines (320 loc) • 18 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Beatmap</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Beatmap</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="module-CustomClasses.html">CustomClasses</a>~</span>Beatmap<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Beatmap class</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Beatmap"><span class="type-signature"></span>new Beatmap<span class="signature">()</span><span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>approved</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ApprovalStatus">ApprovalStatus</a></span>
</td>
<td class="description last">Approval status [alias: rankedStatus]</td>
</tr>
<tr>
<td class="name"><code>submitDate</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last">Date it was first submitted</td>
</tr>
<tr>
<td class="name"><code>approvedDate</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last">Date it was approved</td>
</tr>
<tr>
<td class="name"><code>lastUpdate</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last">The date the map was last updated</td>
</tr>
<tr>
<td class="name"><code>artist</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The song artist</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Beatmap id [alias: beatmapId]</td>
</tr>
<tr>
<td class="name"><code>setId</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Beatmap set id [alias: beatmapSetId]</td>
</tr>
<tr>
<td class="name"><code>bpm</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Song BPM</td>
</tr>
<tr>
<td class="name"><code>creator</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The beatmap creator [alias: mapper]</td>
</tr>
<tr>
<td class="name"><code>creatorId</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">The user id of the beatmap creator [alias: mapperId]</td>
</tr>
<tr>
<td class="name"><code>difficultyRating</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">The difficulty rating [alias: stars]</td>
</tr>
<tr>
<td class="name"><code>diffSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Difficulty size (aka CS) [alias: circleSize, CS]</td>
</tr>
<tr>
<td class="name"><code>diffOverall</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Difficulty overall (aka OD) [alias: overallDifficulty, OD]</td>
</tr>
<tr>
<td class="name"><code>diffApproach</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Difficulty approach (aka AR) [alias: approachRate, AR]</td>
</tr>
<tr>
<td class="name"><code>diffDrain</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Difficulty drain (aka HP) [alias: hpDrain, HP]</td>
</tr>
<tr>
<td class="name"><code>countNormal</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Amount of normal notes (hitcircles).</td>
</tr>
<tr>
<td class="name"><code>countSlider</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Amount of slider notes.</td>
</tr>
<tr>
<td class="name"><code>countSpinner</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Amount of spinners.</td>
</tr>
<tr>
<td class="name"><code>hitLength</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Drain length</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">null</span>
</td>
<td class="description last">The source data</td>
</tr>
<tr>
<td class="name"><code>genre</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Genre">Genre</a></span>
</td>
<td class="description last">Genre metadata</td>
</tr>
<tr>
<td class="name"><code>language</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Language">Language</a></span>
</td>
<td class="description last">Language metadata</td>
</tr>
<tr>
<td class="name"><code>title</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Title</td>
</tr>
<tr>
<td class="name"><code>totalLength</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Total length of song</td>
</tr>
<tr>
<td class="name"><code>version</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Version (aka diffname) [alias: difficultyName]</td>
</tr>
<tr>
<td class="name"><code>fileMd5</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The MD5 of the file</td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Mode">Mode</a></span>
</td>
<td class="description last">The gamemode</td>
</tr>
<tr>
<td class="name"><code>tags</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">Tags</td>
</tr>
<tr>
<td class="name"><code>favouriteCount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Number of favorites on the map [alias: favoriteCount]</td>
</tr>
<tr>
<td class="name"><code>rating</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">User rating (1-10) [alias: userRating]</td>
</tr>
<tr>
<td class="name"><code>downloadUnavailable</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">If beatmap is not downloadable [reverse alias: downloadAvailable]</td>
</tr>
<tr>
<td class="name"><code>audioUnavailable</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">If beatmap is downloadable but has no audio [reverse alias: audioAvailable]</td>
</tr>
<tr>
<td class="name"><code>playcount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Number of playcounts</td>
</tr>
<tr>
<td class="name"><code>passcount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Number of passcount</td>
</tr>
<tr>
<td class="name"><code>maxCombo</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Number of map max combo</td>
</tr>
<tr>
<td class="name"><code>diffAim</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Aim difficulty rated by ppv2</td>
</tr>
<tr>
<td class="name"><code>diffSpeed</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Speed difficulty rated by ppv2</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="struct_Beatmap.js.html">struct/Beatmap.js</a>, <a href="struct_Beatmap.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Components.html">Components</a></li><li><a href="module-CustomClasses.html">CustomClasses</a></li><li><a href="module-Enums.html">Enums</a></li><li><a href="module-Errors.html">Errors</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="module-Components.BeatmapsComponent.html">BeatmapsComponent</a></li><li><a href="module-Components.MultiComponent.html">MultiComponent</a></li><li><a href="module-Components.ReplayComponent.html">ReplayComponent</a></li><li><a href="module-Components.ScoresComponent.html">ScoresComponent</a></li><li><a href="module-Components.UserComponent.html">UserComponent</a></li><li><a href="module-CustomClasses.Beatmap.html">Beatmap</a></li><li><a href="module-CustomClasses.BeatmapScore.html">BeatmapScore</a></li><li><a href="module-CustomClasses.Multi.html">Multi</a></li><li><a href="module-CustomClasses.MultiGame.html">MultiGame</a></li><li><a href="module-CustomClasses.MultiMatch.html">MultiMatch</a></li><li><a href="module-CustomClasses.MultiScore.html">MultiScore</a></li><li><a href="module-CustomClasses.ReplayData.html">ReplayData</a></li><li><a href="module-CustomClasses.Score.html">Score</a></li><li><a href="module-CustomClasses.User.html">User</a></li><li><a href="module-CustomClasses.UserEvent.html">UserEvent</a></li><li><a href="module-CustomClasses.UserScore.html">UserScore</a></li><li><a href="module-Errors.OsuApiError.html">OsuApiError</a></li><li><a href="Requester.html">Requester</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ApprovalStatus">ApprovalStatus</a></li><li><a href="global.html#Converts">Converts</a></li><li><a href="global.html#Genre">Genre</a></li><li><a href="global.html#Language">Language</a></li><li><a href="global.html#LookupType">LookupType</a></li><li><a href="global.html#Mode">Mode</a></li><li><a href="global.html#Mods">Mods</a></li><li><a href="global.html#MultiScoringType">MultiScoringType</a></li><li><a href="global.html#MultiTeam">MultiTeam</a></li><li><a href="global.html#MultiTeamType">MultiTeamType</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sat Apr 11 2020 14:41:31 GMT+1000 (GMT+10:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>