FrostAPI BETA 2

API that brings support for Frost's plugins, and others.

  1. Yasuo_exe
    Native Minecraft Version:
    1.16
    Tested Minecraft Versions:
    • 1.16
    Contributors:
    Frostingly
    FrostAPI. A lightweight API that brings support for my plugins, currently for Listeners3. This can also be used for anybody else's plugins, simply install the plugin with the instructions below.

    If you are a server owner:

    You may have been told by the author of a plugin that your server has, to install FrostAPI to use the plugin. To use FrostAPI it's pretty simple, simply download the API, drag and drop it to your plugins folder and you're done!

    If you are a developer:

    You can use the API to create plugins, with its features. Below you can see how to get FrostAPI working and ready for use, and also its built-in methods.

    How to install FrostAPI:

    Download the plugin and place it in your project as a library, then in your plugin.yml add a "soft_depend" or a "depend" depending on how major the API is to your plugin, and then add a colon :)), and "FrostAPI", it should look like this:

    Code (Java):
    depend: FrostAPI
    Then to register the API, in your main class put the following:


    Code (Text):
    private static FrostAPI frostapi = FrostAPI.getInstance();

    public FrostAPI getFrostAPI() {
        return frostapi;
    }

    @Override
    public void onEnable() {
        this.frostapi = FrostAPI.getInstance();
    }

    @Override
    public void onDisable() {
        this.frostapi = null;
    }
    You're done! You can now use the built-in methods

    How to use FrostAPI:

    To use the API, wherever you want to access it add the following:

    Code (Text):
    <mainclassname>.getFrostAPI.<method>(<parameters>);
    The following methods which are currently in the API:

    Code (Text):
    <mainclassname>.getFrostAPI.vanishPlayer(player, time)
    NOTE: time in the parameters is measured in ticks, which means that 20L is 1 second.

    Then another one:

    Code (Java):
    <mainclassname>.getFrostAPI.sendTitle(player, Title, SubTitle, FadeIn, Stay, FadeOut);
    NOTE: Once again, the parameters after SubTitle are measured in ticks, so 20 ticks are 1 second.