Initialize the library

This page describes how to initialize the library.

To use the library and create custom inventories, it first must be initialized by defining a set of reusable Java objects. This is done by using the CraftVentoryLibrary class that provides several methods to use the default behaviors implemented in the library.

Create an InventoryService

An InventoryService is a class with two purposes:

• Register, store and retrieve inventory providers

• Store information about players with an opened inventory and manage inventories' life cycle

An instance of this class with the default behavior provided by the library can be created by using the following code:

InventoryService service = CraftVentoryLibrary.createInventoryService(Plugin plugin);

Note: We recommand to store this object as an instance variable in the main class of your plugin (eq. the class that extends JavaPlugin).

Create an InventoryConfigDAO

An InventoryConfigDAO is a class used to load an inventory from a configuration file. By default, the library provides an instance of this class to load inventories from YAML files. The following code uses the library built-in methods to create a new instance of InventoryConfigDAO:

// Factory used to load item click actions.
ClickActionLoaderFactory<ConfigurationSection> factory =
        FastInventoryLibrary.createDefaultClickActionLoaderFactory();

InventoryConfigDAO dao = FastInventoryLibrary.createDefaultConfigDAO(factory);

Note: ClickActionLoaderFactory is a class that is used to load item actions from the configuration file.

Example

Here is a complete example:

public class CraftVentoryPlugin extends JavaPlugin {

    private InventoryService inventoryService;

    @Override
    public void onEnable() {
        this.inventoryService = CraftVentoryLibrary.createInventoryService(this);
        this.loadInventoryProviders();
    }

    private void loadInventoryProviders() {

        ClickActionLoaderFactory<ConfigurationSection> factory =
                FastInventoryLibrary.createDefaultClickActionLoaderFactory();

        InventoryConfigDAO dao = FastInventoryLibrary.createDefaultConfigDAO(factory);

        // Register inventory providers here.
    }
}