Guilds/me.glaremasters.guilds.api/GuildsAPI

GuildsAPI

class GuildsAPI(val guildHandler: GuildHandler, val cooldownHandler: CooldownHandler)(source)

The GuildsAPI class provides functions for accessing information about guilds.

Parameters

guildHandler

: an instance of the GuildHandler class

cooldownHandler

: an instance of the CooldownHandler class

Constructors

fun GuildsAPI(guildHandler: GuildHandler, cooldownHandler: CooldownHandler)

Functions

fun getGuild(uuid: UUID): Guild?

Get a guild by its UUID.

fun getGuild(name: String): Guild?

Get a guild by its name.

fun getGuild(player: OfflinePlayer): Guild?

Get the guild of a player.

getGuildByPlayerId

fun getGuildByPlayerId(uuid: UUID): Guild?

Get a guild by the UUID of a player.

fun getGuildMember(uuid: UUID): GuildMember?

Get a guild member by their UUID.

fun getGuildRole(player: Player): GuildRole?

Get the role of a player.

fun getGuildVault(guild: Guild, vaultNumber: Int): Inventory

Get a copy of one of a guild's vaults.

Properties

cooldownHandler

val cooldownHandler: CooldownHandler

val guildHandler: GuildHandler