Developer API

The Santa Says API allows developers to hook into game lifecycles, track player statistics, and modify task behavior. All custom events in the plugin inherit from the base SantaSaysEvent class.

---

Dependency Setup

To start using the API, you need to add the Santa Says JAR file to your project’s dependencies. Create a folder named libs in your project’s root directory and place the santa-says-x.x.x.jar file inside it.

Gradle (Groovy)

dependencies {
    compileOnly files('libs/santa-says-x.x.x.jar')
}

Gradle (Kotlin)

dependencies {
    compileOnly(files("libs/santa-says-x.x.x.jar"))
}

Maven

<dependency>
    <groupId>io.greenmc</groupId>
    <artifactId>santa-says</artifactId>
    <version>LATEST</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/libs/santa-says-x.x.x.jar</systemPath>
</dependency>

Caution

Don’t forget to add SantaSays to the depend or softdepend list in your plugin.yml file to ensure it loads before your plugin.

plugin.yml

name: YourPlugin
version: 1.0.0
main: your.package.Main
depend: [SantaSays]

---

Base Event Class

Every event provided by the Santa Says API extends the SantaSaysEvent class. This ensures a consistent implementation of Bukkit’s HandlerList and makes it easier to manage custom listeners.

public abstract class SantaSaysEvent extends Event {

    private static final HandlerList HANDLER_LIST = new HandlerList();

    @NotNull
    @Override
    public HandlerList getHandlers() {
        return HANDLER_LIST;
    }

    public static HandlerList getHandlerList() {
        return HANDLER_LIST;
    }
}

Next Steps

Explore the different event categories to start building your integration:

• Player Events
• Game Events
• Round Events
• Task Events