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

# API Methods

| Method                              | Description                                    |
| ----------------------------------- | ---------------------------------------------- |
| `hasMine(UUID)`                     | Checks whether a player has a mine             |
| `hasMine(Player)`                   | Same as the UUID variant                       |
| `getMineLocation(UUID)`             | Returns the mine location                      |
| `teleportToMine(Player)`            | Teleports the player to their mine             |
| `resetMine(UUID)`                   | Resets a mine                                  |
| `resetMine(Player)`                 | Same as the UUID variant                       |
| `resetAllMines()`                   | Resets every mine                              |
| `getBlocksBroken(UUID)`             | Returns the number of broken blocks            |
| `getTotalMineBlocks(UUID)`          | Returns the total number of blocks             |
| `getMinePercentage(UUID)`           | Returns progress between `0.0` and `1.0`       |
| `getThreshold(UUID)`                | Returns the auto-reset threshold               |
| `setThreshold(UUID, double)`        | Updates the threshold                          |
| `getPlayerTierName(UUID)`           | Returns the tier name                          |
| `getPlayerTier(UUID)`               | Returns `MineTier` or `null`                   |
| `isVisitsAllowed(UUID)`             | Checks whether visits are enabled              |
| `setVisitsAllowed(UUID, boolean)`   | Updates the visit state                        |
| `isMiningAllowed(UUID)`             | Checks whether visitors can mine               |
| `setMiningAllowed(UUID, boolean)`   | Updates visitor mining state                   |
| `getWhitelist(UUID)`                | Returns the whitelist                          |
| `addToWhitelist(UUID, String)`      | Adds a player to the whitelist                 |
| `removeFromWhitelist(UUID, String)` | Removes a player from the whitelist            |
| `getBlacklist(UUID)`                | Returns the blacklist                          |
| `addToBlacklist(UUID, String)`      | Adds a player to the blacklist                 |
| `removeFromBlacklist(UUID, String)` | Removes a player from the blacklist            |
| `getVisitableMines()`               | Returns a `UUID → name` map of visitable mines |
| `forceTierCheck(Player)`            | Forces an immediate tier check                 |
| `getMineConfig()`                   | Returns `MineConfig`                           |
| `canBreakInMine(Player, Location)`  | Checks whether the player can break a block    |


---

# 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://jpprison.gitbook.io/jpprison-docs/mines/developer-api/api-methods.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.