> For the complete documentation index, see [llms.txt](https://docs.mipcraft.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mipcraft.eu/golf-party/plugin-api.md).

# Plugin API

### Getting started:

Currenty for plugin developement you'll have to own the plugin to use this plugin's api.

To begin, add the plugin's jar file to the build path of your project.

### Events:

```java
@EventHandler
public void onGameStartEvent(GameStartEvent event) {
    Game game = event.getGame();
}
```

Called when the game starts. You can get the game object and access all the necessary data from it.

```java
@EventHandler
public void onGameEndEvent(GameEndEvent event) {
    Game game = event.getGame();
}
```

Called when the game ends. You can get the game object and access all the necessary data from it.

```java
@EventHandler
public void onGameLoadEvent(GameLoadEvent event) {
    Game game = event.getGame();
    World world = event.getWorld();
}
```

Called when the game is loaded. Usually happens after the server is starting.

```java
@EventHandler
public void onGameStateChangeEvent(GameStateChangeEvent event) {
    Game game = event.getGame();
    GameState pastGameState = event.getPastGameState();
    GameState newGameState = event.getNewGameState();
}
```

Called when any of the games changes game state.

```java
@EventHandler
public void onPlayerJoinGameEvent(PlayerJoinGameEvent event) {
    Game game = event.getGame();
    Player player = event.getPlayer();
}
```

Called when the player joins the game.

```java
@EventHandler
public void onPlayerLeaveGameEvent(PlayerLeaveGameEvent event) {
    Game game = event.getGame();
    Player player = event.getPlayer();
}
```

Called when the player joins the game.
