storeys java / javascript api

[edewit]

API

Currently the API that is suggested in #322 looks like this:

      e.whenCommand("example", m -> {
          // TODO test that this is correctly asynchronously chained - each line wait for execution...
          m.cmd("/title @s hello, world");
          m.cmd("/tp 232 63 216 -180 25");
          m.cmd("/narrate Piggy Hello! I'm Piggy.");
          m.cmd("/say Message in the Chat");
          m.cmd("/title @s The End");
      });
      e.whenCommand("another", m -> {
          m.cmd("/title @s Namaste. Curry pour tous!");
          if (!m.player().getInventory().contains(ItemTypes.FISHING_ROD)) {
              m.cmd("/say There may be a fishing rod hidden somewhere… look for it, and then catch a fish!");
          } else {
              m.cmd("/say Go fishing with the rod in your inventory..");
          }
      });

If we want to have javascript that can easily execute this as well and have an api that is easy to learn I suggest that we change it a bit, make it easier to learn / have code completion:

Minecraft minecraft = new Minecraft("localhost");
minecraft.whenCommand("example", player -> {
   minecraft.title("@s Namaste. Curry pour tous!");
   if (player.getInventory().contains(ItemTypes.FISHING_ROD)) {
      minecraft.say("There may be a fishing rod hidden somewhere… look for it, and then catch a fish!");
   }
});

WDYT?

[vorburger]

Minecraft minecraft = new Minecraft("localhost");

This would be passed in through the scripting context, and not needed?

There's not going to be anything like"localhost", because there won't be any remoting?

minecraft.whenCommand("example", player -> {

This is similar as originally, right? Or am I not seeing something?

minecraft.title("@s Namaste. Curry pour tous!");

The title() instead of cmd("/title") makes a lot of sense for autocompletion - sold!

if (player.

I suspect there could be other things than "player" that we want to pass to event handlers, and it may evolve, so perhaps having a single "context" kind of object from which we can obtain things like Player, and maybe others, is better?

[edewit]

Minecraft minecraft = new Minecraft("localhost");

This would be passed in through the scripting context, and not needed?

Right, this is true for when it's being used on our website, but don't we want to also support writing a script like this locally? Or are are users then just going to have to put it into the config folder?

I suspect there could be other things than "player" that we want to pass to event handlers, and it may evolve, so perhaps having a single "context" kind of object from which we can obtain things like Player, and maybe others, is better?

Can't think of anything other then a player right, but your right... let's not tie it down to just a player

[edewit]

We seem to be using e and m as variable names, I know that naming is hard, but surly we can come up with something better