Overview

With the arrival of the last version (1.4.0), introducing inventory and pagination settings, the buttons were broken, supporting only the use of the discontinued versions and it was necessary to think of a new way to integrate them with the new inventory settings.

The most important classes for this release are:

• Button
• ButtonType

Okay, this isn't a pretty inventory, but it works. Ignore the oscillations, it occurs due to my computer.

Button Creation

Inventory buttons are a handy way to perform pre-configured actions, like the actions of swiping and back to the inventories page.

Buttons can be created in the following way:

Button.of(buttonType, slot, itemStack);
Button.of(buttonType, slot, itemStack, alwaysShow);

NOTE: The alwaysShow option will always show the button regardless of whether or not it is valid for that inventory. A practical example would be when the inventory is on the home page, normally one would not have a back button, but if this option is active it will always show and not check if that inventory can return to the page or not.

Defining Buttons

The buttons can be defined directly in the builder, as global buttons, or in the pages configuration itself.

Global buttons

Global buttons, as said before, are buttons created directly in the builder itself as in the example below:

InventoryBuilder.of(inventoryConfiguration)
    .withButton(Button.of(ButtonType.PREVIOUS_PAGE, slot, item))
    .withButton(Button.of(ButtonType.NEXT_PAGE, slot, item))

The use of these buttons is only appropriate when you are working with several page settings and need to update all of them with the same button, as in the example below:

InventoryBuilder.of(inventoryConfiguration)
    .withItems(configuration1, items1)
    .withItems(configuration2, items2)
    .withButton(Button.of(ButtonType.PREVIOUS_PAGE, slot, item))
    .withButton(Button.of(ButtonType.NEXT_PAGE, slot, item))

NOTE: If you do not use multiple page configurations in your inventory, do not use the global buttons.

Global buttons need to check all formats in the inventory to see if they meet the requirement and can be put in the inventory if the always show option is false. These checks although relatively quick can be dropped when using the buttons within the page settings.

Page Setup Buttons

The use of these buttons is highly recommended when you do not need to refresh every page of the inventory. They are more efficient because they update only the items that are set for that pagination, and you don't need to check the other formats and validate them, as in the example above with the buttons next to the armor.

These types of buttons can be defined directly in PaginatedConfiguration:

PaginatedConfiguration.builder("#4")
    .button(Button.of(ButtonType.PREVIOUS_PAGE, slot, item))
    .button(Button.of(ButtonType.NEXT_PAGE, slot, item))

NOTE: When working with the global buttons along with the pagination buttons themselves, as in the image shown above, the global buttons must always be visible. The global buttons perform checks in all formats, and to make them work together properly would require recursive methods, which would make updating them inefficient. One of the goals of this project is to make it easy and efficient to create inventories, so I have chosen not to do this. Always showing the global buttons in these cases ensures that all the buttons work correctly without the need for multiple checks.

Resources

• Added the buttons.

Changes

• Added discontinued methods for the old ButtonType.

Removed

• Removed discontinued methods.
• Removed old examples.

All changes: https://github.com/SrBlecaute01/InventoryHelper/compare/1.4.1...1.5.0

Installation

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.5.0</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.5.0'
}

Overview

This release fixes the equals and hashcode methods of the paginated inventory formats. Its importance is given by the fact that InventoryBuilder uses the Set collection to remove duplicate formats that occasionally occur for some reason.

Paginations with the same number of objects inferred that they were the same, and for that reason removed from the collection like this.

.withObjects(iconConfiguration, icons, null)
.withObjects(dropConfiguration, drops, null);

These collections had the same number of objects and therefore were removed and only one was defined in the inventory.

Bug fix

• Fixed equals and hashcode of paginated inventories.

Changes

• Changed name of SlotValidator to SlotInvalidator.

All changes: https://github.com/SrBlecaute01/InventoryHelper/compare/1.4.0...1.4.1

Installation

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.4.1</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.4.1'
}

Visão geral

Nessa versão foi adicionado métodos para a atualização dos inventários, sem a necessidade de recriá-los ou reabri-los para os jogadores, poupando recursos e tempo. As classes mais importantes são:

• InventoryConfiguration
• PaginatedConfiguration
• Updatable
• UpdateHandler
• InventoryUpdater

Configuração do inventário

Com o intuito de deixar compatível para a adição de novos recursos foi adicionado o InventoryConfiguration. Nessa versão apenas poderá ser configurado o nome e a quantidade de linhas.

InventoryConfiguration configuration = InventoryConfiguration.builder("§cTitle", 6).build();
InventoryBuilder<Icon> builder = new InventoryBuilder<Icon>(configuration);

Obs: As cores já são automaticamente convertidas.

Configuração das páginas

Os métodos que utilizam listas de objetos agora necessitam do PaginatedConfiguration, que será utilizado para realizar verificações quando o inventário estiver sendo formatado.

PaginatedConfiguration paginated = PaginatedConfiguration.builder("#id")
        .validator(slot -> (slot > 16 && slot < 19) || (slot > 25 && slot < 28)) // Validação do slot
        .size(21) // Quantidade de objetos na página
        .start(10) // Slot em que os itens começarão a serem postos (includente).
        .end(35) // Slot até onde os itens serão postos (excludente).
        .build(); 

builder.withObjects(paginated, icons, click -> {
    click.updateObjects(newIcons);
    click.sendMessage("Atualizando inventário");
});

Caso queira atualizar uma específica página, você pode passar como parâmetro o identificador da página.

click.updateObjects("#id", newIcons);

Atualizações baseadas no tempo

Um dos novos recursos adicionados foi permitir a atualização dos inventários a partir de tempos configurados.

As atualizações são realizadas em asynchronously e somente a cada 1 segundo, então tome cuidado quando ficar alguma ação que seja necessário sua execução na main-thread.

builder.withUpdate(1, updater -> {
    updater.updateObjects("id", newIcons);
    updater.updateItem(49, randomItem);
})

Recursos

• Adicionado InventoryConfiguration para configuração do inventário.
• Adicionado PaginatedConfiguration para configuração das páginas.
• Adicionado suporte para atualizações dos inventários.

Mudanças

• Adicionado tratamento de erros na execução do clique.
• Adicionado novos métodos no InventoryEvent
• Removido a função para verificação dos slots e adicionado o SlotValidator
• Adicionado métodos descontinuados

Contribuidores

• Feature/updater by @SrBlecaute01 in https://github.com/SrBlecaute01/InventoryHelper/pull/5

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.3.1...1.4.0

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.4.0</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.4.0'
}

Mudanças

• Ignorado slots duplicados no InventoryBuilder.

Correções

• Corrigido a exclusão do slot 0 dos inventários por @M0rais

Removido

N/A

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.3.0...1.3.1

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.3.1</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.3.1'
}

Recursos

• Adicionado o evento ObjectClickEvent para cliques em objetos.
• Adicionado o callback ObjectCallback para cliques em objetos.
• Adicionado novos métodos para definir itens a partir de arrays e coleções.

Mudanças

• Arrumado a compilação das classes de testes.
• Decontinuado o método ItemClickEvent#getObject

Removido

N/A

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.2.1...1.3.0

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.3.0'
}

Mudanças

• Arrumado slot nos inventários paginados

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.2.0...1.2.1

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.2.1</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.2.1'
}

Novos Recursos

• Adicionado anotações para prevenir objetos nulos.

Mudanças

• Arrumado erro que impedia o registro do InventoryHelper
• Arrumado o slot de saída do InventoryBuilder
• Removido arquivos de exemplos da compilação.

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.1...1.2.0

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.2.0'
}

Suporte

• Adicionado suporte ao ItemCallback.

Mudanças

• Renomeado InventoryClick para InventoryEvent
• Adicionado método para obter as propriedades do inventário no InventoryEvent

Todas as mudanças: https://github.com/SrBlecaute01/InventoryHelper/compare/1.0...1.1

Instalação

Maven

<dependency>
    <groupId>com.github.SrBlecaute01</groupId>
    <artifactId>InventoryHelper</artifactId>
    <version>1.1</version>
</dependency>

Gradle

dependencies {
    implementation 'com.github.SrBlecaute01:InventoryHelper:1.1'
}

• Adicionado paginação nos inventários.
• Adicionado implementação para facilitar a inserção de itens pelo slot.