-
-
Notifications
You must be signed in to change notification settings - Fork 141
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Merge pull request #2575 from BentoBoxWorld/2569_znpc_plus_hook
2569 znpc plus hook
Showing
12 changed files
with
486 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
src/main/java/world/bentobox/bentobox/hooks/ZNPCsPlusHook.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| package world.bentobox.bentobox.hooks; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import org.bukkit.Location; | ||
| import org.bukkit.Material; | ||
| import org.bukkit.World; | ||
| import org.bukkit.configuration.InvalidConfigurationException; | ||
| import org.bukkit.configuration.file.YamlConfiguration; | ||
| import org.bukkit.util.Vector; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
|
|
||
| import lol.pyr.znpcsplus.api.NpcApiProvider; | ||
| import lol.pyr.znpcsplus.api.npc.NpcEntry; | ||
| import lol.pyr.znpcsplus.util.NpcLocation; | ||
| import world.bentobox.bentobox.BentoBox; | ||
| import world.bentobox.bentobox.api.hooks.Hook; | ||
| import world.bentobox.bentobox.blueprints.dataobjects.BlueprintEntity; | ||
| import world.bentobox.bentobox.util.Util; | ||
|
|
||
| /** | ||
| * Provides copy and pasting of ZNPCS Plus in blueprints https://github.com/Pyrbu/ZNPCsPlus | ||
| * | ||
| * @author tastybento | ||
| * @since 3.2.0 | ||
| */ | ||
| public class ZNPCsPlusHook extends Hook { | ||
|
|
||
| private static final String VERSION = "2.0.0-SNAPSHOT"; // Minimum version required | ||
|
|
||
| public ZNPCsPlusHook() { | ||
| super("ZNPCsPlus", Material.PLAYER_HEAD); | ||
| } | ||
|
|
||
| public String serializeNPC(NpcEntry entry, Vector origin) { | ||
| String result = NpcApiProvider.get().getNpcSerializerRegistry().getSerializer(YamlConfiguration.class) | ||
| .serialize(entry) | ||
| .saveToString(); | ||
| return result; | ||
| } | ||
|
|
||
| public boolean spawnNpc(String yaml, Location pos) throws InvalidConfigurationException { | ||
| YamlConfiguration yaml2 = new YamlConfiguration(); | ||
| yaml2.loadFromString(yaml); | ||
| NpcEntry entry = NpcApiProvider.get().getNpcSerializerRegistry().getSerializer(YamlConfiguration.class) | ||
| .deserialize(yaml2); | ||
| NpcLocation loc = new NpcLocation(pos); | ||
| entry.getNpc().setLocation(loc); | ||
| NpcApiProvider.get().getNpcRegistry().register(entry); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean hook() { | ||
| boolean hooked = this.isPluginAvailable(); | ||
| // Check version | ||
| String version = this.getPlugin().getDescription().getVersion(); | ||
| if (!Util.isVersionCompatible(version, VERSION)) { | ||
| return false; | ||
| } | ||
| if (!hooked) { | ||
| BentoBox.getInstance().logError("Could not hook into FancyNpcs"); | ||
| } | ||
| return hooked; | ||
| } | ||
|
|
||
| @Override | ||
| public String getFailureCause() { | ||
| // The only failure is wrong version | ||
| return "ZNPCsPlus version " + VERSION + " required or later. You are running " | ||
| + this.getPlugin().getDescription().getVersion(); | ||
| } | ||
|
|
||
| public Map<? extends Vector, ? extends List<BlueprintEntity>> getNpcsInArea(World world, List<Vector> vectorsToCopy, | ||
| @Nullable Vector origin) { | ||
| Map<Vector, List<BlueprintEntity>> bpEntities = new HashMap<>(); | ||
|
|
||
| for (NpcEntry npcEntry : NpcApiProvider.get().getNpcRegistry().getAll()) { | ||
| NpcLocation npcLocation = npcEntry.getNpc().getLocation(); | ||
| Vector loc = new Vector(npcLocation.getBlockX(), npcLocation.getBlockY(), npcLocation.getBlockZ()); | ||
| if (npcEntry.getNpc().getWorld().equals(world) && vectorsToCopy.contains(loc)) { | ||
| // Put the NPC into a BlueprintEntity - serialize it | ||
| BlueprintEntity cit = new BlueprintEntity(); | ||
| cit.setNpc(this.serializeNPC(npcEntry, origin)); | ||
| // Retrieve or create the list of entities and add this one | ||
| List<BlueprintEntity> entities = bpEntities.getOrDefault(loc, new ArrayList<>()); | ||
| entities.add(cit); | ||
| // Create the position where this entity will be pasted relative to the location | ||
| Vector origin2 = origin == null ? new Vector(0, 0, 0) : origin; | ||
| int x = loc.getBlockX() - origin2.getBlockX(); | ||
| int y = loc.getBlockY() - origin2.getBlockY(); | ||
| int z = loc.getBlockZ() - origin2.getBlockZ(); | ||
| Vector pos = new Vector(x, y, z); | ||
| // Store | ||
| bpEntities.put(pos, entities); // Update the map | ||
| } | ||
| } | ||
| return bpEntities; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
174 changes: 174 additions & 0 deletions
174
src/test/java/world/bentobox/bentobox/hooks/ZNPCsPlusHookTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| package world.bentobox.bentobox.hooks; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertFalse; | ||
| import static org.junit.Assert.assertNotNull; | ||
| import static org.junit.Assert.assertTrue; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.bukkit.Bukkit; | ||
| import org.bukkit.Location; | ||
| import org.bukkit.Material; | ||
| import org.bukkit.World; | ||
| import org.bukkit.configuration.InvalidConfigurationException; | ||
| import org.bukkit.configuration.file.YamlConfiguration; | ||
| import org.bukkit.plugin.Plugin; | ||
| import org.bukkit.plugin.PluginDescriptionFile; | ||
| import org.bukkit.plugin.PluginManager; | ||
| import org.bukkit.util.Vector; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.Mockito; | ||
| import org.powermock.api.mockito.PowerMockito; | ||
| import org.powermock.core.classloader.annotations.PrepareForTest; | ||
| import org.powermock.modules.junit4.PowerMockRunner; | ||
| import org.powermock.reflect.Whitebox; | ||
|
|
||
| import lol.pyr.znpcsplus.api.NpcApi; | ||
| import lol.pyr.znpcsplus.api.NpcApiProvider; | ||
| import lol.pyr.znpcsplus.api.npc.Npc; | ||
| import lol.pyr.znpcsplus.api.npc.NpcEntry; | ||
| import lol.pyr.znpcsplus.api.npc.NpcRegistry; | ||
| import lol.pyr.znpcsplus.api.serialization.NpcSerializer; | ||
| import lol.pyr.znpcsplus.api.serialization.NpcSerializerRegistry; | ||
| import lol.pyr.znpcsplus.util.NpcLocation; | ||
| import world.bentobox.bentobox.BentoBox; | ||
|
|
||
| @RunWith(PowerMockRunner.class) | ||
| @PrepareForTest({ BentoBox.class, Bukkit.class, NpcApiProvider.class }) | ||
| public class ZNPCsPlusHookTest { | ||
|
|
||
| @Mock | ||
| private BentoBox plugin; | ||
| @Mock | ||
| private PluginManager pim; | ||
| @Mock | ||
| private Plugin mythicMobs; | ||
| @Mock | ||
| private Location location; | ||
| @Mock | ||
| private World world; | ||
| @Mock | ||
| private Plugin npcPlugin; | ||
| private ZNPCsPlusHook hook; | ||
| @Mock | ||
| private NpcEntry entry; | ||
| @Mock | ||
| private NpcApi npcApi; | ||
| @Mock | ||
| private NpcSerializerRegistry npcSerReg; | ||
| @Mock | ||
| private NpcSerializer<Object> ser; | ||
| @Mock | ||
| private NpcRegistry registry; | ||
| @Mock | ||
| private Npc npc; | ||
| @Mock | ||
| private NpcLocation npcLoc; | ||
|
|
||
| /** | ||
| * @throws java.lang.Exception | ||
| */ | ||
| @Before | ||
| public void setUp() throws Exception { | ||
| // Set up plugin | ||
| plugin = mock(BentoBox.class); | ||
| Whitebox.setInternalState(BentoBox.class, "instance", plugin); | ||
| // Bukkit | ||
| PowerMockito.mockStatic(Bukkit.class, Mockito.RETURNS_MOCKS); | ||
| when(Bukkit.getPluginManager()).thenReturn(pim); | ||
| when(npcPlugin.getDescription()).thenReturn(new PluginDescriptionFile("ZNPCsPlus", "2.0.0-SNAPSHOT", "main")); | ||
| when(pim.getPlugin("ZNPCsPlus")).thenReturn(npcPlugin); | ||
| // Location | ||
| when(world.getName()).thenReturn("bskyblock"); | ||
| when(location.getWorld()).thenReturn(world); | ||
| // NpcApiProvider | ||
| PowerMockito.mockStatic(NpcApiProvider.class, Mockito.RETURNS_MOCKS); | ||
| when(NpcApiProvider.get()).thenReturn(npcApi); | ||
|
|
||
| when(registry.getAll()).thenAnswer(invocation -> List.of(entry)); | ||
|
|
||
| when(npcLoc.getBlockX()).thenReturn(0); | ||
| when(npcLoc.getBlockY()).thenReturn(0); | ||
| when(npcLoc.getBlockZ()).thenReturn(0); | ||
| when(npc.getWorld()).thenReturn(world); | ||
|
|
||
| when(npc.getLocation()).thenReturn(npcLoc); | ||
|
|
||
| when(npcApi.getNpcRegistry()).thenReturn(registry); | ||
| when(npcApi.getNpcSerializerRegistry()).thenReturn(npcSerReg); | ||
| when(npcSerReg.getSerializer(any())).thenReturn(ser); | ||
| YamlConfiguration yaml = new YamlConfiguration(); | ||
| yaml.set("test", "test"); | ||
| when(ser.serialize(any())).thenReturn(yaml); | ||
| when(entry.getNpc()).thenReturn(npc); | ||
| when(ser.deserialize(any())).thenReturn(entry); | ||
|
|
||
|
|
||
| hook = new ZNPCsPlusHook(); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#hook()}. | ||
| */ | ||
| @Test | ||
| public void testHook() { | ||
| // Not hooked | ||
| assertFalse(hook.hook()); | ||
| } | ||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#getFailureCause()}. | ||
| */ | ||
| @Test | ||
| public void testGetFailureCause() { | ||
| when(npcPlugin.getDescription()).thenReturn(new PluginDescriptionFile("ZNPCsPlus", "1.0.0", "main")); | ||
| assertEquals("ZNPCsPlus version 2.0.0-SNAPSHOT required or later. You are running 1.0.0", | ||
| hook.getFailureCause()); | ||
| } | ||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#ZNPCsPlusHook()}. | ||
| */ | ||
| @Test | ||
| public void testZNPCsPlusHook() { | ||
| assertNotNull(hook); | ||
| assertEquals(Material.PLAYER_HEAD, hook.getIcon()); | ||
| } | ||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#serializeNPC(lol.pyr.znpcsplus.api.npc.NpcEntry, org.bukkit.util.Vector)}. | ||
| */ | ||
| @Test | ||
| public void testSerializeNPC() { | ||
| assertEquals("test: test\n", hook.serializeNPC(entry, new Vector(1, 1, 1))); | ||
| } | ||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#spawnNpc(java.lang.String, org.bukkit.Location)}. | ||
| */ | ||
| @Test | ||
| public void testSpawnNpc() { | ||
| try { | ||
| assertTrue(hook.spawnNpc("", location)); | ||
| } catch (InvalidConfigurationException e) { | ||
| e.printStackTrace(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Test method for {@link world.bentobox.bentobox.hooks.ZNPCsPlusHook#getNpcsInArea(org.bukkit.World, java.util.List, org.bukkit.util.Vector)}. | ||
| */ | ||
| @Test | ||
| public void testGetNpcsInArea() { | ||
| hook.getNpcsInArea(world, List.of(new Vector(0, 0, 0)), new Vector(0, 0, 0)); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters