> For the complete documentation index, see [llms.txt](https://pyrotempus.gitbook.io/pyro-plugins/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pyrotempus.gitbook.io/pyro-plugins/pyrofishingpro/setup-manual/api-usage.md).

# API Usage

This page shows you how to use the API that the plugin currently offers.

{% hint style="info" %}
I currently do not intend to focus on adding an intensive API. I will add things overtime, when I have the spare time to do so. Please do not request it as it will be ignored. 

Support will not be given to help you implement the API. 
{% endhint %}

{% hint style="warning" %}
There is no maven repoistory for this project. You will need to add the jar to your project manually.
{% endhint %}

## Available Events

<table data-view="cards"><thead><tr><th></th><th></th><th><select multiple><option value="173e82d481f24b59a62451b7d3c4015f" label="getName()" color="blue"></option><option value="c79973c4a6494912ad38d54029623c6c" label="getDuration()" color="blue"></option><option value="24200ba69124436688d2d789d2087f17" label="getTier()" color="blue"></option><option value="9b2995d273914230972108b3268300ad" label="isHotSpot()" color="blue"></option><option value="1474b318b69043558407debbbef8ad45" label="getFishNumber()" color="blue"></option></select></th></tr></thead><tbody><tr><td><mark style="color:green;"><strong>TournamentStartEvent</strong></mark></td><td>This event is fired when a tournament starts.</td><td><span data-option="173e82d481f24b59a62451b7d3c4015f">getName()</span></td></tr><tr><td><mark style="color:green;"><strong>TournamentEndEvent</strong></mark></td><td>This event is fired when a tournament ends.</td><td><span data-option="173e82d481f24b59a62451b7d3c4015f">getName()</span></td></tr><tr><td><mark style="color:green;"><strong>PyroFishCatchEvent</strong></mark></td><td>This event is fired when catching a custom fish.</td><td><span data-option="24200ba69124436688d2d789d2087f17">getTier(), </span><span data-option="1474b318b69043558407debbbef8ad45">getFishNumber(), </span><span data-option="9b2995d273914230972108b3268300ad">isHotSpot()</span></td></tr></tbody></table>

Example Usage:

```java
@EventHandler
public void onTournamentStart(TournamentStartEvent event) {
  String tournamentName = event.getName();
}
```