BriarCode Fake Block API

This Java API is used by plugins that wish to integrate with fake-block services and capabilities.

Currently tested on:

• Paper 19.2
• Paper 1.20.1

Table of Contents

• Usage
• Services
• Events
• Suggestions and Support

Usage

First, add the repo to your Gradle build:

repositories {
    maven { url 'https://jitpack.io' }
}

or Maven build:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Next, include this library in your plugin using either the Gradle coordinate:

dependencies {
    implementation 'com.github.toddharrison.BriarCode:fake-block-api:fake-block-api-3.0'
}

or the Maven coordinate:

<dependency>
    <groupId>com.github.toddharrison.BriarCode</groupId>
    <artifactId>fake-block-api</artifactId>
    <version>fake-block-api-3.0</version>
</dependency>

Do not shadow the API into your plugin. The release of fake-block has the API included itself already and will be available at runtime, assuming a shared classloader environment provided by spigot plugins.

Services

Fake-block publishes several Bukkit services, detailed below.

GroupService

Get an instance to this service using the following code:

getServer().getServicesManager().getRegistration(GroupService.class);

This service provides methods to get, create, update, and delete Groups programmatically. Refer to the JavaDoc for specific method capabilities.

PlayerGroupService

Get an instance to this service using the following code:

getServer().getServicesManager().getRegistration(PlayerGroupService.class);

This service provides methods to show, hide, and clear Groups for Players. Refer to the JavaDoc for specific method capabilities.

Events

Fake-block emits cancellable Bukkit Events every time it is going to take an action. These events are:

CreateFakeBlockGroupEvent

This event is called when fake-block is about to create a new Group.

DeleteFakeBlockGroupEvent

This event is called when fake-block is about to delete an existing Group.

UpdateFakeBlockGroupEvent

This event is called when fake-block is about to modify the Set of FakeBlocks belonging to an existing Group.

ShowFakeBlockGroupEvent

This event is called when fake-block is about to show a Group to a Player.

HideFakeBlockGroupEvent

This event is called when fake-block is about to hide a Group from a Player.

ClearFakeBlockGroupEvent

This event is called when fake-block is about to clear the Group configurations of a Player.

Suggestions and Support

Please feel free to provide suggestions (this plugin is in active development) or ask questions using the BriarCraft discord plugin channel.