Interaction-API

A Spigot API for managing interactions with items.

Warning

At the moment the API is designed and tested for Spigot version 1.19.4! Other versions will be usable in the future.

Include the API in your project

Maven (Recommended)

You can include the package as a dependency in Maven. For that you have to include the following entry in your pom.xml in the surrounding <dependencies> ... </dependencies>:

<dependency>
    <groupId>dev.edgetom</groupId>
    <artifactId>interaction-api</artifactId>
    <version>VERSION</version>
</dependency>

Replace the placeholder VERSION with the version you want to use. You can find the all versions of the API in the Maven Central Repository.

Gradle

Alternatively you can include the API via Gradle:

implementation group: 'dev.edgetom', name: 'interaction-api', version: 'VERSION'

Replace the placeholder VERSION with the version you want to use. You can find the all versions of the API in the Maven Central Repository.

Basic usage example

1. You will need to create an InteractionManager which will handle the calls to the Interactions. There should only be one InteractionManager for your project. Initialize it like this:

   InteractionManager interactionManager = new InteractionManager(plugin);

2. Create your own Interaction by inheriting from the class InteractionExecutor . For example like this:

   // Create a new class with an arbitrary name extending the class InteractionExecutor
   public class TestInteraction extends InteractionExecutor {
   
       // Create an constructor for the interaction fitting the use case
       public TestInteraction(@NotNull InteractionManager interactionManager, String interactionKey, boolean placeable, ActionClass actionClass) {
           super(interactionManager, interactionKey, placeable, actionClass);
       }
   
       // Override the execute method, which will be called if a player interacts with an item referencing this interaction
       @Override
       public void execute(PlayerInteractEvent event, Player player) {
   
           // Send a message to the player who caused the interaction
           event.getPlayer().sendMessage("Click!");
       }
   }

3. Initialize the InteractionExecutor, create an ItemStack and "connect" it to the InteractionExecutor.

   The following example assumes the usage of an ItemBuilder

   TestInteraction testInteraction = new TestInteraction(plugin.getInteractionManager(), "test_interaction", false, ActionClass.RIGHT_CLICK);
   
   // Creating a stick
   ItemStack itemStack = new ItemStack(Material.STICK);
   
   // Adding the InteractionExecutor key to the ItemStack. This will make sure that the ItemStack is being assigned to the executor if someone interacts with it
   itemStack = testInteraction.addToItem(itemStack);

   Voilà, the item you just created will now trigger the TestInteraction#execute() method and will inform the user of the item of the fact he just clicked with your item.

Note

Your ItemStack has to have a valid ItemMeta in order to be connected to the InteractionExecutor. It is recommended to use a kind of ItemBuilder (like for example this one) to ensure the existence of an ItemMeta.