BlazeBans API/Reference

Type reference

Every public type in `net.blazebans.api`, in one place. Twenty-three classes.

BlazeBansProvider

Static holder. net.blazebans.api.BlazeBansProvider.

Method	Returns	Notes
`get()`	`BlazeBansApi`	Throws `IllegalStateException` when unavailable
`optional()`	`Optional<BlazeBansApi>`	Empty when unavailable
`available()`	`boolean`	Whether it is registered right now
`register(api)`	`void`	BlazeBans only. Do not call
`unregister(api)`	`void`	BlazeBans only. Do not call
`registerAddon(addon)`	`void`	Adds or replaces addon metadata
`unregisterAddon(pluginId)`	`void`	Removes it
`addons()`	`List<BlazeBansAddon>`	Sorted by display name
`addon(pluginId)`	`Optional<BlazeBansAddon>`	Case-insensitive lookup

BlazeBansApi

Method	Returns
`version()`	`String`
`punishments()`	`PunishmentService`
`players()`	`PlayerService`

PunishmentService

Every method returns a CompletableFuture. See Threading.

Method	Completes with
`isBanned(name, uuid)`	`Boolean`
`isBanned(name, uuid, ipAddress)`	`Boolean`
`isMuted(name, uuid)`	`Boolean`
`isMuted(name, uuid, ipAddress)`	`Boolean`
`activeBan(name, uuid)`	`Optional<Punishment>`
`activeBan(name, uuid, ipAddress)`	`Optional<Punishment>`
`activeMute(name, uuid)`	`Optional<Punishment>`
`activeMute(name, uuid, ipAddress)`	`Optional<Punishment>`
`activePunishment(type, name, uuid)`	`Optional<Punishment>`
`punishmentById(id)`	`Optional<Punishment>`
`history(target)`	`List<Punishment>`
`activeBans()`	`List<Punishment>`
`activeMutes()`	`List<Punishment>`
`activeWarns()`	`List<Punishment>`
`createPunishment(request)`	`Optional<Punishment>`
`revokePunishment(id, staffName, reason)`	`Optional<Punishment>`
`revokeActive(request)`	`Optional<Punishment>`
`editReason(id, reason)`	`Optional<Punishment>`

target accepts a name, a UUID string, or a raw IP address. IDs work with or without the #.

PlayerService

Method	Completes with
`recordPlayer(name, uuid, ipAddress)`	`Void`
`profile(target)`	`Optional<PlayerProfile>`
`knownPlayerNames()`	`List<String>`
`alts(target)`	`List<PlayerProfile>`
`nameHistory(target)`	`List<PlayerNameEntry>`

Punishment

Immutable record.

Component	Type	Nullable
`id()`	`String`	no
`type()`	`PunishmentType`	no
`targetName()`	`String`	no
`targetUuid()`	`UUID`	yes
`staffName()`	`String`	no
`staffUuid()`	`UUID`	yes
`reason()`	`String`	no
`createdAt()`	`Instant`	no
`expiresAt()`	`Instant`	yes, null means permanent
`revokedAt()`	`Instant`	yes
`revokedBy()`	`String`	yes
`revokeReason()`	`String`	yes
`proofUrl()`	`String`	no, blank when absent
`serverScope()`	`String`	no
`serverId()`	`String`	no, blank when global
`silent()`	`boolean`	no

Derived:

Method	Returns
`active()`	`true` only while neither revoked nor expired
`permanent()`	`true` when `expiresAt` is null
`status()`	`ACTIVE`, `REVOKED`, or `EXPIRED`, computed on call

PunishmentCreateRequest

Mutable. Every field has a getter and a setter of the same name.

Constructor order: type, targetName, targetUuid, targetIpAddress, staffName, staffUuid, duration, reason, proofUrl, serverScope, serverId, silent.

Field	Type	Behaviour
`type`	`PunishmentType`	Throws on null
`targetName`	`String`	Null becomes `""`
`targetUuid`	`UUID`	Null allowed
`targetIpAddress`	`String`	Null becomes `""`
`staffName`	`String`	Null becomes `""`
`staffUuid`	`UUID`	Null allowed
`duration`	`Duration`	Null becomes `Duration.ZERO`, which is permanent
`reason`	`String`	Null becomes `""`, which uses the configured default
`proofUrl`	`String`	Null becomes `""`
`serverScope`	`String`	Null becomes `""`
`serverId`	`String`	Null becomes `""`
`silent`	`boolean`

PunishmentRevokeRequest

Constructor: types, target, staffName, reason.

Member	Type	Mutable
`types()`	`List<PunishmentType>`	no, copied on construction
`target()`	`String`	no
`staffName()`	`String`	yes
`reason()`	`String`	yes

Enums

PunishmentType: BAN, MUTE, WARN, KICK, IP_BAN, IP_MUTE, VOICE_MUTE

PunishmentStatus: ACTIVE, REVOKED, EXPIRED

PunishmentScope: GLOBAL, SERVER

BlazeBansEnforcementType: BAN_LOGIN, KICK, MUTE_CHAT, MUTE_COMMAND

Records carry scope as a string rather than the enum, so compare case-insensitively.

PlayerProfile

Record: name(), uuid(), lastSeen(). UUID and instant may be null.

PlayerNameEntry

Record: name(), uuid(), seenAt(), source(). UUID and instant may be null.

BlazeBansAddon

Record: pluginId(), name(), version(), description(), status().

All five are trimmed on construction, and null becomes "". pluginId and name throw IllegalArgumentException if blank.

Events

All extend org.bukkit.event.Event and implement Cancellable.

Event	Members
`BlazeBansPunishmentCreateEvent`	`request()`
`BlazeBansPunishmentCreatedEvent`	`punishment()`, `enforcementDelay()`, `enforcementDelay(Duration)`
`BlazeBansPunishmentRevokeEvent`	`request()`
`BlazeBansPunishmentRevokedEvent`	`punishment()`
`BlazeBansPunishmentEnforceEvent`	`enforcementType()`, `punishment()`, `playerName()`, `playerUuid()`
`BlazeBansMutedChatEvent`	`punishment()`, `playerName()`, `playerUuid()`, `message()`
`BlazeBansMutedCommandEvent`	`punishment()`, `playerName()`, `playerUuid()`, `command()`

enforcementDelay(Duration) clamps null and negative values to zero, and the Paper implementation caps the total at five seconds.

What cancelling each one does is in Event reference.

AddonConsole

Constructors:

java

new AddonConsole(String addonName, Consumer<Component> output);
new AddonConsole(String addonName, Consumer<Component> output, Consumer<String> trueColorOutput);

addonName cannot be blank.

Method	Colour
`blank()`	empty line
`info(message)`	light grey
`step(message)`	blaze orange
`success(message)`	green
`warning(message)`	amber
`error(message)`	red
`error(message, throwable)`	red, with the stack trace

Every line is prefixed [BlazeBans <addonName>].

Package layout

txt

net.blazebans.api
  BlazeBansApi
  BlazeBansProvider
net.blazebans.api.addon
  BlazeBansAddon
net.blazebans.api.console
  AddonConsole
  TrueColorAnsi
net.blazebans.api.event
  BlazeBansEnforcementType
  BlazeBansMutedChatEvent
  BlazeBansMutedCommandEvent
  BlazeBansPunishmentCreateEvent
  BlazeBansPunishmentCreatedEvent
  BlazeBansPunishmentEnforceEvent
  BlazeBansPunishmentRevokeEvent
  BlazeBansPunishmentRevokedEvent
net.blazebans.api.player
  PlayerNameEntry
  PlayerProfile
  PlayerService
net.blazebans.api.punishment
  Punishment
  PunishmentCreateRequest
  PunishmentRevokeRequest
  PunishmentScope
  PunishmentService
  PunishmentStatus
  PunishmentType

These names are frozen across releases. Nothing outside this package is supported.