Refactoring (#1660)

* Refactor a couple of iterators

* Use side-effect instead of second iterator

* Make World::onTick return shouldDelete instead of success

* Replace Shop iterator with side effects

* Scene

* Clean up Expeditions

* Refactor Expeditions

* Clean up Expeditions, Player

* Limit Expeditions by AR

* Lombokify props

Co-authored-by: AnimeGitB <AnimeGitB@bigblueball.in>

src/main/java/emu/grasscutter/server/game/GameServer.java

@@ -218,21 +218,10 @@ public final class GameServer extends KcpServer {
         var tickStart = Instant.now();
 
         // Tick worlds.
-        Iterator<World> it = this.getWorlds().iterator();
-        while (it.hasNext()) {
-            World world = it.next();
-
-            if (world.getPlayerCount() == 0) {
-                it.remove();
-            }
-
-            world.onTick();
-        }
+        this.worlds.removeIf(World::onTick);
 
         // Tick players.
-        for (Player player : this.getPlayers().values()) {
-            player.onTick();
-        }
+        this.players.values().forEach(Player::onTick);
 
         // Tick scheduler.
         this.getScheduler().runTasks();

src/main/java/emu/grasscutter/server/packet/recv/HandlerAvatarExpeditionAllDataReq.java

@@ -10,6 +10,7 @@ import emu.grasscutter.server.packet.send.PacketAvatarExpeditionAllDataRsp;
 public class HandlerAvatarExpeditionAllDataReq extends PacketHandler {
     @Override
     public void handle(GameSession session, byte[] header, byte[] payload) throws Exception {
-        session.send(new PacketAvatarExpeditionAllDataRsp(session.getPlayer()));
+        var player = session.getPlayer();
+        session.send(new PacketAvatarExpeditionAllDataRsp(player.getExpeditionInfo(), player.getExpeditionLimit()));
     }
 }

src/main/java/emu/grasscutter/server/packet/recv/HandlerAvatarExpeditionCallBackReq.java

@@ -6,20 +6,19 @@ import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionCallBackReqOuterClass.AvatarExpeditionCallBackReq;
 import emu.grasscutter.server.game.GameSession;
 import emu.grasscutter.server.packet.send.PacketAvatarExpeditionCallBackRsp;
-import emu.grasscutter.server.packet.send.PacketAvatarExpeditionStartRsp;
-import emu.grasscutter.utils.Utils;
 
 @Opcodes(PacketOpcodes.AvatarExpeditionCallBackReq)
 public class HandlerAvatarExpeditionCallBackReq extends PacketHandler {
     @Override
     public void handle(GameSession session, byte[] header, byte[] payload) throws Exception {
         AvatarExpeditionCallBackReq req = AvatarExpeditionCallBackReq.parseFrom(payload);
+        var player = session.getPlayer();
 
         for (int i = 0; i < req.getAvatarGuidCount(); i++) {
-            session.getPlayer().removeExpeditionInfo(req.getAvatarGuid(i));
+            player.removeExpeditionInfo(req.getAvatarGuid(i));
         }
 
-        session.getPlayer().save();
-        session.send(new PacketAvatarExpeditionCallBackRsp(session.getPlayer()));
+        player.save();
+        session.send(new PacketAvatarExpeditionCallBackRsp(player.getExpeditionInfo()));
     }
 }

src/main/java/emu/grasscutter/server/packet/recv/HandlerAvatarExpeditionGetRewardReq.java

@@ -1,27 +1,18 @@
 package emu.grasscutter.server.packet.recv;
 
-import emu.grasscutter.Grasscutter;
-import emu.grasscutter.game.drop.DropData;
 import emu.grasscutter.game.expedition.ExpeditionInfo;
-import emu.grasscutter.game.expedition.ExpeditionRewardData;
 import emu.grasscutter.game.expedition.ExpeditionRewardDataList;
 import emu.grasscutter.game.inventory.GameItem;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.game.props.ActionReason;
 import emu.grasscutter.net.packet.Opcodes;
 import emu.grasscutter.net.packet.PacketHandler;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionGetRewardReqOuterClass.AvatarExpeditionGetRewardReq;
 import emu.grasscutter.server.game.GameSession;
-import emu.grasscutter.server.packet.send.PacketAvatarExpeditionCallBackRsp;
 import emu.grasscutter.server.packet.send.PacketAvatarExpeditionGetRewardRsp;
-import emu.grasscutter.server.packet.send.PacketGadgetInteractRsp;
 import emu.grasscutter.server.packet.send.PacketItemAddHintNotify;
-import emu.grasscutter.utils.Utils;
 
 import java.util.ArrayList;
-import java.util.Collection;
-import java.util.LinkedList;
 import java.util.List;
 
 @Opcodes(PacketOpcodes.AvatarExpeditionGetRewardReq)
@@ -29,33 +20,25 @@ public class HandlerAvatarExpeditionGetRewardReq extends PacketHandler {
     @Override
     public void handle(GameSession session, byte[] header, byte[] payload) throws Exception {
         AvatarExpeditionGetRewardReq req = AvatarExpeditionGetRewardReq.parseFrom(payload);
+        var player = session.getPlayer();
 
-        ExpeditionInfo expInfo = session.getPlayer().getExpeditionInfo(req.getAvatarGuid());
+        ExpeditionInfo expInfo = player.getExpeditionInfo(req.getAvatarGuid());
+        List<GameItem> items = new ArrayList<>();
+        List<ExpeditionRewardDataList> expeditionRewardDataLists = session.getServer().getExpeditionSystem().getExpeditionRewardDataList().get(expInfo.getExpId());
 
-        List<GameItem> items = new LinkedList<>();
-
-        if (session.getServer().getExpeditionSystem().getExpeditionRewardDataList().containsKey(expInfo.getExpId())) {
-            for (ExpeditionRewardDataList RewardDataList : session.getServer().getExpeditionSystem().getExpeditionRewardDataList().get(expInfo.getExpId())) {
-                if (RewardDataList.getHourTime() == expInfo.getHourTime()) {
-                    if (!RewardDataList.getExpeditionRewardData().isEmpty()) {
-                        for (ExpeditionRewardData RewardData :RewardDataList.getExpeditionRewardData()) {
-                            int num = RewardData.getMinCount();
-                            if (RewardData.getMinCount() != RewardData.getMaxCount()) {
-                                num = Utils.randomRange(RewardData.getMinCount(), RewardData.getMaxCount());
-                            }
-                            items.add(new GameItem(RewardData.getItemId(), num));
-                        }
-                    }
-                }
-            }
+        if (expeditionRewardDataLists != null) {
+            expeditionRewardDataLists.stream()
+                .filter(r -> r.getHourTime() == expInfo.getHourTime())
+                .map(ExpeditionRewardDataList::getRewards)
+                .forEach(items::addAll);
         }
 
-        session.getPlayer().getInventory().addItems(items);
-        session.getPlayer().sendPacket(new PacketItemAddHintNotify(items, ActionReason.ExpeditionReward));
+        player.getInventory().addItems(items);
+        player.sendPacket(new PacketItemAddHintNotify(items, ActionReason.ExpeditionReward));
 
-        session.getPlayer().removeExpeditionInfo(req.getAvatarGuid());
-        session.getPlayer().save();
-        session.send(new PacketAvatarExpeditionGetRewardRsp(session.getPlayer(), items));
+        player.removeExpeditionInfo(req.getAvatarGuid());
+        player.save();
+        session.send(new PacketAvatarExpeditionGetRewardRsp(player.getExpeditionInfo(), items));
     }
 }
 

src/main/java/emu/grasscutter/server/packet/recv/HandlerAvatarExpeditionStartReq.java

@@ -1,6 +1,5 @@
 package emu.grasscutter.server.packet.recv;
 
-import emu.grasscutter.Grasscutter;
 import emu.grasscutter.net.packet.Opcodes;
 import emu.grasscutter.net.packet.PacketHandler;
 import emu.grasscutter.net.packet.PacketOpcodes;
@@ -14,10 +13,11 @@ public class HandlerAvatarExpeditionStartReq extends PacketHandler {
     @Override
     public void handle(GameSession session, byte[] header, byte[] payload) throws Exception {
         AvatarExpeditionStartReq req = AvatarExpeditionStartReq.parseFrom(payload);
+        var player = session.getPlayer();
 
         int startTime = Utils.getCurrentSeconds();
-        session.getPlayer().addExpeditionInfo(req.getAvatarGuid(), req.getExpId(), req.getHourTime(), startTime);
-        session.getPlayer().save();
-        session.send(new PacketAvatarExpeditionStartRsp(session.getPlayer()));
+        player.addExpeditionInfo(req.getAvatarGuid(), req.getExpId(), req.getHourTime(), startTime);
+        player.save();
+        session.send(new PacketAvatarExpeditionStartRsp(player.getExpeditionInfo()));
     }
 }

src/main/java/emu/grasscutter/server/packet/send/PacketAllWidgetDataNotify.java

@@ -33,7 +33,7 @@ public class PacketAllWidgetDataNotify extends BasePacket {
             // Good luck, my boy.
             .addAllNormalCoolDownDataList(List.of());
 
-        if (player.getWidgetId() == null) {
+        if (player.getWidgetId() == 0) {  // TODO: check this logic later, it was null-checking an int before which made it dead code
             proto.addAllSlotList(List.of());
         } else {
             proto.addSlotList(

src/main/java/emu/grasscutter/server/packet/send/PacketAvatarExpeditionAllDataRsp.java

@@ -1,33 +1,27 @@
 package emu.grasscutter.server.packet.send;
 
-import emu.grasscutter.Grasscutter;
 import emu.grasscutter.game.expedition.ExpeditionInfo;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionAllDataRspOuterClass.AvatarExpeditionAllDataRsp;
-import emu.grasscutter.net.proto.AvatarExpeditionInfoOuterClass.AvatarExpeditionInfo;
 
 import java.util.*;
+import java.util.stream.Collectors;
 
 public class PacketAvatarExpeditionAllDataRsp extends BasePacket {
-    public PacketAvatarExpeditionAllDataRsp(Player player) {
+    public PacketAvatarExpeditionAllDataRsp(Map<Long, ExpeditionInfo> expeditionInfo, int expeditionCountLimit) {
         super(PacketOpcodes.AvatarExpeditionAllDataRsp);
 
         List<Integer> openExpeditionList  = new ArrayList<>(List.of(306,305,304,303,302,301,206,105,204,104,203,103,202,101,102,201,106,205));
-        Map<Long, AvatarExpeditionInfo> avatarExpeditionInfoList = new HashMap<Long, AvatarExpeditionInfo>();
 
-        var expeditionInfo = player.getExpeditionInfo();
-        for (Long key : player.getExpeditionInfo().keySet()) {
-            ExpeditionInfo e = expeditionInfo.get(key);
-            avatarExpeditionInfoList.put(key, AvatarExpeditionInfo.newBuilder().setStateValue(e.getState()).setExpId(e.getExpId()).setHourTime(e.getHourTime()).setStartTime(e.getStartTime()).build());
-        };
-
-        AvatarExpeditionAllDataRsp.Builder proto = AvatarExpeditionAllDataRsp.newBuilder()
-                .addAllOpenExpeditionList(openExpeditionList)
-                .setExpeditionCountLimit(5)
-                .putAllExpeditionInfoMap(avatarExpeditionInfoList);
-
-        this.setData(proto.build());
+        this.setData(AvatarExpeditionAllDataRsp.newBuilder()
+            .addAllOpenExpeditionList(openExpeditionList)
+            .setExpeditionCountLimit(expeditionCountLimit)
+            .putAllExpeditionInfoMap(
+                expeditionInfo.entrySet().stream()
+                    .collect(Collectors.toMap(
+                        e -> e.getKey(),
+                        e -> e.getValue().toProto())))
+            .build());
     }
 }

src/main/java/emu/grasscutter/server/packet/send/PacketAvatarExpeditionCallBackRsp.java

@@ -1,22 +1,18 @@
 package emu.grasscutter.server.packet.send;
 
+import java.util.Map;
+
 import emu.grasscutter.game.expedition.ExpeditionInfo;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionCallBackRspOuterClass.AvatarExpeditionCallBackRsp;
-import emu.grasscutter.net.proto.AvatarExpeditionInfoOuterClass.AvatarExpeditionInfo;
 
 public class PacketAvatarExpeditionCallBackRsp extends BasePacket {
-    public PacketAvatarExpeditionCallBackRsp(Player player) {
+    public PacketAvatarExpeditionCallBackRsp(Map<Long, ExpeditionInfo> expeditionInfo) {
         super(PacketOpcodes.AvatarExpeditionCallBackRsp);
 
         AvatarExpeditionCallBackRsp.Builder proto = AvatarExpeditionCallBackRsp.newBuilder();
-        var expeditionInfo = player.getExpeditionInfo();
-        for (Long key : player.getExpeditionInfo().keySet()) {
-            ExpeditionInfo e = expeditionInfo.get(key);
-            proto.putExpeditionInfoMap(key, AvatarExpeditionInfo.newBuilder().setStateValue(e.getState()).setExpId(e.getExpId()).setHourTime(e.getHourTime()).setStartTime(e.getStartTime()).build());
-        };
+        expeditionInfo.forEach((key, e) -> proto.putExpeditionInfoMap(key, e.toProto()));
 
         this.setData(proto.build());
     }

src/main/java/emu/grasscutter/server/packet/send/PacketAvatarExpeditionDataNotify.java

@@ -1,29 +1,24 @@
 package emu.grasscutter.server.packet.send;
 
 import emu.grasscutter.game.expedition.ExpeditionInfo;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionDataNotifyOuterClass.AvatarExpeditionDataNotify;
-import emu.grasscutter.net.proto.AvatarExpeditionInfoOuterClass.AvatarExpeditionInfo;
 
 import java.util.*;
+import java.util.stream.Collectors;
 
 public class PacketAvatarExpeditionDataNotify extends BasePacket {
-    public PacketAvatarExpeditionDataNotify(Player player) {
+    public PacketAvatarExpeditionDataNotify(Map<Long, ExpeditionInfo> expeditionInfo) {
         super(PacketOpcodes.AvatarExpeditionDataNotify);
 
-        Map<Long, AvatarExpeditionInfo> avatarExpeditionInfoList = new HashMap<Long, AvatarExpeditionInfo>();
-
-        var expeditionInfo = player.getExpeditionInfo();
-        for (Long key : player.getExpeditionInfo().keySet()) {
-            ExpeditionInfo e = expeditionInfo.get(key);
-            avatarExpeditionInfoList.put(key, AvatarExpeditionInfo.newBuilder().setStateValue(e.getState()).setExpId(e.getExpId()).setHourTime(e.getHourTime()).setStartTime(e.getStartTime()).build());
-        };
-
-        AvatarExpeditionDataNotify.Builder proto = AvatarExpeditionDataNotify.newBuilder()
-                .putAllExpeditionInfoMap(avatarExpeditionInfoList);
-
-        this.setData(proto.build());
+        this.setData(AvatarExpeditionDataNotify.newBuilder()
+            .putAllExpeditionInfoMap(
+                expeditionInfo.entrySet().stream()
+                    .collect(Collectors.toMap(
+                        e -> e.getKey(),
+                        e -> e.getValue().toProto())))
+            .build()
+        );
     }
 }

src/main/java/emu/grasscutter/server/packet/send/PacketAvatarExpeditionGetRewardRsp.java

@@ -2,28 +2,20 @@ package emu.grasscutter.server.packet.send;
 
 import emu.grasscutter.game.expedition.ExpeditionInfo;
 import emu.grasscutter.game.inventory.GameItem;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.AvatarExpeditionGetRewardRspOuterClass.AvatarExpeditionGetRewardRsp;
-import emu.grasscutter.net.proto.AvatarExpeditionInfoOuterClass.AvatarExpeditionInfo;
 
 import java.util.Collection;
+import java.util.Map;
 
 public class PacketAvatarExpeditionGetRewardRsp extends BasePacket {
-    public PacketAvatarExpeditionGetRewardRsp(Player player, Collection<GameItem> items) {
+    public PacketAvatarExpeditionGetRewardRsp(Map<Long, ExpeditionInfo> expeditionInfo, Collection<GameItem> items) {
         super(PacketOpcodes.AvatarExpeditionGetRewardRsp);
 
         AvatarExpeditionGetRewardRsp.Builder proto = AvatarExpeditionGetRewardRsp.newBuilder();
-        var expeditionInfo = player.getExpeditionInfo();
-        for (Long key : player.getExpeditionInfo().keySet()) {
-            ExpeditionInfo e = expeditionInfo.get(key);
-            proto.putExpeditionInfoMap(key, AvatarExpeditionInfo.newBuilder().setStateValue(e.getState()).setExpId(e.getExpId()).setHourTime(e.getHourTime()).setStartTime(e.getStartTime()).build());
-        };
-
-        for (GameItem item : items) {
-            proto.addItemList(item.toItemParam());
-        }
+        expeditionInfo.forEach((key, e) -> proto.putExpeditionInfoMap(key, e.toProto()));
+        items.forEach(item -> proto.addItemList(item.toItemParam()));
 
         this.setData(proto.build());
     }

src/main/java/emu/grasscutter/server/packet/send/PacketAvatarExpeditionStartRsp.java

@@ -1,22 +1,18 @@
 package emu.grasscutter.server.packet.send;
 
+import java.util.Map;
+
 import emu.grasscutter.game.expedition.ExpeditionInfo;
-import emu.grasscutter.game.player.Player;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
-import emu.grasscutter.net.proto.AvatarExpeditionInfoOuterClass.AvatarExpeditionInfo;
 import emu.grasscutter.net.proto.AvatarExpeditionStartRspOuterClass.AvatarExpeditionStartRsp;
 
 public class PacketAvatarExpeditionStartRsp extends BasePacket {
-    public PacketAvatarExpeditionStartRsp(Player player) {
+    public PacketAvatarExpeditionStartRsp(Map<Long, ExpeditionInfo> expeditionInfo) {
         super(PacketOpcodes.AvatarExpeditionStartRsp);
 
         AvatarExpeditionStartRsp.Builder proto = AvatarExpeditionStartRsp.newBuilder();
-        var expeditionInfo = player.getExpeditionInfo();
-        for (Long key : player.getExpeditionInfo().keySet()) {
-            ExpeditionInfo e = expeditionInfo.get(key);
-            proto.putExpeditionInfoMap(key, AvatarExpeditionInfo.newBuilder().setStateValue(e.getState()).setExpId(e.getExpId()).setHourTime(e.getHourTime()).setStartTime(e.getStartTime()).build());
-        };
+        expeditionInfo.forEach((key, e) -> proto.putExpeditionInfoMap(key, e.toProto()));
 
         this.setData(proto.build());
     }

src/main/java/emu/grasscutter/server/packet/send/PacketGetWidgetSlotRsp.java

@@ -17,7 +17,7 @@ public class PacketGetWidgetSlotRsp extends BasePacket {
         GetWidgetSlotRspOuterClass.GetWidgetSlotRsp.Builder proto =
                 GetWidgetSlotRspOuterClass.GetWidgetSlotRsp.newBuilder();
 
-        if (player.getWidgetId() == null) {
+        if (player.getWidgetId() == 0) {  // TODO: check this logic later, it was null-checking an int before which made it dead code
             proto.addAllSlotList(List.of());
         } else {
             proto.addSlotList(