made whenInside locations work (#426)

Co-authored-by: Michael Vorburger ⛑️ <[email protected]>

Author: edewit

api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/EventsImpl.java

@@ -86,6 +86,16 @@ class EventsImpl implements Events, Unregisterable {
         }));
     }
 
+    @Override public void whenInside(String locationName, Callback callback) {
+        unregistrables.add(eventService.registerInsideLocation(locationName, player -> {
+            try {
+                invokeCallback(player, callback);
+            } catch (Exception e) {
+                LOG.error("whenInside() callback failure", e);
+            }
+        }));
+    }
+
     @Override public void whenEntityRightClicked(String entityName, Callback callback) {
         ch.vorburger.minecraft.storeys.japi.impl.events.Callback otherCallback = invoker -> {
             invokeCallback(invoker, callback);

api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/events/EventService.java

@@ -19,6 +19,7 @@
 package ch.vorburger.minecraft.storeys.japi.impl.events;
 
 import ch.vorburger.minecraft.osgi.api.PluginInstance;
+import ch.vorburger.minecraft.storeys.japi.PlayerInsideEvent;
 import ch.vorburger.minecraft.storeys.japi.impl.Unregisterable;
 import java.util.Collection;
 import java.util.Collections;
@@ -39,12 +40,13 @@
 import org.spongepowered.api.event.network.ClientConnectionEvent.Join;
 import org.spongepowered.api.text.Text;
 
-@Singleton
-public class EventService implements AutoCloseable {
+@Singleton public class EventService implements AutoCloseable {
 
     private static final Logger LOG = LoggerFactory.getLogger(EventService.class);
 
     private final Collection<Callback> onPlayerJoinCallbacks = new ConcurrentLinkedQueue<>();
+
+    private final Map<String, Collection<Callback>> onPlayerInsideCallbacks = new ConcurrentHashMap<>();
     private final Map<String, Collection<Callback>> onInteractEntityEventCallbacks = new ConcurrentHashMap<>();
 
     private final EventManager eventManager;
@@ -68,10 +70,28 @@ public void setPluginInstance(PluginInstance plugin) {
         }
     }
 
+    @Listener public void onInsideLocation(PlayerInsideEvent event) throws Exception {
+        final String locationName = event.getLocationName();
+        Collection<Callback> callbacks = onPlayerInsideCallbacks.get(locationName);
+        if (callbacks != null) {
+            for (Callback callback : callbacks) {
+                callback.call(event.getEffectedPlayer());
+            }
+        } else {
+            LOG.warn("Unknown Location: {}", locationName);
+        }
+    }
+
     public Unregisterable registerPlayerJoin(Callback callback) {
         return add(onPlayerJoinCallbacks, callback);
     }
 
+    public Unregisterable registerInsideLocation(String locationName, Callback callback) {
+        Collection<Callback> callbacks = onPlayerInsideCallbacks.computeIfAbsent(locationName,
+                name -> new ConcurrentLinkedQueue<>());
+        return add(callbacks, callback);
+    }
+
     public Unregisterable registerInteractEntity(String entityName, Callback callback) {
         Collection<Callback> callbacks = onInteractEntityEventCallbacks.computeIfAbsent(entityName, name -> new ConcurrentLinkedQueue<>());
         return add(callbacks, callback);

api-jvm/src/main/java/ch/vorburger/minecraft/storeys/japi/Events.java

@@ -27,4 +27,5 @@ public interface Events {
 
     void whenPlayerJoins(Callback callback);
 
+    void whenInside(String locationName, Callback callback);
 }

api-jvm/src/main/java/ch/vorburger/minecraft/storeys/japi/PlayerInsideEvent.java

@@ -0,0 +1,61 @@
+/*
+ * ch.vorburger.minecraft.storeys
+ *
+ * Copyright (C) 2016 - 2018 Michael Vorburger.ch <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package ch.vorburger.minecraft.storeys.japi;
+
+import org.spongepowered.api.entity.living.player.Player;
+import org.spongepowered.api.event.Cancellable;
+import org.spongepowered.api.event.cause.Cause;
+import org.spongepowered.api.event.impl.AbstractEvent;
+
+public class PlayerInsideEvent extends AbstractEvent implements Cancellable {
+    private final Player player;
+    private final Cause cause;
+    private final String locationName;
+    private boolean cancelled = false;
+
+    public PlayerInsideEvent(Player player, String locationName, Cause cause) {
+        this.player = player;
+        this.locationName = locationName;
+        this.cause = cause;
+    }
+
+    @Override public Cause getCause() {
+        return cause;
+    }
+
+    @Override public boolean isCancelled() {
+        return cancelled;
+    }
+
+    @Override public void setCancelled(boolean cancel) {
+        this.cancelled = cancel;
+    }
+
+    public Player getEffectedPlayer() {
+        return this.player;
+    }
+
+    public String getLocationName() {
+        return locationName;
+    }
+
+    @Override public String toString() {
+        return "PlayerInsideEvent{" + "player=" + player + ", locationName='" + locationName + '\'' + '}';
+    }
+}

docs/testing.md

@@ -22,9 +22,13 @@ Now test that you can make a new project:
 1. Add
    * Events > When / `demo`
    * Actions > Title `Hello!`
-   * Actions > `Piggy` speaks `Hello!`
-1. Click _upload code_ button _(TODO perhaps we could auto-save, later?)_
+   * Actions > `Piggy` speaks `Hello!` 
 1. `/demo` command in Minecraft should now make the entity _Piggy_ speak
+1. Drag a whenInside block and add a name of the region `trigger`
+   * Your player will get a special axe to "draw" the region with
+     * Use left mouse to set the first point of a box
+     * Right mouse to set the second point of a box
+   * Now any time a player enters the block beneath will be executed
 
 _TODO Update the following, after Blockly will be made to reload previous projects?_
 
@@ -43,6 +47,7 @@ _TODO Update the following, after Blockly will be made to reload previous projec
 
 1. `/new`
 1. Verify [`test.js`](../minecraft-server-test-data/config/storeys-web/new-scripts/test.js) happened as expected
+1. _TODO Walk to the cacti and jump on top and make sure a "you jumped!" is shown as title
 1. Edit `test.js` to change `m.title("Hello");` to `m.title("hello, world");`
 1. `/new`
 1. Verify title shown changed

minecraft-server-test-data/config/storeys-web.conf

@@ -0,0 +1,15 @@
+locations=[
+    {
+        hitbox {
+            worldName=world
+            x1=229
+            x2=227
+            y1=65
+            y2=64
+            z1=215
+            z2=217
+        }
+        name=box
+        player=fb79c1a9-72bd-34dc-9775-c2ac868d7ccf
+    }
+]

minecraft-server-test-data/config/storeys-web/new-scripts/test.js

@@ -6,3 +6,8 @@ e.whenCommand("new", function callback(m) {
       m.cmd("/say Go fishing with the rod in your inventory..");
    }
 });
+
+// box is the location on top of the bushes
+e.whenInside("box", function(m) {
+  m.title('you jumped!');
+});

test-mineflayer/storeys.test.js

@@ -22,7 +22,7 @@ describe("Storeys plugin test", () => {
     // then
     bot.on('messagestr', (msg, _, json) => {
       if (msg !== "Player joined the game") {
-        expect(msg).to.equal("Click here to open Scratch and MAKE actions");
+        expect(msg).to.equal("Click here to open a browser and start MAKE actions");
         done();
       }
     });

web/src/main/java/ch/vorburger/minecraft/storeys/web/LocationToolListener.java

@@ -22,6 +22,7 @@
 import ch.vorburger.minecraft.storeys.events.Condition;
 import ch.vorburger.minecraft.storeys.events.ConditionService;
 import ch.vorburger.minecraft.storeys.events.LocatableInBoxCondition;
+import ch.vorburger.minecraft.storeys.japi.PlayerInsideEvent;
 import ch.vorburger.minecraft.storeys.japi.impl.Unregisterable;
 import ch.vorburger.minecraft.storeys.model.LocationToolAction;
 import ch.vorburger.minecraft.storeys.web.location.LocationHitBox;
@@ -51,25 +52,33 @@
 import org.spongepowered.api.event.EventManager;
 import org.spongepowered.api.event.Listener;
 import org.spongepowered.api.event.block.InteractBlockEvent;
+import org.spongepowered.api.event.cause.Cause;
+import org.spongepowered.api.event.cause.EventContext;
 import org.spongepowered.api.event.cause.EventContextKeys;
 import org.spongepowered.api.event.game.state.GameStoppingServerEvent;
 import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 import org.spongepowered.api.text.Text;
 import org.spongepowered.api.world.Location;
 import org.spongepowered.api.world.World;
 
-@Singleton
-public class LocationToolListener {
+@Singleton public class LocationToolListener {
     private static final Logger LOG = LoggerFactory.getLogger(LocationToolListener.class);
     private final Map<String, Pair<Location<World>, Location<World>>> playerBoxLocations = new ConcurrentHashMap<>();
     private final Map<String, Unregisterable> conditionRegistrations = new ConcurrentHashMap<>();
     private final ConditionService conditionService;
     private final ConfigurationLoader<CommentedConfigurationNode> configurationLoader;
 
+    private final EventContext eventContext;
+    private EventManager eventManager;
+    private final PluginInstance plugin;
+
     @Inject public LocationToolListener(PluginInstance plugin, EventManager eventManager, ConditionService conditionService,
             ConfigurationLoader<CommentedConfigurationNode> loader) {
         TypeSerializerCollection.defaults().register(LocationPairSerializer.TYPE, new LocationPairSerializer());
         eventManager.registerListeners(plugin, this);
+        this.eventManager = eventManager;
+        this.plugin = plugin;
+        this.eventContext = EventContext.builder().add(EventContextKeys.PLUGIN, plugin.getPluginContainer()).build();
         this.conditionService = conditionService;
         configurationLoader = loader;
 
@@ -131,9 +140,9 @@ private void registerCondition(UUID player, String locationName, Pair<Location<W
         if (unregisterable != null) {
             unregisterable.unregister();
         }
-        ConditionService.ConditionServiceRegistration registration = conditionService.register(condition,
-                // TODO properly implement full support for this old feature in the new api-jvm
-                (Player p) -> LOG.warn("TODO inform the player that someone was inside the region {}", p));
+        ConditionService.ConditionServiceRegistration registration = conditionService.register(condition, (p) -> {
+            eventManager.post(new PlayerInsideEvent(p, locationName, Cause.of(eventContext, plugin)));
+        });
         conditionRegistrations.put(name, registration);
     }
 

web/src/main/java/ch/vorburger/minecraft/storeys/web/LoginCommand.java

@@ -63,7 +63,7 @@ private String getSystemPropertyEnvVarOrDefault(String propertyName, String defa
     }
 
     @Override public CommandCallable callable() {
-        return CommandSpec.builder().description(Text.of("Login into ScratchX web interface")) // .permission("storeys.command.make")
+        return CommandSpec.builder().description(Text.of("Open the browser and start your story")) // .permission("storeys.command.make")
                 .arguments(GenericArguments.flags().permissionFlag("storeys.command.make.beta", "b").buildWith(GenericArguments.none()))
                 .executor(this).build();
     }
@@ -80,7 +80,7 @@ private String getSystemPropertyEnvVarOrDefault(String propertyName, String defa
                 String code = tokenProvider.getCode(player);
                 String url = String.format("%s?code=%s", scratchGui, code);
 
-                src.sendMessage(Text.builder("Click here to open Scratch and MAKE actions").onClick(TextActions.openUrl(new URL(url)))
+                src.sendMessage(Text.builder("Click here to open a browser and start MAKE actions").onClick(TextActions.openUrl(new URL(url)))
                         .color(TextColors.GOLD).build());
             });
         } else {