anvil input - DevNatan/inventory-framework GitHub Wiki

Anvil Input allows the developer to process what the player wrote in an anvil's text field.

Anvil Input is a external feature so you need to include it on your project build file

implementation 'me.devnatan:inventory-framework-anvil-input:<version>'

And install it in your ViewFrame in order to be able to use it

viewFrame.install(AnvilInputFeature.AnvilInput);

Anvil Input feature is often used for "searching something"-like views, it integrates very well with other features like Context Flows without having to write extra code for it.

Now you know everything!! Lets get started 🚀

In your view, create a new AnvilInput instance to get started.

final AnvilInput anvilInput = AnvilInput.createAnvilInput();

Then, apply it into your view configuration.
Use use(Modifier) to apply Anvil Input as a configuration modifier.

@Override
public void onInit(ViewConfigBuilder config) {
    config.title("Hello world")
          .use(anvilInput); // <-- Look here
}

...This document is still being written...

Here's some details that you may want to know about Anvil Input feature.

• Internally Anvil Input is a State value like Pagination so you access its value using anvilInput.get(context);
• You need to apply Anvil Input state on your configuration because it's a Configuration Modifier;
• It's a External Feature so installation in your ViewFrame is needed to work;
• And then, it's a Protocol-Level Integration so its behavior may change depending on your game version or even be completely incompatible.