Developer API

Build Tool Stuff

        <repository>
            <id>glares-repo</id>
            <url>https://repo.glaremasters.me/repository/public/</url>
        </repository>
        
        <dependency>
            <groupId>me.glaremasters</groupId>
            <artifactId>guilds</artifactId>
            <version>VERSION</version>
        </dependency>

repositories {
    maven { 
        url = 'https://repo.glaremasters.me/repository/public/' 
    }
}

dependencies {
    compileOnly 'me.glaremasters:guilds:VERSION'
}

repositories {    
    maven("https://repo.glaremasters.me/repository/public/")
}

dependencies {
    compileOnly("me.glaremasters:guilds:versions")
}

Hooking Into the API

Obtaining the instance of the API is pretty simple by using the singleton that provides static access to the class. You can obtain the instance of the API through the main Guilds class.

GuildsAPI api = Guilds.getApi();

Using the API

The API can be used for obtaining a bunch of information from the plugin. You can browse over the following section to see what all is provided.

Getting a Guild object

We provide a few ways to obtain a Guild object, so feel free to use what is easiest for you.

    /**
     *
     * Get the guild of a player
     * @param player the players you're getting the guild of
     * @return the guild that the player is in
     */
    fun getGuild(player: OfflinePlayer): Guild? {
        return guildHandler.getGuild(player)
    }

    /**
     * Get a guild by it's uuid
     * @param uuid uuid of the guild
     * @return the guild the uuid belong to
     */
    fun getGuild(uuid: UUID): Guild? {
        return guildHandler.getGuild(uuid)
    }

    /**
     * Get a guild by it's name
     * @param name the name of the guild
     * @return the guild object
     */
    fun getGuild(name: String): Guild? {
        return guildHandler.getGuild(name)
    }

    /**
     * Get a guild by a player's uuid
     *
     * @param uuid the uuid of the player
     * @return the guild of the player or null
     */
    fun getGuildByPlayerId(uuid: UUID): Guild? {
        return guildHandler.getGuildByPlayerId(uuid)
    }

Getting a GuildMember object

    /**
     * Get a guild member by their uuid
     *
     * @param uuid the uuid of the player
     * @return the guild member instance or null
     */
    fun getGuildMember(uuid: UUID): GuildMember? {
        return guildHandler.getGuildMember(uuid)
    }

Getting a Guild Vault

   /**
     * Get a copy of one of a guild's vaults
     * @param guild the guild to get the vault of
     * @param vaultNumber which vault to get
     * @return guild vault
     */
    fun getGuildVault(guild: Guild, vaultNumber: Int): Inventory {
        return guildHandler.getGuildVault(guild, vaultNumber)
    }

Getting a GuildRole

    /**
     * Get the role of a player
     * @param player role
     * @return the role of a player
     */
    fun getGuildRole(player: Player): GuildRole? {
        return getGuild(player)?.getMember(player.uniqueId)?.role
    }

Getting the GuildHandler

The GuildHandler will give you access to anything you might need in the plugin. Please use caution with this method as the content it lets you access to can break the plugin if you use it incorrectly.

    /**
     * Get a copy of the guild handler
     * @return guild handler
     */
    public GuildHandler getGuildHandler() {
        return guildHandler;
    }

Custom Events

In the plugin we offer a bunch of custom events that you can listen to and modify as you see fit.

Base GuildEvent

    /**
     * Base guild event
     * @param player player in event
     * @param guild guild in the event
     */
    public GuildEvent(Player player, Guild guild) {
        super(player);
        this.guild = guild;
    }

GuildAddAllyEvent

    /**
     * This event takes place when two guilds ally each other
     * @param player player who accepted
     * @param guild guild one
     * @param ally guild two
     */
    public GuildAddAllyEvent(Player player, Guild guild, Guild ally) {
        super(player, guild);
        this.ally = ally;
    }

GuildBuffEvent

    /**
     * Called when a guild purchases a buff
     * @param player the player purchasing the buff
     * @param guild the guild the player is in
     * @param buff the buff being purchased
     */
    public GuildBuffEvent(Player player, Guild guild, GuildBuff buff) {
        super(player, guild);
        this.buff = buff;
    }

GuildCreateEvent

    /**
     * Called when people create a guild
     * @param player player creating the guild
     * @param guild the guild being created
     */
    public GuildCreateEvent(Player player, Guild guild) {
        super(player, guild);
    }

GuildDepositMoneyEvent

    /**
     * Base guild event
     *  @param player player in event
     * @param guild  guild in the event
     * @param amount the amount to deposit
     */
    public GuildDepositMoneyEvent(Player player, Guild guild, double amount) {
        super(player, guild);
        this.amount = amount;
    }

GuildInviteEvent

    /**
     * Called when a player gets invited to a guild
     * @param player the player inviting other to guild
     * @param guild the guild player will be joining
     * @param invitedPlayer the player being invited
     */
    public GuildInviteEvent(Player player, Guild guild, Player invitedPlayer) {
        super(player, guild);
        this.invitedPlayer = invitedPlayer;
    }

GuildJoinEvent

    /**
     * Called when a player joins a guild
     * @param player the player joining a guild
     * @param guild the guild the player will be joining
     */
    public GuildJoinEvent(Player player, Guild guild) {
        super(player, guild);
    }

GuildLeaveEvent

    /**
     * Called a when a player leaves the guild
     * @param player the player leaving the guild
     * @param guild the guild the player was leaving
     */
    public GuildLeaveEvent(Player player, Guild guild) {
        super(player, guild);
    }

GuildKickEvent

/**
* Called when a player is kicked from the guild
* @param player the player executing the event
* @param kicked the player being kicked from the guild
* @param cause the cause for being kicked
*/
class GuildKickEvent(player: Player, guild: Guild, val kicked: OfflinePlayer, val cause: Cause) : GuildEvent(player, guild) {

    enum class Cause {
        PLAYER_KICKED, ADMIN_KICKED
    }
}

GuildPrefixEvent

    private String prefix;

    /**
     * Base guild event
     *  @param player player in event
     * @param guild  guild in the event
     * @param prefix
     */
    public GuildPrefixEvent(Player player, Guild guild, String prefix) {
        super(player, guild);
        this.prefix = prefix;
    }

    public String getPrefix() {
        return prefix;
    }

GuildRemoveAllyEvent

    /**
     * Called when a guild removes an ally
     * @param player the player calling the removal
     * @param guild the guild calling the removal
     * @param ally the guild being removed
     */
    public GuildRemoveAllyEvent(Player player, Guild guild, Guild ally) {
        super(player, guild);
        this.ally = ally;
    }

GuildRemoveEvent

    private String name;
    
    /**
     * Called when a guild is removed
     * @param player the player removing the guild
     * @param guild the guild getting removed
     * @param cause the reason for the guild being removed
     */
    public GuildRemoveEvent(Player player, Guild guild, Cause cause) {
        super(player, guild);
        this.cause = cause;
    }

    public enum Cause {
        MASTER_LEFT,
        PLAYER_DELETED,
        ADMIN_DELETED
    }

GuildRenameEvent

    /**
     * @param player player in event
     * @param guild  guild in the event
     */
     public GuildRenameEvent(Player player, Guild guild, String newName) {
        super(player, guild);
        this.name = newName;
    }

    public String getName() {
        return name;
    }

GuildSetHomeEvent

    /**
     * Called when a guild sets their home
     * @param player the player setting the home
     * @param guild the guild the player is in
     * @param location the location the home is being set at
     */
    public GuildSetHomeEvent(Player player, Guild guild, Location location) {
        super(player, guild);
        this.location = location;
    }

GuildTransferEvent

private Player newMaster;

    /**
     * Base guild event
     *  @param player player in event
     * @param guild  guild in the event
     * @param newMaster
     */
    public GuildTransferEvent(Player player, Guild guild, Player newMaster) {
        super(player, guild);
        this.newMaster = newMaster;
    }

    public Player getNewMaster() {
        return newMaster;
    }

GuildWithdrawMoneyEvent

    /**
     * @param player player in event
     * @param guild  guild in the event
     * @param amount the amount to withdraw
     */
    public GuildWithdrawMoneyEvent(Player player, Guild guild, double amount) {
        super(player, guild);
        this.amount = amount;
    }a

GuildUpgradeEvent

    /**
     * Called when a guild upgrades their tier
     * @param player the player upgrading the tier
     * @param guild the guild the player is in
     * @param tier the new guild tier for the guild
     */
    public GuildUpgradeEvent(Player player, Guild guild, GuildTier tier) {
        super(player, guild);
        this.tier = tier;
    }

GuildWarAcceptEvent

/**
 * Called when a guild war has been accepted
 * @param player the player that accepted the war challenge
 * @param challenger the challenging guild for the war
 * @param defender the defending guild for the war
 */
class GuildWarAcceptEvent(player: Player, val challenger: Guild, val defender: Guild) : GuildEvent(player, defender)

GuildWarChallengeEvent

/**
 * Called when a guild war challenge has been sent from one guild to another
 * @param player the player that sent the war challenge
 * @param challenger the challenging guild for the war
 * @param defender the defending guild for the war
 */
class GuildWarChallengeEvent(player: Player, val challenger: Guild, val defender: Guild) : GuildEvent(player, challenger)

GuildWarDeclineEvent

/**
 * Called when a guild war has been declined
 * @param player the player that declined the challenge
 * @param challenger the challenging guild for the war
 * @param defender the defending guild for the war
 */
class GuildWarDeclineEvent(player: Player, val challenger: Guild, val defender: Guild) : GuildEvent(player, defender)

GuildWarEndEvent

/**
 * Called when a guild war has ended
 * @param challenger the challenging guild for the war
 * @param defender the defending guild for the war
 * @param winner the winner of the guild war
 */
class GuildWarEndEvent(val challenger: Guild, val defender: Guild, val winner: Guild) : Event() {

    override fun getHandlers(): HandlerList {
        return handlerList
    }

    companion object {
        val handlerList = HandlerList()
    }
}

GuildWarStartEvent

/**
 * Called when a guild war has started
 * @param challenger the challenging guild for the war
 * @param defender the defending guild for the war
 */
class GuildWarStartEvent(val challenger: Guild, val defender: Guild) : Event() {

    override fun getHandlers(): HandlerList {
        return handlerList
    }

    companion object {
        val handlerList = HandlerList()
    }
}

PreviousPlaceholders NextVoteParty

Last updated 1 year ago