AdvancedTopics.md

Advanced Topics

Dependency Swapping

EasyEnchants allows you to swap out its' default dependencies with your own. This includes:

• IEnchantInfoParser
• IEnchantReadWriter
• EnchantInfoRetriever
• IEnchantExecutor
• EnchantRegisterer

If you wanted to change enchants from being formatted like "DefenseEnchant 3" to "DefenseEnchant - 3", you could do so by swapping out the default IEnchantInfoParser with your own.

In order to swap dependencies, we'll need to create our new implementation, and create a new Runnable which preforms the dependency swap.

    private void InjectSpecialFormatting(){

        EasyEnchants easyEnchants = EasyEnchants.getInstance();
        Runnable dependencySwapTask = new Runnable() {
            @Override
            public void run() {

                IEnchantInfoParser enchantInfoParser = new IEnchantInfoParser() {

                    IEnchantInfoParser defaultParser = easyEnchants.dependencyRetriever.getEnchantInfoParser();

                    @Override
                    public EnchantInfo getEnchantInfo(String enchantString) {
                        return defaultParser.getEnchantInfo(enchantString.replace(" - ", " "));
                    }

                    @Override
                    public String createEnchantString(EnchantInfo enchantInfo) {
                        return enchantInfo.name + " - " + enchantInfo.level;
                    }
                };

                class DependencySwapDecorator extends DependencyCreatorDecorator{

                    public DependencySwapDecorator(IDependencyCreator dependencyCreator) {
                        super(dependencyCreator);
                    }

                    @Override
                    public IEnchantInfoParser getEnchantInfoParser() {
                        return enchantInfoParser;
                    }
                }

                easyEnchants.dependencyRetriever = new DependencySwapDecorator(easyEnchants.dependencyRetriever);
            }
        };

        EasyEnchants.dependencyBuilder.addTask(dependencySwapTask, 5);

    }

Note: If you try and access EasyEnchants.dependencyRetriever outside of the runnable, you may run into a null refference exception. This is because the IDependencyCreator object isn't created until after onEnable(). This also means any objects you create which are constructed with an object from EasyEnchants.dependencyRetriever should be created inside the runnable.

Note 2: All of the interfaces are implemented inline to make it easier to view this code on github. It is advisable to implement all interfaces / classes in their own class files to keep your code clean.

Using EasyEnchants in your own Enchants plugin

If you're going to use EasyEnchants in your own plugin, you're going to need to know a few additional things.

1. EasyEnchants.dependencyRetriever is wrapped in a decorator which caches all the dependencies. This means you can use the dependencyRetriever object to retrieve all dependencies you might need for creating your own plugin. (i.e. you can use it to retrieve the IEnchantReadWriter, which you can use for applying enchants on items)

2. You should be able to control every aspect of how enchants are activated without modifying this plugin's source (if not, I haven't done my job). For example, you should be able to make it so an op's enchants will activate an additional 5% of the time, when enchant.shouldActivate() returns false.

3. The only features which at the current moment might not be changeable are those pertaining to registering enchants and the custom events provided by EasyEnchants. I haven't spent a lot of time looking into how hard it is to add code when registering an enchant, so it may or may not be possible. That being said, there may've been other areas I didn't consider. If you cannot modify something without touching the plugins' source code, open an issue, and I will implement the feature, or make a suggestion on what you can do.