ItemActionsLib

A framework library for Item Actions.

Authors: Katsumag

Contributor: Conclure

ItemActionsLib is a simple to use library for adding actions to items, as the name suggests.

Setup

You will need to shade and relocate ItemActionsLib to use it at runtime.

Gradle

plugins {
    id 'com.github.johnrengelman.shadow' version '6.0.0' //Or newer version
}

repositories {
    maven { url "https://repo.katsumag.me/repository/maven-releases/" }
}

dependencies {
    implementation "me.katsumag:item-actions-lib:[VERSION]"
}

shadowJar {
    relocate 'me.katsumag.itemactionslib', '[YOUR PACKAGE].itemactionslib'
}

An example of [YOUR PACKAGE] could be me.conclure.plugin. If you want to use latest version of ItemActionsLib, use version 2.0. It should be replace [VERSION].

Usage

At first you'll have to create an instance of the class ItemActionManager. This should be done through invoking the class' constructor ItemActionManager(), as shown below. Notice that if you try to invoke it more than once it will throw an exception.

class Main extends JavaPlugin {
   @Override
   public void onEnable() {
      ItemActionManager itemActionManager = ItemActionManager();
   }
}

Now when you have an instance of the manager class you may call ItemActionManager#newItem(ItemKey, ItemStack, IdentifierOption... options) or ItemActionManager#newItem(ItemKey, Material, IdentifierOption... options). This will create a new ActionItem instance for you. To add an Action to this ActionItem you may invoke ActionItem#addAction(ActionType, Action). The method takes an ActionType and and Action. The Action parameter represents a consumer and a lambda expression or a method reference may be used. All current possible ActionTypes can be found here. An example is also shown below.

public class Main extends JavaPlugin {

    private final ItemActionManager itemActionManager = new ItemActionManager();
    private ActionItem item;

    @Override
    public void onEnable() {
        this.itemActionManager.newItem(new ItemKey("IALExample"), Material.APPLE, IdentifierOption.COMPARE_NBT).ifPresent(actionItem -> this.item = actionItem);
        this.item.addAction(ActionType.LEFT_CLICK, event -> event.getPlayer().setGameMode(GameMode.CREATIVE));
    }

    @Override
    public void onDisable() {
        this.item.removeActions(ActionType.LEFT_CLICK);
    }

    public ItemActionManager getItemActionManager() {
        return itemActionManager;
    }
}

If you wish to remove all actions for a specific ActionType, you may invoke ActionItem#removeActions(ActionType).

item.removeActions(ActionType.CLICK);

You can clear all actions from a specific item by invoking ActionItem#clearActions().

item.clearActions();

Contribute

If you want to contribute you may open a pull request here, as we accept most of them.

Support

If you have any questions or are in need of support, you may join HelpChat discord server here.