Keep farmer golems from despawning after logout.
Set PersistenceRequired at spawn and every tick, and name farmers so vanilla will not despawn them while chunks are still ticking. Co-authored-by: Cursor <cursoragent@cursor.com>
@@ -1,4 +1,4 @@
1
# CopperFarmer 0.1.13
1
# CopperFarmer 0.1.14
2
2
3
3
First-version Paper 26.2 / Java 25 plugin for autonomous Copper Farmer Golems.
4
4
@@ -1,4 +1,4 @@1
# CopperFarmer 0.1.131
# CopperFarmer 0.1.142
2
3
First-version Paper 26.2 / Java 25 plugin for autonomous Copper Farmer Golems.3
First-version Paper 26.2 / Java 25 plugin for autonomous Copper Farmer Golems.4
4
@@ -1,4 +1,4 @@
1
# CopperFarmer 0.1.13 smoke test
1
# CopperFarmer 0.1.14 smoke test
2
2
3
3
Use this checklist on a Paper 26.2 server before treating 0.1.0 as production-ready.
4
4
@@ -1,4 +1,4 @@1
# CopperFarmer 0.1.13 smoke test1
# CopperFarmer 0.1.14 smoke test2
2
3
Use this checklist on a Paper 26.2 server before treating 0.1.0 as production-ready.3
Use this checklist on a Paper 26.2 server before treating 0.1.0 as production-ready.4
4
@@ -3,7 +3,7 @@ plugins {
3
3
}
4
4
5
5
group = "nl.timfalken"
6
version = "0.1.13"
6
version = "0.1.14"
7
7
8
8
repositories {
9
9
mavenCentral()
@@ -3,7 +3,7 @@ plugins {3
}3
}4
4
5
group = "nl.timfalken"5
group = "nl.timfalken"6
version = "0.1.13"6
version = "0.1.14"7
7
8
repositories {8
repositories {9
mavenCentral()9
mavenCentral()@@ -49,7 +49,7 @@ public final class CopperFarmerPlugin extends JavaPlugin {
49
49
long interval = Math.max(1L, getConfig().getLong("brain-tick-interval", 5L));
50
50
brainTask = getServer().getScheduler().runTaskTimer(this, () -> manager.tick(interval), interval, interval);
51
51
52
getLogger().info("CopperFarmer 0.1.13 enabled for Paper 26.2.");
52
getLogger().info("CopperFarmer 0.1.14 enabled for Paper 26.2.");
53
53
}
54
54
55
55
@Override
@@ -49,7 +49,7 @@ public final class CopperFarmerPlugin extends JavaPlugin {49
long interval = Math.max(1L, getConfig().getLong("brain-tick-interval", 5L));49
long interval = Math.max(1L, getConfig().getLong("brain-tick-interval", 5L));50
brainTask = getServer().getScheduler().runTaskTimer(this, () -> manager.tick(interval), interval, interval);50
brainTask = getServer().getScheduler().runTaskTimer(this, () -> manager.tick(interval), interval, interval);51
51
52
getLogger().info("CopperFarmer 0.1.13 enabled for Paper 26.2.");52
getLogger().info("CopperFarmer 0.1.14 enabled for Paper 26.2.");53
}53
}54
54
55
@Override55
@Override@@ -21,6 +21,8 @@ final class CopperGolemVanillaAi {
21
21
private static Method getBrain;
22
22
private static Method removeAllBehaviors;
23
23
private static Method clearMemories;
24
private static Method setPersistenceRequired;
25
private static boolean persistResolved;
24
26
private static boolean resolved;
25
27
private static boolean available = true;
26
28
private static boolean loggedFailure;
@@ -51,6 +53,24 @@ final class CopperGolemVanillaAi {
51
53
}
52
54
}
53
55
56
/**
57
* Bukkit-spawned mobs default to removeWhenFarAway. PersistenceRequired must be
58
* set on the NMS Mob as well; setPersistent() only controls chunk-save, not despawn.
59
*/
60
static void persist(CopperGolem golem) {
61
golem.setRemoveWhenFarAway(false);
62
golem.setPersistent(true);
63
try {
64
Object nms = handle(golem);
65
resolvePersistMethod(nms);
66
if (setPersistenceRequired != null) {
67
setPersistenceRequired.invoke(nms, true);
68
}
69
} catch (ReflectiveOperationException | RuntimeException ignored) {
70
// Bukkit flags above are still applied.
71
}
72
}
73
54
74
private static Object handle(CopperGolem golem) throws ReflectiveOperationException {
55
75
if (getHandle == null) {
56
76
getHandle = golem.getClass().getMethod("getHandle");
@@ -73,11 +93,25 @@ final class CopperGolemVanillaAi {
73
93
resolved = true;
74
94
}
75
95
76
private static Method findMethod(Class<?> type, String name) throws NoSuchMethodException {
96
private static void resolvePersistMethod(Object nms) {
97
if (persistResolved) return;
98
persistResolved = true;
99
try {
100
setPersistenceRequired = findMethod(nms.getClass(), "setPersistenceRequired", boolean.class);
101
} catch (NoSuchMethodException ignored) {
102
try {
103
setPersistenceRequired = findMethod(nms.getClass(), "setPersistent", boolean.class);
104
} catch (NoSuchMethodException ignoredToo) {
105
setPersistenceRequired = null;
106
}
107
}
108
}
109
110
private static Method findMethod(Class<?> type, String name, Class<?>... parameters) throws NoSuchMethodException {
77
111
Class<?> current = type;
78
112
while (current != null && current != Object.class) {
79
113
try {
80
Method method = current.getDeclaredMethod(name);
114
Method method = current.getDeclaredMethod(name, parameters);
81
115
method.setAccessible(true);
82
116
return method;
83
117
} catch (NoSuchMethodException ignored) {
@@ -21,6 +21,8 @@ final class CopperGolemVanillaAi {21
private static Method getBrain;21
private static Method getBrain;22
private static Method removeAllBehaviors;22
private static Method removeAllBehaviors;23
private static Method clearMemories;23
private static Method clearMemories;24
private static Method setPersistenceRequired;25
private static boolean persistResolved;24
private static boolean resolved;26
private static boolean resolved;25
private static boolean available = true;27
private static boolean available = true;26
private static boolean loggedFailure;28
private static boolean loggedFailure;@@ -51,6 +53,24 @@ final class CopperGolemVanillaAi {51
}53
}52
}54
}53
55
56
/**57
* Bukkit-spawned mobs default to removeWhenFarAway. PersistenceRequired must be58
* set on the NMS Mob as well; setPersistent() only controls chunk-save, not despawn.59
*/60
static void persist(CopperGolem golem) {61
golem.setRemoveWhenFarAway(false);62
golem.setPersistent(true);63
try {64
Object nms = handle(golem);65
resolvePersistMethod(nms);66
if (setPersistenceRequired != null) {67
setPersistenceRequired.invoke(nms, true);68
}69
} catch (ReflectiveOperationException | RuntimeException ignored) {70
// Bukkit flags above are still applied.71
}72
}73
54
private static Object handle(CopperGolem golem) throws ReflectiveOperationException {74
private static Object handle(CopperGolem golem) throws ReflectiveOperationException {55
if (getHandle == null) {75
if (getHandle == null) {56
getHandle = golem.getClass().getMethod("getHandle");76
getHandle = golem.getClass().getMethod("getHandle");@@ -73,11 +93,25 @@ final class CopperGolemVanillaAi {73
resolved = true;93
resolved = true;74
}94
}75
95
76
private static Method findMethod(Class<?> type, String name) throws NoSuchMethodException {96
private static void resolvePersistMethod(Object nms) {97
if (persistResolved) return;98
persistResolved = true;99
try {100
setPersistenceRequired = findMethod(nms.getClass(), "setPersistenceRequired", boolean.class);101
} catch (NoSuchMethodException ignored) {102
try {103
setPersistenceRequired = findMethod(nms.getClass(), "setPersistent", boolean.class);104
} catch (NoSuchMethodException ignoredToo) {105
setPersistenceRequired = null;106
}107
}108
}109
110
private static Method findMethod(Class<?> type, String name, Class<?>... parameters) throws NoSuchMethodException {77
Class<?> current = type;111
Class<?> current = type;78
while (current != null && current != Object.class) {112
while (current != null && current != Object.class) {79
try {113
try {80
Method method = current.getDeclaredMethod(name);114
Method method = current.getDeclaredMethod(name, parameters);81
method.setAccessible(true);115
method.setAccessible(true);82
return method;116
return method;83
} catch (NoSuchMethodException ignored) {117
} catch (NoSuchMethodException ignored) {@@ -18,6 +18,7 @@ import org.bukkit.event.block.CrafterCraftEvent;
18
18
import org.bukkit.event.entity.EntityChangeBlockEvent;
19
19
import org.bukkit.event.entity.EntityDeathEvent;
20
20
import org.bukkit.event.entity.EntityDropItemEvent;
21
import org.bukkit.event.entity.EntityRemoveEvent;
21
22
import org.bukkit.event.inventory.CraftItemEvent;
22
23
import org.bukkit.event.inventory.PrepareItemCraftEvent;
23
24
import org.bukkit.event.player.PlayerInteractEntityEvent;
@@ -109,6 +110,7 @@ final class FarmerListener implements Listener {
109
110
FarmerPersistence.stampEntity(pdc, keys);
110
111
snapshot.apply(pdc, keys);
111
112
variant.applyTo(entity);
113
FarmerManager.persistFarmer(entity);
112
114
});
113
115
manager.register(golem);
114
116
});
@@ -207,6 +209,19 @@ final class FarmerListener implements Listener {
207
209
}
208
210
}
209
211
212
@EventHandler(priority = EventPriority.MONITOR)
213
public void onFarmerRemoved(EntityRemoveEvent event) {
214
if (!manager.isFarmer(event.getEntity())) return;
215
EntityRemoveEvent.Cause cause = event.getCause();
216
if (cause == EntityRemoveEvent.Cause.UNLOAD
217
|| cause == EntityRemoveEvent.Cause.DEATH
218
|| cause == EntityRemoveEvent.Cause.TRANSFORMATION) {
219
return;
220
}
221
plugin.getLogger().warning("Farmer golem removed (" + cause + ") at "
222
+ formatLocation(event.getEntity().getLocation()));
223
}
224
210
225
@EventHandler(priority = EventPriority.HIGHEST)
211
226
public void onDeath(EntityDeathEvent event) {
212
227
if (!(event.getEntity() instanceof CopperGolem golem) || !manager.isFarmer(golem)) return;
@@ -310,6 +325,14 @@ final class FarmerListener implements Listener {
310
325
return item != null && !item.isEmpty() && item.getType() == Material.NAME_TAG;
311
326
}
312
327
328
private static String formatLocation(Location location) {
329
if (location == null || location.getWorld() == null) return "unknown";
330
return location.getWorld().getName()
331
+ " " + location.getBlockX()
332
+ "," + location.getBlockY()
333
+ "," + location.getBlockZ();
334
}
335
313
336
private boolean isFarmerRecipe(Recipe recipe) {
314
337
return recipe instanceof ShapelessRecipe shapeless && shapeless.getKey().equals(keys.recipe);
315
338
}
@@ -18,6 +18,7 @@ import org.bukkit.event.block.CrafterCraftEvent;18
import org.bukkit.event.entity.EntityChangeBlockEvent;18
import org.bukkit.event.entity.EntityChangeBlockEvent;19
import org.bukkit.event.entity.EntityDeathEvent;19
import org.bukkit.event.entity.EntityDeathEvent;20
import org.bukkit.event.entity.EntityDropItemEvent;20
import org.bukkit.event.entity.EntityDropItemEvent;21
import org.bukkit.event.entity.EntityRemoveEvent;21
import org.bukkit.event.inventory.CraftItemEvent;22
import org.bukkit.event.inventory.CraftItemEvent;22
import org.bukkit.event.inventory.PrepareItemCraftEvent;23
import org.bukkit.event.inventory.PrepareItemCraftEvent;23
import org.bukkit.event.player.PlayerInteractEntityEvent;24
import org.bukkit.event.player.PlayerInteractEntityEvent;@@ -109,6 +110,7 @@ final class FarmerListener implements Listener {109
FarmerPersistence.stampEntity(pdc, keys);110
FarmerPersistence.stampEntity(pdc, keys);110
snapshot.apply(pdc, keys);111
snapshot.apply(pdc, keys);111
variant.applyTo(entity);112
variant.applyTo(entity);113
FarmerManager.persistFarmer(entity);112
});114
});113
manager.register(golem);115
manager.register(golem);114
});116
});@@ -207,6 +209,19 @@ final class FarmerListener implements Listener {207
}209
}208
}210
}209
211
212
@EventHandler(priority = EventPriority.MONITOR)213
public void onFarmerRemoved(EntityRemoveEvent event) {214
if (!manager.isFarmer(event.getEntity())) return;215
EntityRemoveEvent.Cause cause = event.getCause();216
if (cause == EntityRemoveEvent.Cause.UNLOAD217
|| cause == EntityRemoveEvent.Cause.DEATH218
|| cause == EntityRemoveEvent.Cause.TRANSFORMATION) {219
return;220
}221
plugin.getLogger().warning("Farmer golem removed (" + cause + ") at "222
+ formatLocation(event.getEntity().getLocation()));223
}224
210
@EventHandler(priority = EventPriority.HIGHEST)225
@EventHandler(priority = EventPriority.HIGHEST)211
public void onDeath(EntityDeathEvent event) {226
public void onDeath(EntityDeathEvent event) {212
if (!(event.getEntity() instanceof CopperGolem golem) || !manager.isFarmer(golem)) return;227
if (!(event.getEntity() instanceof CopperGolem golem) || !manager.isFarmer(golem)) return;@@ -310,6 +325,14 @@ final class FarmerListener implements Listener {310
return item != null && !item.isEmpty() && item.getType() == Material.NAME_TAG;325
return item != null && !item.isEmpty() && item.getType() == Material.NAME_TAG;311
}326
}312
327
328
private static String formatLocation(Location location) {329
if (location == null || location.getWorld() == null) return "unknown";330
return location.getWorld().getName()331
+ " " + location.getBlockX()332
+ "," + location.getBlockY()333
+ "," + location.getBlockZ();334
}335
313
private boolean isFarmerRecipe(Recipe recipe) {336
private boolean isFarmerRecipe(Recipe recipe) {314
return recipe instanceof ShapelessRecipe shapeless && shapeless.getKey().equals(keys.recipe);337
return recipe instanceof ShapelessRecipe shapeless && shapeless.getKey().equals(keys.recipe);315
}338
}@@ -25,6 +25,7 @@ import org.bukkit.block.data.type.Gate;
25
25
import org.bukkit.entity.CopperGolem;
26
26
import org.bukkit.entity.Entity;
27
27
import org.bukkit.entity.Player;
28
import net.kyori.adventure.text.Component;
28
29
import org.bukkit.inventory.EntityEquipment;
29
30
import org.bukkit.inventory.EquipmentSlot;
30
31
import org.bukkit.inventory.Inventory;
@@ -144,10 +145,7 @@ final class FarmerManager {
144
145
CopperGolemVanillaAi.suppress(golem, plugin);
145
146
golem.setAI(true);
146
147
golem.setAware(true);
147
// Bukkit-spawned mobs often keep removeWhenFarAway=true, so they can vanish
148
// while chunks stay loaded with no nearby player. Farmers must never do that.
149
golem.setRemoveWhenFarAway(false);
150
golem.setPersistent(true);
148
persistFarmer(golem);
151
149
golem.setCanPickupItems(false);
152
150
golem.getPathfinder().setCanFloat(true);
153
151
golem.getPathfinder().setCanPassDoors(true);
@@ -156,9 +154,18 @@ final class FarmerManager {
156
154
if (followRange != null) followRange.setBaseValue(pathfindingRange);
157
155
golem.setGolemState(CopperGolem.State.IDLE);
158
156
if (preventOxidation) golem.setOxidizing(CopperGolem.Oxidizing.waxed());
157
persistFarmer(golem);
159
158
equipHand(golem, itemCodec.readTool(golem), false);
160
159
}
161
160
161
static void persistFarmer(CopperGolem golem) {
162
CopperGolemVanillaAi.persist(golem);
163
if (golem.customName() == null) {
164
golem.customName(Component.text("Copper Farmer Golem"));
165
golem.setCustomNameVisible(false);
166
}
167
}
168
162
169
void resyncHeldItem(CopperGolem golem, Player viewer) {
163
170
ItemStack shown = heldAppearance(golem);
164
171
viewer.sendEquipmentChange(golem, EquipmentSlot.HAND, shown);
@@ -269,6 +276,7 @@ final class FarmerManager {
269
276
if (preventOxidation && golem.getOxidizing() != CopperGolem.Oxidizing.waxed()) {
270
277
golem.setOxidizing(CopperGolem.Oxidizing.waxed());
271
278
}
279
persistFarmer(golem);
272
280
cleanupCooldowns();
273
281
tickDoors();
274
282
@@ -25,6 +25,7 @@ import org.bukkit.block.data.type.Gate;25
import org.bukkit.entity.CopperGolem;25
import org.bukkit.entity.CopperGolem;26
import org.bukkit.entity.Entity;26
import org.bukkit.entity.Entity;27
import org.bukkit.entity.Player;27
import org.bukkit.entity.Player;28
import net.kyori.adventure.text.Component;28
import org.bukkit.inventory.EntityEquipment;29
import org.bukkit.inventory.EntityEquipment;29
import org.bukkit.inventory.EquipmentSlot;30
import org.bukkit.inventory.EquipmentSlot;30
import org.bukkit.inventory.Inventory;31
import org.bukkit.inventory.Inventory;@@ -144,10 +145,7 @@ final class FarmerManager {144
CopperGolemVanillaAi.suppress(golem, plugin);145
CopperGolemVanillaAi.suppress(golem, plugin);145
golem.setAI(true);146
golem.setAI(true);146
golem.setAware(true);147
golem.setAware(true);147
// Bukkit-spawned mobs often keep removeWhenFarAway=true, so they can vanish148
persistFarmer(golem);148
// while chunks stay loaded with no nearby player. Farmers must never do that.149
golem.setRemoveWhenFarAway(false);150
golem.setPersistent(true);151
golem.setCanPickupItems(false);149
golem.setCanPickupItems(false);152
golem.getPathfinder().setCanFloat(true);150
golem.getPathfinder().setCanFloat(true);153
golem.getPathfinder().setCanPassDoors(true);151
golem.getPathfinder().setCanPassDoors(true);@@ -156,9 +154,18 @@ final class FarmerManager {156
if (followRange != null) followRange.setBaseValue(pathfindingRange);154
if (followRange != null) followRange.setBaseValue(pathfindingRange);157
golem.setGolemState(CopperGolem.State.IDLE);155
golem.setGolemState(CopperGolem.State.IDLE);158
if (preventOxidation) golem.setOxidizing(CopperGolem.Oxidizing.waxed());156
if (preventOxidation) golem.setOxidizing(CopperGolem.Oxidizing.waxed());157
persistFarmer(golem);159
equipHand(golem, itemCodec.readTool(golem), false);158
equipHand(golem, itemCodec.readTool(golem), false);160
}159
}161
160
161
static void persistFarmer(CopperGolem golem) {162
CopperGolemVanillaAi.persist(golem);163
if (golem.customName() == null) {164
golem.customName(Component.text("Copper Farmer Golem"));165
golem.setCustomNameVisible(false);166
}167
}168
162
void resyncHeldItem(CopperGolem golem, Player viewer) {169
void resyncHeldItem(CopperGolem golem, Player viewer) {163
ItemStack shown = heldAppearance(golem);170
ItemStack shown = heldAppearance(golem);164
viewer.sendEquipmentChange(golem, EquipmentSlot.HAND, shown);171
viewer.sendEquipmentChange(golem, EquipmentSlot.HAND, shown);@@ -269,6 +276,7 @@ final class FarmerManager {269
if (preventOxidation && golem.getOxidizing() != CopperGolem.Oxidizing.waxed()) {276
if (preventOxidation && golem.getOxidizing() != CopperGolem.Oxidizing.waxed()) {270
golem.setOxidizing(CopperGolem.Oxidizing.waxed());277
golem.setOxidizing(CopperGolem.Oxidizing.waxed());271
}278
}279
persistFarmer(golem);272
cleanupCooldowns();280
cleanupCooldowns();273
tickDoors();281
tickDoors();274
282
@@ -1,5 +1,5 @@
1
1
name: CopperFarmer
2
version: 0.1.13
2
version: 0.1.14
3
3
main: nl.timfalken.copperfarmer.CopperFarmerPlugin
4
4
api-version: '26.2'
5
5
author: Tim Falken
@@ -1,5 +1,5 @@1
name: CopperFarmer1
name: CopperFarmer2
version: 0.1.132
version: 0.1.143
main: nl.timfalken.copperfarmer.CopperFarmerPlugin3
main: nl.timfalken.copperfarmer.CopperFarmerPlugin4
api-version: '26.2'4
api-version: '26.2'5
author: Tim Falken5
author: Tim Falken