bancho.js 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Pre-release
 
+## Version 0.11
+
+### Version 0.11.0
+
+- **Add ability to set default gamemode for fetching users from API**  
+  In order to optimize API calls in your application, you can rely on bancho.js' existing API data.  
+  The new `gamemode` parameter in the bancho.js config object allows you to specify which gamemode data to receive when fetching an user to save more API calls in certain scenarios.
+
+- **BanchoLobby: When updating from an FFA to a team-based mode, reset teams**  
+  Whenn enabling teams, all players in the lobby are assigned a default team. They're assigned predictably based on their slots.  
+  bancho.js now applies the same algorithm when changing team mode.
+
 ## Version 0.10
 
+### Version 0.10.1
+
+- **BanchoLobby: Fix beatmap never being refreshed from API**
+
 ### Version 0.10.0
 
 #### Highlights

package/README.md

@@ -3,7 +3,7 @@
 [![NPM](https://nodei.co/npm/bancho.js.png?compact=true)](https://nodei.co/npm/bancho.js/)  
 [![pipeline status](https://git.cartooncraft.fr/ThePooN/bancho.js/badges/master/pipeline.svg)](https://git.cartooncraft.fr/ThePooN/bancho.js/commits/master)
 
-## Current release: 0.10.0
+## Current release: 0.11.0
 
 # Introduction
 

package/index.d.ts

@@ -794,7 +794,11 @@ declare module "bancho.js" {
 		/**
 		 * osu! API key for API requests (see https://osu.ppy.sh/p/api). WARNING: Multiplayer lobbies won't work without an API key!
 		 */
-		apiKey?: string
+		apiKey?: string,
+		/**
+		 * Gamemode id to fetch users with. Defaults to null
+		 */
+		gamemode?: number
 	}
 
 	interface BanchoClientOptionsWithoutRateLimiter extends BanchoClientBaseOptions {

package/lib/BanchoClient.js

@@ -58,6 +58,7 @@ class BanchoClient extends EventEmitter {
 			 * @prop {string}      [apiKey] osu! API key for API requests (see https://osu.ppy.sh/p/api). WARNING: Multiplayer lobbies won't work without an API key!
 			 * @prop {RateLimiter} [rateLimiter] Instance of RateLimiter from the `limiter` npm module for outgoing Bancho messages. Default is safe for normal users in private messages (PM and #multiplayer channels), bots are not supposed to send public messages. Can be disabled by setting to `null`.
 			 * @prop {boolean}     [botAccount=false] Apply bot account rate-limits to the default RateLimiter instance if true (see https://osu.ppy.sh/wiki/en/Bot_account).
+			 * @prop {number}      [gamemode=null] Gamemode id to fetch users with. Defaults to null
 			 */
 			const options = {
 				host: "irc.ppy.sh",
@@ -66,6 +67,7 @@ class BanchoClient extends EventEmitter {
 				limiterPrivate: 9,
 				limiterPublic: undefined,
 				botAccount: false,
+				gamemode: null,
 			};
 			Object.assign(options, optionsOrUsername);
 			if(options.rateLimiter && options.botAccount)
@@ -90,10 +92,12 @@ class BanchoClient extends EventEmitter {
 			this.password = options.password;
 			this.host = options.host;
 			this.port = options.port;
-			if(options.apiKey)
+			if(options.apiKey) {
 				this.osuApi = new Nodesu.Client(options.apiKey, {
 					parseData: true
 				});
+				this.gamemode = options.gamemode;
+			}
 			this.rateLimiter = options.rateLimiter;
 		}
 		this.setMaxListeners(50);
@@ -341,7 +345,7 @@ class BanchoClient extends EventEmitter {
 			if(user)
 				resolve(user);
 			else
-				this.osuApi.user.get(userid, Nodesu.LookupType.id).then((apiUser) => {
+				this.osuApi.user.get(userid, this.gamemode, null, Nodesu.LookupType.id).then((apiUser) => {
 					user = this.getUser(apiUser.username);
 					user.updateFromAPI(apiUser);
 					resolve(user);

package/lib/BanchoMessage.js

@@ -27,7 +27,7 @@ class BanchoMessage {
 	
 	/**
 	 * The content of this message
-	 * @type {string}
+	 * @returns {string}
 	 */
 	get content() {
 		return this.message;
@@ -35,7 +35,7 @@ class BanchoMessage {
 
 	/**
 	 * Tries to parse this message as an ACTION (/me message).
-	 * @returns {[string]}
+	 * @returns {string}
 	 */
 	getAction() {
 		const action = actionRegex.exec(this.message);

package/lib/BanchoUser.js

@@ -78,7 +78,7 @@ class BanchoUser extends EventEmitter {
 	fetchFromAPI() {
 		if(this.banchojs.osuApi) {
 			return new Promise((resolve, reject) => {
-				this.banchojs.osuApi.user.get(this.ircUsername, null, null, Nodesu.LookupType.string).then((user) => {
+				this.banchojs.osuApi.user.get(this.ircUsername, this.banchojs.gamemode, null, Nodesu.LookupType.string).then((user) => {
 					this.updateFromAPI(user);
 					resolve(user);
 				}, reject);

package/lib/Multiplayer/BanchoLobby.js

@@ -7,6 +7,7 @@ const BanchoLobbyPlayerStates = require("./Enums/BanchoLobbyPlayerStates");
 const BanchoLobbyTeams = require("./Enums/BanchoLobbyTeams");
 const Regexes = require("./BanchoLobbyRegexes");
 const Teams = require("./Enums/BanchoLobbyTeams");
+const BanchoLobbyTeamModes = require("./Enums/BanchoLobbyTeamModes");
 
 /**
  * Represents a Bancho multiplayer lobby
@@ -138,8 +139,8 @@ class BanchoLobby extends EventEmitter {
 				case "playerChangedBeatmap":
 				case "refereeChangedBeatmap":
 				case "beatmapFromSettings":
-					this.beatmapId = ret.id;
 					if(ret.id != this.beatmapId) {
+						this.beatmapId = ret.id;
 						this.beatmap = null;
 						for(const player of this.slots)
 							if(player != null)
@@ -1081,6 +1082,15 @@ class BanchoLobby extends EventEmitter {
 	 * @see BanchoLobbyTeamModes
 	 */
 	set teamMode(val) {
+		const teamModes = [BanchoLobbyTeamModes.TeamVs, BanchoLobbyTeamModes.TagTeamVs];
+		if(!teamModes.includes(this.teamMode) && teamModes.includes(val)) {
+			for(let i = 0; i < this.slots.length; i++) {
+				const slot = this.slots[i];
+				if (slot !== null) {
+					slot.team = i % 2 === 0 ? BanchoLobbyTeams.Blue : BanchoLobbyTeams.Red;
+				}
+			}
+		}
 		this._setter("teamMode", val);
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bancho.js",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Interface with Bancho over IRC, made easy and reliable",
   "main": "index.js",
   "types": "index.d.ts",