Implement local specialty spawning

src/main/java/emu/grasscutter/data/GameData.java

@@ -75,6 +75,7 @@ public class GameData {
 	private static final Int2ObjectMap<ShopGoodsData> shopGoodsDataMap = new Int2ObjectOpenHashMap<>();
 	private static final Int2ObjectMap<CombineData> combineDataMap = new Int2ObjectOpenHashMap<>();
 	private static final Int2ObjectMap<RewardPreviewData> rewardPreviewDataMap = new Int2ObjectOpenHashMap<>();
+	private static final Int2ObjectMap<GatherData> gatherDataMap = new Int2ObjectOpenHashMap<>();
 	private static final Int2ObjectMap<TowerFloorData> towerFloorDataMap = new Int2ObjectOpenHashMap<>();
 	private static final Int2ObjectMap<TowerLevelData> towerLevelDataMap = new Int2ObjectOpenHashMap<>();
 	private static final Int2ObjectMap<TowerScheduleData> towerScheduleDataMap = new Int2ObjectOpenHashMap<>();
@@ -347,4 +348,8 @@ public class GameData {
 	public static Int2ObjectMap<QuestData> getQuestDataMap() {
 		return questDataMap;
 	}
+
+	public static Int2ObjectMap<GatherData> getGatherDataMap() {
+		return gatherDataMap;
+	}
 }

src/main/java/emu/grasscutter/data/def/GatherData.java

+package emu.grasscutter.data.def;
+
+import emu.grasscutter.data.GameResource;
+import emu.grasscutter.data.ResourceType;
+
+@ResourceType(name = "GatherExcelConfigData.json")
+public class GatherData extends GameResource {
+	private int PointType;
+	private int Id;
+	private int GadgetId;
+	private int ItemId;
+	private int Cd; // Probably hours
+	private boolean IsForbidGuest;
+	private boolean InitDisableInteract;
+	    
+	@Override
+	public int getId() {
+		return this.PointType;
+	}
+
+	public int getGatherId() {
+		return Id;
+	}
+
+	public int getGadgetId() {
+		return GadgetId;
+	}
+
+	public int getItemId() {
+		return ItemId;
+	}
+
+	public int getCd() {
+		return Cd;
+	}
+
+	public boolean isForbidGuest() {
+		return IsForbidGuest;
+	}
+
+	public boolean initDisableInteract() {
+		return InitDisableInteract;
+	}
+
+	@Override
+	public void onLoad() {
+
+	}
+}

src/main/java/emu/grasscutter/data/def/SceneData.java

@@ -12,7 +12,6 @@ public class SceneData extends GameResource {
 	private SceneType Type;
 	private String ScriptData;
 
-	    
 	@Override
 	public int getId() {
 		return this.Id;

src/main/java/emu/grasscutter/game/entity/EntityGadget.java

@@ -5,8 +5,13 @@ import java.util.List;
 
 import emu.grasscutter.data.GameData;
 import emu.grasscutter.data.def.GadgetData;
+import emu.grasscutter.game.entity.gadget.GadgetContent;
+import emu.grasscutter.game.entity.gadget.GadgetGatherPoint;
+import emu.grasscutter.game.entity.gadget.GadgetRewardStatue;
+import emu.grasscutter.game.entity.gadget.GadgetWorktop;
 import emu.grasscutter.game.props.EntityIdType;
 import emu.grasscutter.game.props.EntityType;
+import emu.grasscutter.game.props.FightProperty;
 import emu.grasscutter.game.props.PlayerProperty;
 import emu.grasscutter.game.world.Scene;
 import emu.grasscutter.game.world.World;
@@ -39,7 +44,8 @@ public class EntityGadget extends EntityBaseGadget {
 	private int gadgetId;
 	
 	private int state;
-	private IntSet worktopOptions;
+	private int pointType;
+	private GadgetContent content;
 
 	public EntityGadget(Scene scene, int gadgetId, Position pos) {
 		super(scene);
@@ -50,19 +56,22 @@ public class EntityGadget extends EntityBaseGadget {
 		this.rot = new Position();
 	}
 	
+	public EntityGadget(Scene scene, int gadgetId, Position pos, GadgetContent content) {
+		this(scene, gadgetId, pos);
+		this.content = content;
+	}
+	
 	public GadgetData getGadgetData() {
 		return data;
 	}
 
 	@Override
 	public Position getPosition() {
-		// TODO Auto-generated method stub
 		return this.pos;
 	}
 
 	@Override
 	public Position getRotation() {
-		// TODO Auto-generated method stub
 		return this.rot;
 	}
 	
@@ -82,27 +91,42 @@ public class EntityGadget extends EntityBaseGadget {
 		this.state = state;
 	}
 
-	public IntSet getWorktopOptions() {
-		return worktopOptions;
+	public int getPointType() {
+		return pointType;
 	}
-	
-	public void addWorktopOptions(int[] options) {
-		if (this.worktopOptions == null) {
-			this.worktopOptions = new IntOpenHashSet();
-		}
-		Arrays.stream(options).forEach(this.worktopOptions::add);
+
+	public void setPointType(int pointType) {
+		this.pointType = pointType;
+	}
+
+	public GadgetContent getContent() {
+		return content;
+	}
+
+	@Deprecated // Dont use!
+	public void setContent(GadgetContent content) {
+		this.content = this.content == null ? content : this.content;
 	}
 	
-	public void removeWorktopOption(int option) {
-		if (this.worktopOptions == null) {
+	// TODO refactor
+	public void buildContent() {
+		if (getContent() != null || getGadgetData() == null || getGadgetData().getType() == null) {
 			return;
 		}
-		this.worktopOptions.remove(option);
+		
+		EntityType type = getGadgetData().getType();
+		GadgetContent content = switch (type) {
+			case GatherPoint -> new GadgetGatherPoint(this);
+			case Worktop -> new GadgetWorktop(this);
+			case RewardStatue -> new GadgetRewardStatue(this);
+			default -> null;
+		};
+		
+		this.content = content;
 	}
 
 	@Override
 	public Int2FloatOpenHashMap getFightProperties() {
-		// TODO Auto-generated method stub
 		return null;
 	}
 
@@ -143,11 +167,8 @@ public class EntityGadget extends EntityBaseGadget {
 				.setIsEnableInteract(true)
 				.setAuthorityPeerId(this.getScene().getWorld().getHostPeerId());
 		
-		if (this.getGadgetData().getType() == EntityType.Worktop && this.getWorktopOptions() != null) {
-			WorktopInfo worktop = WorktopInfo.newBuilder()
-					.addAllOptionList(this.getWorktopOptions())
-					.build();
-			gadgetInfo.setWorktop(worktop);
+		if (this.getContent() != null) {
+			this.getContent().onBuildProto(gadgetInfo);
 		}
 
 		entityInfo.setGadget(gadgetInfo);

src/main/java/emu/grasscutter/game/entity/gadget/GadgetContent.java

+package emu.grasscutter.game.entity.gadget;
+
+import emu.grasscutter.game.entity.EntityGadget;
+import emu.grasscutter.game.player.Player;
+import emu.grasscutter.net.proto.SceneGadgetInfoOuterClass.SceneGadgetInfo;
+
+public abstract class GadgetContent {
+	private final EntityGadget gadget;
+	
+	public GadgetContent(EntityGadget gadget) {
+		this.gadget = gadget;
+	}
+
+	public EntityGadget getGadget() {
+		return gadget;
+	}
+	
+	public abstract boolean onInteract(Player player);
+	
+	public abstract void onBuildProto(SceneGadgetInfo.Builder gadgetInfo);
+}

src/main/java/emu/grasscutter/game/entity/gadget/GadgetGatherPoint.java

+package emu.grasscutter.game.entity.gadget;
+
+import emu.grasscutter.data.GameData;
+import emu.grasscutter.data.def.GatherData;
+import emu.grasscutter.game.entity.EntityGadget;
+import emu.grasscutter.game.inventory.GameItem;
+import emu.grasscutter.game.player.Player;
+import emu.grasscutter.game.props.ActionReason;
+import emu.grasscutter.net.proto.GatherGadgetInfoOuterClass.GatherGadgetInfo;
+import emu.grasscutter.net.proto.SceneGadgetInfoOuterClass.SceneGadgetInfo;
+
+public class GadgetGatherPoint extends GadgetContent {
+	private GatherData gatherData;
+	
+	public GadgetGatherPoint(EntityGadget gadget) {
+		super(gadget);
+		this.gatherData = GameData.getGatherDataMap().get(gadget.getPointType());
+	}
+	
+	public GatherData getGatherData() {
+		return gatherData;
+	}
+	
+	public int getItemId() {
+		return getGatherData().getItemId();
+	}
+
+	public boolean onInteract(Player player) {
+		GameItem item = new GameItem(gatherData.getItemId(), 1);
+		
+		player.getInventory().addItem(item, ActionReason.Gather);
+		
+		return true;
+	}
+
+	public void onBuildProto(SceneGadgetInfo.Builder gadgetInfo) {
+		GatherGadgetInfo gatherGadgetInfo = GatherGadgetInfo.newBuilder()
+				.setItemId(this.getItemId())
+				.setIsForbidGuest(this.getGatherData().isForbidGuest())
+				.build();
+
+		gadgetInfo.setGatherGadget(gatherGadgetInfo);
+	}
+}

src/main/java/emu/grasscutter/game/entity/gadget/GadgetRewardStatue.java

+package emu.grasscutter.game.entity.gadget;
+
+import emu.grasscutter.game.entity.EntityGadget;
+import emu.grasscutter.game.player.Player;
+import emu.grasscutter.net.proto.InteractTypeOuterClass.InteractType;
+import emu.grasscutter.net.proto.SceneGadgetInfoOuterClass.SceneGadgetInfo;
+import emu.grasscutter.server.packet.send.PacketGadgetInteractRsp;
+
+public class GadgetRewardStatue extends GadgetContent {
+	
+	public GadgetRewardStatue(EntityGadget gadget) {
+		super(gadget);
+	}
+
+	public boolean onInteract(Player player) {
+		if (player.getScene().getChallenge() != null) {
+			player.getScene().getChallenge().getStatueDrops(player);
+		}
+		
+		player.sendPacket(new PacketGadgetInteractRsp(getGadget(), InteractType.INTERACT_OPEN_STATUE));
+		
+		return false;
+	}
+
+	public void onBuildProto(SceneGadgetInfo.Builder gadgetInfo) {
+		
+	}
+}

src/main/java/emu/grasscutter/game/entity/gadget/GadgetWorktop.java

+package emu.grasscutter.game.entity.gadget;
+
+import java.util.Arrays;
+
+import emu.grasscutter.game.entity.EntityGadget;
+import emu.grasscutter.game.player.Player;
+import emu.grasscutter.net.proto.SceneGadgetInfoOuterClass.SceneGadgetInfo;
+import emu.grasscutter.net.proto.WorktopInfoOuterClass.WorktopInfo;
+import it.unimi.dsi.fastutil.ints.IntOpenHashSet;
+import it.unimi.dsi.fastutil.ints.IntSet;
+
+public class GadgetWorktop extends GadgetContent {
+	private IntSet worktopOptions;
+	
+	public GadgetWorktop(EntityGadget gadget) {
+		super(gadget);
+	}
+	
+	public IntSet getWorktopOptions() {
+		return worktopOptions;
+	}
+	
+	public void addWorktopOptions(int[] options) {
+		if (this.worktopOptions == null) {
+			this.worktopOptions = new IntOpenHashSet();
+		}
+		Arrays.stream(options).forEach(this.worktopOptions::add);
+	}
+	
+	public void removeWorktopOption(int option) {
+		if (this.worktopOptions == null) {
+			return;
+		}
+		this.worktopOptions.remove(option);
+	}
+
+	public boolean onInteract(Player player) {
+		return false;
+	}
+
+	public void onBuildProto(SceneGadgetInfo.Builder gadgetInfo) {
+		if (this.worktopOptions == null) {
+			return;
+		}
+		
+		WorktopInfo worktop = WorktopInfo.newBuilder()
+				.addAllOptionList(this.getWorktopOptions())
+				.build();
+		
+		gadgetInfo.setWorktop(worktop);
+	}
+}

src/main/java/emu/grasscutter/game/player/Player.java

@@ -917,22 +917,20 @@ public class Player {
 				else
 					this.getScene().broadcastPacket(new PacketGadgetInteractRsp(drop, InteractType.INTERACT_PICK_ITEM));
 			}
-		} else if (entity instanceof EntityGadget) {
-			EntityGadget gadget = (EntityGadget) entity;
+		} else if (entity instanceof EntityGadget gadget) {
+			if (gadget.getContent() == null) {
+				return;
+			}
 			
-			if (gadget.getGadgetData().getType() == EntityType.RewardStatue) {
-				if (scene.getChallenge() != null) {
-					scene.getChallenge().getStatueDrops(this);
-				}
-				
-				this.sendPacket(new PacketGadgetInteractRsp(gadget, InteractType.INTERACT_OPEN_STATUE));
+			boolean shouldDelete = gadget.getContent().onInteract(this);
+			
+			if (shouldDelete) {
+				entity.getScene().removeEntity(entity);
 			}
 		} else {
 			// Delete directly
 			entity.getScene().removeEntity(entity);
 		}
-
-		return;
 	}
 
 	public void onPause() {

src/main/java/emu/grasscutter/game/world/Scene.java

@@ -23,6 +23,7 @@ import emu.grasscutter.net.proto.VisionTypeOuterClass.VisionType;
 import emu.grasscutter.scripts.SceneIndexManager;
 import emu.grasscutter.scripts.SceneScriptManager;
 import emu.grasscutter.scripts.data.SceneBlock;
+import emu.grasscutter.scripts.data.SceneGadget;
 import emu.grasscutter.scripts.data.SceneGroup;
 import emu.grasscutter.server.packet.send.PacketAvatarSkillInfoNotify;
 import emu.grasscutter.server.packet.send.PacketDungeonChallengeFinishNotify;
@@ -577,7 +578,15 @@ public class Scene {
 			if (group.init_config == null) {
 				continue;
 			}
+			
+			// Load garbages
+			List<SceneGadget> garbageGadgets = group.getGarbageGadgets();
+			
+			if (garbageGadgets != null) {
+				garbageGadgets.forEach(g -> scriptManager.createGadgets(group.id, group.block_id, g));
+			}
 
+			// Load suites
 			int suite = group.init_config.suite;
 
 			if (suite == 0) {

src/main/java/emu/grasscutter/scripts/SceneScriptManager.java

@@ -362,6 +362,8 @@ public class SceneScriptManager {
 		entity.setGroupId(groupId);
 		entity.getRotation().set(g.rot);
 		entity.setState(g.state);
+		entity.setPointType(g.point_type);
+		entity.buildContent();
 
 		return entity;
 	}

src/main/java/emu/grasscutter/scripts/ScriptLib.java

@@ -4,6 +4,7 @@ import emu.grasscutter.game.dungeons.DungeonChallenge;
 import emu.grasscutter.game.entity.EntityGadget;
 import emu.grasscutter.game.entity.EntityMonster;
 import emu.grasscutter.game.entity.GameEntity;
+import emu.grasscutter.game.entity.gadget.GadgetWorktop;
 import emu.grasscutter.scripts.data.SceneGroup;
 import emu.grasscutter.scripts.data.SceneRegion;
 import emu.grasscutter.server.packet.send.PacketCanUseSkillNotify;
@@ -83,21 +84,22 @@ public class ScriptLib {
 	public int SetWorktopOptionsByGroupId(int groupId, int configId, int[] options) {
 		logger.debug("[LUA] Call SetWorktopOptionsByGroupId with {},{},{}",
 				groupId,configId,options);
+		
 		Optional<GameEntity> entity = getSceneScriptManager().getScene().getEntities().values().stream()
 				.filter(e -> e.getConfigId() == configId && e.getGroupId() == groupId).findFirst();
 
-		if (entity.isEmpty()) {
+
+		if (entity.isEmpty() || !(entity.get() instanceof EntityGadget gadget)) {
 			return 1;
 		}
-		
-		if (!(entity.get() instanceof EntityGadget)) {
+
+		if (!(gadget.getContent() instanceof GadgetWorktop worktop)) {
 			return 1;
 		}
 		
-		EntityGadget gadget = (EntityGadget) entity.get();
-		gadget.addWorktopOptions(options);
-
+		worktop.addWorktopOptions(options);
 		getSceneScriptManager().getScene().broadcastPacket(new PacketWorktopOptionNotify(gadget));
+		
 		return 0;
 	}
 	
@@ -107,18 +109,17 @@ public class ScriptLib {
 		Optional<GameEntity> entity = getSceneScriptManager().getScene().getEntities().values().stream()
 				.filter(e -> e.getConfigId() == configId && e.getGroupId() == groupId).findFirst();
 
-		if (entity.isEmpty()) {
+		if (entity.isEmpty() || !(entity.get() instanceof EntityGadget gadget)) {
 			return 1;
 		}
-		
-		if (!(entity.get() instanceof EntityGadget)) {
+
+		if (!(gadget.getContent() instanceof GadgetWorktop worktop)) {
 			return 1;
 		}
 		
-		EntityGadget gadget = (EntityGadget) entity.get();
-		gadget.removeWorktopOption(option);
-		
+		worktop.removeWorktopOption(option);
 		getSceneScriptManager().getScene().broadcastPacket(new PacketWorktopOptionNotify(gadget));
+		
 		return 0;
 	}
 	

src/main/java/emu/grasscutter/scripts/ScriptLoader.java

@@ -95,7 +95,7 @@ public class ScriptLoader {
 			return sc.get();
 		}
 
-		Grasscutter.getLogger().info("Loaded Script" + path);
+		Grasscutter.getLogger().info("Loading script " + path);
 
 		File file = new File(path);
 
@@ -106,7 +106,7 @@ public class ScriptLoader {
 			scriptsCache.put(path, new SoftReference<>(script));
 			return script;
 		} catch (Exception e) {
-			Grasscutter.getLogger().error("Loaded Script {} failed!", path, e);
+			Grasscutter.getLogger().error("Loading script {} failed!", path, e);
 			return null;
 		}
 

src/main/java/emu/grasscutter/scripts/data/SceneBusiness.java

+package emu.grasscutter.scripts.data;
+
+import lombok.Setter;
+import lombok.ToString;
+
+@ToString
+@Setter
+public class SceneBusiness {
+	public int type;
+}

src/main/java/emu/grasscutter/scripts/data/SceneGadget.java

@@ -8,4 +8,5 @@ import lombok.ToString;
 public class SceneGadget extends SceneObject{
 	public int gadget_id;
 	public int state;
+	public int point_type;
 }

src/main/java/emu/grasscutter/scripts/data/SceneGarbage.java

+package emu.grasscutter.scripts.data;
+
+import java.util.List;
+
+import lombok.Setter;
+import lombok.ToString;
+
+@ToString
+@Setter
+public class SceneGarbage {
+	public List<SceneGadget> gadgets;
+}

src/main/java/emu/grasscutter/scripts/data/SceneGroup.java

@@ -26,21 +26,20 @@ public class SceneGroup {
 	public int refresh_id;
 	public Position pos;
 
-	/**
-	 * ConfigId - Monster
-	 */
-	public Map<Integer,SceneMonster> monsters;
-	/**
-	 * ConfigId - Gadget
-	 */
-	public Map<Integer, SceneGadget> gadgets;
+	public Map<Integer,SceneMonster> monsters; // <ConfigId, Monster>
+	public Map<Integer, SceneGadget> gadgets; // <ConfigId, Gadgets>
+	
 	public List<SceneTrigger> triggers;
 	public List<SceneRegion> regions;
 	public List<SceneSuite> suites;
+	public List<SceneVar> variables;
+	
+	public SceneBusiness business;
+	public SceneGarbage garbages;
 	public SceneInitConfig init_config;
 
-	public List<SceneVar> variables;
 	private transient boolean loaded; // Not an actual variable in the scripts either
+	private transient CompiledScript script;
 
 	public boolean isLoaded() {
 		return loaded;
@@ -49,8 +48,14 @@ public class SceneGroup {
 	public void setLoaded(boolean loaded) {
 		this.loaded = loaded;
 	}
-
-	private transient CompiledScript script; // Not an actual variable in the scripts either
+	
+	public int getBusinessType() {
+		return this.business == null ? 0 : this.business.type;
+	}
+	
+	public List<SceneGadget> getGarbageGadgets() {
+		return this.garbages == null ? null : this.garbages.gadgets;
+	}
 
 	public CompiledScript getScript() {
 		return script;
@@ -75,6 +80,7 @@ public class SceneGroup {
 		}
 
 		this.script = cs;
+		
 		// Eval script
 		try {
 			cs.eval(bindings);
@@ -90,15 +96,16 @@ public class SceneGroup {
 
 			triggers = ScriptLoader.getSerializer().toList(SceneTrigger.class, bindings.get("triggers"));
 			triggers.forEach(t -> t.currentGroup = this);
-
+			
 			suites = ScriptLoader.getSerializer().toList(SceneSuite.class, bindings.get("suites"));
 			regions = ScriptLoader.getSerializer().toList(SceneRegion.class, bindings.get("regions"));
+			garbages = ScriptLoader.getSerializer().toObject(SceneGarbage.class, bindings.get("garbages"));
 			init_config = ScriptLoader.getSerializer().toObject(SceneInitConfig.class, bindings.get("init_config"));
 
 			// Add variables to suite
 			variables = ScriptLoader.getSerializer().toList(SceneVar.class, bindings.get("variables"));
 
-			// Add monsters to suite
+			// Add monsters and gadgets to suite
 			for (SceneSuite suite : suites) {
 				suite.sceneMonsters = new ArrayList<>(
 						suite.monsters.stream()
@@ -118,6 +125,7 @@ public class SceneGroup {
 		} catch (ScriptException e) {
 			Grasscutter.getLogger().error("Error loading group " + id + " in scene " + sceneId, e);
 		}
+		
 		Grasscutter.getLogger().info("group {} in scene {} is loaded successfully.", id, sceneId);
 		return this;
 	}

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

 package emu.grasscutter.server.packet.send;
 
 import emu.grasscutter.game.entity.EntityGadget;
+import emu.grasscutter.game.entity.gadget.GadgetWorktop;
 import emu.grasscutter.net.packet.BasePacket;
 import emu.grasscutter.net.packet.PacketOpcodes;
 import emu.grasscutter.net.proto.WorktopOptionNotifyOuterClass.WorktopOptionNotify;
@@ -13,8 +14,8 @@ public class PacketWorktopOptionNotify extends BasePacket {
 		WorktopOptionNotify.Builder proto = WorktopOptionNotify.newBuilder()
 				.setGadgetEntityId(gadget.getId());
 		
-		if (gadget.getWorktopOptions() != null) {
-			proto.addAllOptionList(gadget.getWorktopOptions());
+		if (gadget.getContent() instanceof GadgetWorktop worktop) {
+			proto.addAllOptionList(worktop.getWorktopOptions());
 		}
 		
 		this.setData(proto);