Add gamemode test related comments

PrismarineJS · Nov 21, 2024 · cd66986 · cd66986
1 parent e346813
commit cd66986
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/lib/plugins/game.js b/lib/plugins/game.js
@@ -25,7 +25,7 @@ function inject (bot, options) {
   function handleRespawnPacketData (packet) {
     bot.game.levelType = packet.levelType ?? (packet.isFlat ? 'flat' : 'default')
     bot.game.hardcore = packet.isHardcore ?? Boolean(packet.gameMode & 0b100)
-    if (bot.registry.isOlderThan('1.10')) {
+    if (bot.registry.isOlderThan('1.10')) { // gamemode is used pre 1.10 and post 1.20 but in between it's gameMode
       bot.game.gameMode = parseGameMode(packet.gamemode)
     } else {
       bot.game.gameMode = packet.gamemode || parseGameMode(packet.gameMode & 0b1111) // lower four bits

diff --git a/test/externalTests/gamemode.js b/test/externalTests/gamemode.js
@@ -23,6 +23,7 @@ module.exports = () => {
     bot.chat('/kill')
 
     await onceWithCleanup(bot, 'respawn', { timeout: 2000 })
+    // Respawn packets send the gamemode. If the bot is in creative mode, it should respawn in creative mode. Tested <1.20
     assert.strictEqual(bot.game.gameMode, 'creative', 'Wrong gamemode after respawn')
   })