se.llbit.chunky.Plugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chunky-core

Minecraft mapping and rendering tool

There is a newer version: 1.4.5

/*
 * Copyright (c) 2016 Jesper Öqvist 
 *
 * This file is part of Chunky.
 *
 * Chunky is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Chunky is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with Chunky.  If not, see .
 */
package se.llbit.chunky;

import se.llbit.chunky.main.Chunky;

/**
 * The plugin interface for Chunky plugins.
 *
 * The Chunky launcher calls the attach() method for each plugin
 * in the plugin load order. A reference to the Chunky instance is passed
 * so that plugins can register their hooks.
 */
public interface Plugin {
  /**
   * This is called so that the plugin can initialize itself and
   * register its hooks with the Chunky instance.
   * @param chunky Chunky instance which the plugin should attach to
   */
  void attach(Chunky chunky);
}