> For the complete documentation index, see [llms.txt](https://kzone.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kzone.gitbook.io/docs/kgenerators/developers-api.md).

# Developers API

### Loading dependency

You can add KGenerators as dependency directly via jar file or use Mave/Gradle

#### Maven

```xml
<repositories>
  <repository>
    <id>codemc-repo</id>
    <url>https://repo.codemc.org/repository/maven-public/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>me.kryniowesegryderiusz</groupId>
    <artifactId>kgenerators-core</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
  </dependency>
</dependencies>
```

#### Gradle

```
repositories {
    maven { url "https://repo.codemc.org/repository/maven-public/" }
}

dependencies {
    compileOnly 'me.kryniowesegryderiusz:kgenerators-core:VERSION'
}
```

{% hint style="warning" %}
*VERSION* should look like `7.0` / `7.1 / 7.2` and so on
{% endhint %}

### Getting started with KGeneratorsAPI

**All API methods are accessible from** [**`KGeneratorsAPI`**](https://github.com/Kryniowesegryderiusz/KGenerators/blob/main/core/src/main/java/me/kryniowesegryderiusz/kgenerators/api/KGeneratorsAPI.java) **class**

The most important Interface is [`IGeneratorLocation`](https://github.com/Kryniowesegryderiusz/KGenerators/blob/main/core/src/main/java/me/kryniowesegryderiusz/kgenerators/api/interfaces/IGeneratorLocation.java), which manages Generator at specific location.

Related to that is method `KGeneratorsAPI#getGeneratorLocation(Location)`

#### A few examples below

<details>

<summary>Example of getting generator from location</summary>

```java
IGeneratorLocation igl = KGeneratorsAPI.getGeneratorLocation(location);
```

</details>

<details>

<summary>Example of removing generator from location</summary>

`location` - Bukkit Location variable

```java
IGeneratorLocation igl = KGeneratorsAPI.getGeneratorLocation(location);
    if (igl != null)
        igl.removeGenerator(true, null);
```

</details>

<details>

<summary>Example of checking if mining generator is possible</summary>

This can be related for example to CustomEnchants/Minions plugins

`location` - Bukkit Location variable for mined block

`player` - Player related with this action

```java
IGeneratorLocation igl = KGeneratorsAPI.getGeneratorLocation(location);
    if (igl != null
        && igl.isPermittedToMine(player)
        && igl.isBlockPossibleToMine(location)) {
        //Your block removal code
        igl.scheduleGeneratorRegeneration();
    }
```

</details>

### Events

* `PreBlockGenerationEvent` - cancellable event called when generator regenegenerating function is fired, returns [`IGeneratorLocation`](https://github.com/Kryniowesegryderiusz/KGenerators/blob/main/core/src/main/java/me/kryniowesegryderiusz/kgenerators/api/interfaces/IGeneratorLocation.java)\`\`
* `PostBlockGenerationEvent` - called after generator regeneration, for monitoring reasons, returns [`IGeneratorLocation`](https://github.com/Kryniowesegryderiusz/KGenerators/blob/main/core/src/main/java/me/kryniowesegryderiusz/kgenerators/api/interfaces/IGeneratorLocation.java)\`\`
* `ReloadEvent` - called, when KGenerators is beeing reloaded.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://kzone.gitbook.io/docs/kgenerators/developers-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.