Add serialization methods to SpawnerData classes

Author: Burbulinis

src/main/java/ch/njol/skript/classes/data/SkriptClasses.java

@@ -13,10 +13,7 @@
 import ch.njol.skript.lang.ParseContext;
 import ch.njol.skript.lang.function.DynamicFunctionReference;
 import ch.njol.skript.lang.util.SimpleLiteral;
-import ch.njol.skript.lang.util.common.AnyAmount;
-import ch.njol.skript.lang.util.common.AnyContains;
-import ch.njol.skript.lang.util.common.AnyNamed;
-import ch.njol.skript.lang.util.common.AnyValued;
+import ch.njol.skript.lang.util.common.*;
 import ch.njol.skript.localization.Noun;
 import ch.njol.skript.localization.RegexMessage;
 import ch.njol.skript.registrations.Classes;
@@ -964,6 +961,14 @@ public String toVariableNameString(DynamicFunctionReference<?> function) {
 				.examples("{a} contains {b}")
 				.since("2.10")
 		);
+
+		Classes.registerClass(new AnyInfo<>(AnyWeighted.class, "weighted")
+			.name("Any Weighted Thing")
+			.description("Something that has a weight.")
+			.usage("")
+			.examples("the weight of {spawner_entry}")
+			.since("INSERT VERSION")
+		);
 	}
 
 }

src/main/java/org/skriptlang/skript/bukkit/spawners/SpawnerModule.java

@@ -1,6 +1,5 @@
 package org.skriptlang.skript.bukkit.spawners;
 
-import ch.njol.skript.Skript;
 import ch.njol.skript.bukkitutil.EntityUtils;
 import ch.njol.skript.classes.*;
 import ch.njol.skript.entity.EntityData;
@@ -20,7 +19,6 @@
 import org.bukkit.event.entity.TrialSpawnerSpawnEvent;
 import org.bukkit.inventory.EquipmentSlot;
 import org.bukkit.loot.LootTable;
-import org.jetbrains.annotations.NotNull;
 import org.skriptlang.skript.addon.AddonModule;
 import org.skriptlang.skript.addon.SkriptAddon;
 import org.skriptlang.skript.bukkit.spawners.util.SkriptSpawnerEntry;
@@ -31,10 +29,7 @@
 import org.skriptlang.skript.bukkit.spawners.util.spawnerdata.SkriptMobSpawnerData;
 import org.skriptlang.skript.bukkit.spawners.util.spawnerdata.SkriptSpawnerData;
 import org.skriptlang.skript.bukkit.spawners.util.spawnerdata.SkriptTrialSpawnerData;
-import org.skriptlang.skript.lang.converter.Converter;
-import org.skriptlang.skript.lang.converter.Converters;
 
-import java.io.IOException;
 import java.io.StreamCorruptedException;
 import java.util.HashMap;
 import java.util.Map;
@@ -50,7 +45,6 @@ public void init(SkriptAddon addon) {
 			.name("Spawner Data")
 			.description("todo")
 			.since("INSERT VERSION")
-			.serializer(new YggdrasilSerializer<>())
 		);
 
 		Classes.registerClass(new ClassInfo<>(SkriptMobSpawnerData.class, "mobspawnerdata")
@@ -159,10 +153,8 @@ protected SkriptSpawnerEntry deserialize(Fields fields) throws StreamCorruptedEx
 
 					Map<EquipmentSlot, Float> dropChances = new HashMap<>();
 					int count = 0;
-					while (true) {
+					while (fields.contains("equipment_slot_" + count)) {
 						EquipmentSlot slot = fields.getObject("equipment_slot_" + count, EquipmentSlot.class);
-						if (slot == null)
-							break;
 						float chance = fields.getPrimitive("chance_" + count, float.class);
 						dropChances.put(slot, chance);
 						count++;
@@ -257,6 +249,16 @@ protected boolean canBeInstantiated() {
 		EventValues.registerEventValue(MobSpawnerDataEvent.class, SkriptMobSpawnerData.class, MobSpawnerDataEvent::getSpawnerData);
 		EventValues.registerEventValue(SpawnerEntryEvent.class, SkriptSpawnerEntry.class, SpawnerEntryEvent::getSpawnerEntry);
 		EventValues.registerEventValue(SpawnRuleEvent.class, SpawnRule.class, SpawnRuleEvent::getSpawnRule);
+
+		EventValues.registerEventValue(SpawnerSpawnEvent.class, Location.class, SpawnerSpawnEvent::getLocation);
+		EventValues.registerEventValue(SpawnerSpawnEvent.class, Entity.class, SpawnerSpawnEvent::getEntity);
+
+		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Block.class, event -> event.getTrialSpawner().getBlock());
+		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Location.class, TrialSpawnerSpawnEvent::getLocation);
+		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Entity.class, TrialSpawnerSpawnEvent::getEntity);
+
+		EventValues.registerEventValue(PreSpawnerSpawnEvent.class, EntityData.class,
+			event -> EntityUtils.toSkriptEntityData(event.getType()));
 	}
 
 	@Override
@@ -365,66 +367,6 @@ public String toVariableNameString(SpawnerEntry entry) {
 			})
 		);
 
-		Classes.registerClass(new ClassInfo<>(SpawnerEntryEquipment.class, "spawnerentryequipment")
-			.user("spawner ?entry ?equipments?")
-			.name("Spawner Entry Equipment")
-			.description(
-				"Represents a spawner entry equipment. Spawner entry equipments are used to specify the equipment "
-				+ "that an entity will spawn with. This includes the equipment loot table and the drop chances for each "
-				+ "equipment slot. You can find more information about this in the Minecraft wiki for "
-				+ "<a href='https://minecraft.wiki/w/Monster_Spawner'>spawners</a>")
-			.since("INSERT VERSION")
-			.requiredPlugins("MC 1.21+")
-			.parser(new Parser<>() {
-				@Override
-				public boolean canParse(ParseContext context) {
-					return false;
-				}
-
-				@Override
-				public String toString(SpawnerEntryEquipment equipment, int flags) {
-					return "spawner entry equipment with "
-						+ Classes.toString(equipment.getLootTable())
-						+ " and "
-						+ Classes.toString(equipment.getDropChances().toArray(), true);
-				}
-
-				@Override
-				public String toVariableNameString(SpawnerEntryEquipment equipment) {
-					return "spawner entry equipment:" + equipment.hashCode();
-				}
-			})
-		);
-
-		Classes.registerClass(new ClassInfo<>(DropChance.class, "equipmentdropchance")
-			.user("(spawner entry ?)?equipment ?drop ?chances?")
-			.name("Spawner Entry Equipment Drop Chance")
-			.description("Represents a spawner entry's equipment drop chance. This is used to specify the drop chance "
-				+ "for an equipment slot. You can find more information about this in the Minecraft wiki for "
-				+ "<a href='https://minecraft.wiki/w/Monster_Spawner'>spawners</a>")
-			.since("INSERT VERSION")
-			.requiredPlugins("MC 1.21+")
-			.parser(new Parser<>() {
-				@Override
-				public boolean canParse(ParseContext context) {
-					return false;
-				}
-
-				@Override
-				public String toString(DropChance equipment, int flags) {
-					return "equipment drop with chance "
-						+ equipment.getDropChance()
-						+ " for "
-						+ Classes.toString(equipment.getEquipmentSlot());
-				}
-
-				@Override
-				public String toVariableNameString(DropChance equipment) {
-					return "equipment drop:" + equipment.getEquipmentSlot() + ',' + equipment.getDropChance();
-				}
-			})
-		);
-
 		Classes.registerClass(new ClassInfo<>(SpawnRule.class, "spawnrule")
 			.user("spawn ?rules?")
 			.name("Spawn Rule")
@@ -496,70 +438,6 @@ protected boolean canBeInstantiated() {
 				}
 			})
 		);
-
-		Classes.registerClass(new AnyInfo<>(AnySpawnerWeighted.class, "spawnerweighted")
-				.user("spawner ?weighteds?")
-				.name("Any Spawner Weighted Thing")
-				.description("Something related to spawners that has a weight.")
-				.usage("")
-				.examples("the weight of {_spawner entry}", "the weight of {_weighted loot table}")
-				.since("INSERT VERSION")
-				.defaultExpression(new EventValueExpression<>(AnySpawnerWeighted.class))
-		);
-
-		//todo: remove after merge of equippable pr
-		Classes.registerClass(new EnumClassInfo<>(EquipmentSlot.class, "equipmentslot", "equipment slots")
-			.user("equipment slot")
-			.name("Equipment Slot")
-			.description("Represents an equipment slot.")
-			.since("INSERT VERSION")
-		);
-
-		ADDON = addon;
-		SYNTAX_REGISTRY = addon.syntaxRegistry();
-		try {
-			Skript.getAddonInstance().loadClasses(
-				"me.burb.skriptspawner.spawner",
-				"elements");
-		} catch (IOException e) {
-			throw new RuntimeException(e);
-		}
-
-		Converters.registerConverter(SpawnerEntry.class, AnySpawnerWeighted.class,
-			entry -> new AnySpawnerWeighted() {
-				@Override
-				public @NotNull Integer spawnerWeight() {
-					return entry.getSpawnWeight();
-				}
-
-				@Override
-				public boolean supportsSpawnerWeightChange() {
-					return true;
-				}
-
-				@Override
-				public void setSpawnerWeight(Integer weight) throws UnsupportedOperationException {
-					if (weight > 0)
-						entry.setSpawnWeight(weight);
-				}
-		}, Converter.NO_RIGHT_CHAINING);
-
-		EventValues.registerEventValue(SpawnerSpawnEvent.class, Block.class, event -> {
-			if (event.getSpawner() != null)
-				return event.getSpawner().getBlock();
-			return null;
-		});
-		EventValues.registerEventValue(SpawnerSpawnEvent.class, Location.class, SpawnerSpawnEvent::getLocation);
-		EventValues.registerEventValue(SpawnerSpawnEvent.class, Entity.class, SpawnerSpawnEvent::getEntity);
-
-		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Block.class, event -> event.getTrialSpawner().getBlock());
-		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Location.class, TrialSpawnerSpawnEvent::getLocation);
-		EventValues.registerEventValue(TrialSpawnerSpawnEvent.class, Entity.class, TrialSpawnerSpawnEvent::getEntity);
-
-		if (Skript.classExists("com.destroystokyo.paper.event.entity.PreSpawnerSpawnEvent")) {
-			EventValues.registerEventValue(PreSpawnerSpawnEvent.class, EntityData.class,
-				event -> EntityUtils.toSkriptEntityData(event.getType()));
-		}
 	}
 
 }

src/main/java/org/skriptlang/skript/bukkit/spawners/util/spawnerdata/SkriptMobSpawnerData.java

@@ -2,7 +2,8 @@
 
 import ch.njol.skript.util.Timespan;
 import ch.njol.skript.util.Timespan.TimePeriod;
-import ch.njol.yggdrasil.YggdrasilSerializable;
+import ch.njol.yggdrasil.Fields;
+import ch.njol.yggdrasil.YggdrasilSerializable.YggdrasilExtendedSerializable;
 import com.google.common.base.Preconditions;
 import org.bukkit.block.CreatureSpawner;
 import org.bukkit.entity.minecart.SpawnerMinecart;
@@ -11,6 +12,7 @@
 import org.skriptlang.skript.bukkit.spawners.util.SkriptSpawnerEntry;
 import org.skriptlang.skript.bukkit.spawners.util.SpawnerUtils;
 
+import java.io.StreamCorruptedException;
 import java.util.stream.Collectors;
 
 /**
@@ -19,11 +21,13 @@
  * @see SkriptTrialSpawnerData
  * @see SkriptSpawnerData
  */
-public class SkriptMobSpawnerData extends SkriptSpawnerData implements YggdrasilSerializable {
+public class SkriptMobSpawnerData extends SkriptSpawnerData implements YggdrasilExtendedSerializable {
 
 	private int maxNearbyEntityCap = SpawnerUtils.DEFAULT_MAX_NEARBY_ENTITIES;
 	private int spawnCount = SpawnerUtils.DEFAULT_SPAWN_COUNT;
 
+	public SkriptMobSpawnerData() {}
+
 	/**
 	 * Creates a new SkriptSpawnerData instance from the given Bukkit {@link Spawner}.
 	 * @param spawner the Bukkit spawner to convert
@@ -179,4 +183,26 @@ public void setSpawnCount(int spawnCount) {
 		this.spawnCount = spawnCount;
 	}
 
+	/*
+	 * YggdrasilExtendedSerializable
+	 */
+
+	@Override
+	public Fields serialize() {
+		Fields fields = super.serialize();
+
+		fields.putPrimitive("max_nearby_entity_cap", this.maxNearbyEntityCap);
+		fields.putPrimitive("spawn_count", this.spawnCount);
+
+		return fields;
+	}
+
+	@Override
+	public void deserialize(@NotNull Fields fields) throws StreamCorruptedException {
+		super.deserialize(fields);
+
+		this.maxNearbyEntityCap = fields.getPrimitive("max_nearby_entity_cap", int.class);
+		this.spawnCount = fields.getPrimitive("spawn_count", int.class);
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/spawners/util/spawnerdata/SkriptSpawnerData.java

@@ -1,22 +1,22 @@
 package org.skriptlang.skript.bukkit.spawners.util.spawnerdata;
 
 import ch.njol.skript.util.Timespan;
-import ch.njol.yggdrasil.YggdrasilSerializable;
+import ch.njol.yggdrasil.Fields;
 import com.google.common.base.Preconditions;
 import org.bukkit.spawner.BaseSpawner;
 import org.jetbrains.annotations.NotNull;
 import org.skriptlang.skript.bukkit.spawners.util.SkriptSpawnerEntry;
 import org.skriptlang.skript.bukkit.spawners.util.SpawnerUtils;
 
+import java.io.StreamCorruptedException;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
 
 /**
  * Abstract class representing the data of a trial spawner or a regular spawner.
  */
-public abstract class SkriptSpawnerData implements YggdrasilSerializable {
+public abstract class SkriptSpawnerData {
 
 	private int activationRange = SpawnerUtils.DEFAULT_ACTIVATION_RANGE;
 	private int spawnRange = SpawnerUtils.DEFAULT_SPAWN_RANGE;
@@ -254,4 +254,38 @@ public void clearSpawnerEntries() {
 		spawnerEntries.clear();
 	}
 
+	/*
+	 * Serialization
+	 */
+
+	protected Fields serialize() {
+		Fields fields = new Fields();
+		fields.putPrimitive("activation_range", this.activationRange);
+		fields.putPrimitive("spawn_range", this.spawnRange);
+		fields.putObject("min_spawn_delay", this.minSpawnDelay);
+		fields.putObject("max_spawn_delay", this.maxSpawnDelay);
+
+		int count = 0;
+		for (SkriptSpawnerEntry entry : this.spawnerEntries) {
+			fields.putObject("spawner_entry_" + count, entry);
+			count++;
+		}
+
+		return fields;
+	}
+
+	protected void deserialize(@NotNull Fields fields) throws StreamCorruptedException {
+		this.activationRange = fields.getPrimitive("activation_range", int.class);
+		this.spawnRange = fields.getPrimitive("spawn_range", int.class);
+
+		this.minSpawnDelay = fields.getObject("min_spawn_delay", Timespan.class);
+		this.maxSpawnDelay = fields.getObject("max_spawn_delay", Timespan.class);
+
+		int count = 0;
+		while (fields.contains("spawner_entry_" + count)) {
+			this.spawnerEntries.add(fields.getObject("spawner_entry_" + count, SkriptSpawnerEntry.class));
+			count++;
+		}
+	}
+
 }