Index

A B C D E G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages

A

addMember(UUID) - Method in interface net.draycia.carbon.api.users.Party

Add a user to this party.

allKeys(Consumer<Key>) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

The provided action will be executed immediately for all currently registered channels.

allowed() - Static method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Returns a result denoting that the player is permitted for the action.

applyOptionalChatFilters() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Whether the optional chat filters apply to messages send to this player or not.

applyOptionalChatFilters(boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Whether the optional chat filters apply to messages send to this player or not.

awareOf(CarbonPlayer) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Whether this player can see the other player.

B

BOOTS - Static variable in class net.draycia.carbon.api.util.InventorySlot

C

Cancellable - Interface in net.draycia.carbon.api.event

Marks an event as cancellable.

cancelled() - Method in interface net.draycia.carbon.api.event.Cancellable

Gets if the event is cancelled.

cancelled(boolean) - Method in interface net.draycia.carbon.api.event.Cancellable

Sets the cancelled state.

CarbonChannelRegisterEvent - Interface in net.draycia.carbon.api.event.events

CarbonEvent that's called after new channels are registered.

carbonChat() - Static method in class net.draycia.carbon.api.CarbonChatProvider

Gets the currently registered CarbonChat implementation.

CarbonChat - Interface in net.draycia.carbon.api

The CarbonChat interface is the gateway to interacting with the majority of the CarbonChat API.

CarbonChatEvent - Interface in net.draycia.carbon.api.event.events

Event that's called when chat components are rendered for online players.

CarbonChatProvider - Class in net.draycia.carbon.api

Static accessor for the CarbonChat instance.

CarbonEvent - Interface in net.draycia.carbon.api.event

Marker interface for events.

CarbonEventHandler - Interface in net.draycia.carbon.api.event

The CarbonEventHandler is responsible for managing event subscriptions and emitting events.

CarbonEventSubscriber<T> - Interface in net.draycia.carbon.api.event

An EventSubscriber.

CarbonEventSubscription<T> - Interface in net.draycia.carbon.api.event

A subscription to a specific event type.

CarbonPlayer - Interface in net.draycia.carbon.api.users

Generic abstraction for players.

CarbonPlayer.ChannelMessage - Record Class in net.draycia.carbon.api.users

A message and which channel it should be sent in.

CarbonPrivateChatEvent - Interface in net.draycia.carbon.api.event.events

Called whenever a player privately messages another player.

CarbonServer - Interface in net.draycia.carbon.api

The server that carbon is running on.

channel() - Method in interface net.draycia.carbon.api.event.events.ChannelSwitchEvent

The channel the player is switching to.

channel() - Method in record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Returns the value of the channel record component.

channel(ChatChannel) - Method in interface net.draycia.carbon.api.event.events.ChannelSwitchEvent

Sets the player's new channel.

channel(Key) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Retrieve a channel by its key.

channelForMessage(Component) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Determines which channel the message should go to, and removes any channel prefixes from the message.

ChannelMessage(Component, ChatChannel) - Constructor for record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Creates an instance of a ChannelMessage record class.

channelOrDefault(Key) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Retrieve a channel by its key.

channelOrThrow(Key) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Retrieve a channel by its key.

channelPermissionResult(boolean, Supplier<Component>) - Static method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Create a ChannelPermissionResult based on allowed, computing denyReason when needed.

ChannelPermissionResult - Interface in net.draycia.carbon.api.channels

Represents the result of a channel permission check.

ChannelPermissions - Interface in net.draycia.carbon.api.channels

Permissions handling for a channel.

channelRegistry() - Method in interface net.draycia.carbon.api.CarbonChat

The registry that channels are registered to.

channelRegistry() - Method in interface net.draycia.carbon.api.event.events.CarbonChannelRegisterEvent

Gets the channel registry.

ChannelRegistry - Interface in net.draycia.carbon.api.channels

Registry for chat channels.

ChannelSwitchEvent - Interface in net.draycia.carbon.api.event.events

Called when a player switches channels.

chatChannel() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

The chat channel the message was sent in.

ChatChannel - Interface in net.draycia.carbon.api.channels

ChatChannel interface, supplies a formatter and filters recipients.
Extends Keyed for identification purposes.

ChatComponentRenderer - Interface in net.draycia.carbon.api.util

Renderer used to construct chat components on a per-player basis.

CHEST - Static variable in class net.draycia.carbon.api.util.InventorySlot

commandAliases() - Method in interface net.draycia.carbon.api.channels.ChatChannel

Alternative command names for this channel.

commandName() - Method in interface net.draycia.carbon.api.channels.ChatChannel

The text that can be used to refer to this channel in commands.

console() - Method in interface net.draycia.carbon.api.CarbonServer

The server's console.

cooldown() - Method in interface net.draycia.carbon.api.channels.ChatChannel

The time in milliseconds between player messages.

createItemHoverComponent(InventorySlot) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Creates the chat component for the item in the InventorySlot, or null if the slot is empty.

createParty(Component) - Method in interface net.draycia.carbon.api.users.UserManager

Create a new Party with the specified name.

D

deafened() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns if the player is deafened and unable to read messages.

deafened(boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Deafens and undeafens the player.

defaultChannel() - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Gets the default channel.

defaultKey() - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Gets the key for the default channel.

denied(Supplier<Component>) - Static method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Returns a result denoting that the action is denied for the player.

denied(Component) - Static method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Returns a result denoting that the action is denied for the player.

disband() - Method in interface net.draycia.carbon.api.users.Party

Disband this party.

displayName() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns the player's display name.

dispose() - Method in interface net.draycia.carbon.api.event.CarbonEventSubscription

Disposes this subscription.

distanceSquaredFrom(CarbonPlayer) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns the distance from the other CarbonPlayer, or -1 if the players are not in the same world.

dynamic() - Method in interface net.draycia.carbon.api.channels.ChannelPermissions

Returns whether the result of ChannelPermissions.joinPermitted(CarbonPlayer) is dynamic.

E

emit(T) - Method in interface net.draycia.carbon.api.event.CarbonEventHandler

Emits the supplied event.

emptyRadiusRecipientsMessage() - Method in interface net.draycia.carbon.api.channels.ChatChannel

If the empty receipt message should be sent to the sender.

equals(Object) - Method in record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Indicates whether some other object is "equal to" this one.

event() - Method in interface net.draycia.carbon.api.event.CarbonEventSubscription

Gets the event type.

eventHandler() - Method in interface net.draycia.carbon.api.CarbonChat

The event handler, used for listening to and emitting events.

G

groups() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns the complete list of groups the player is in.

H

hashCode() - Method in record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Returns a hash code value for this object.

hasNickname() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Checks if the player has a nickname set.

hasPermission(String) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Checks if the player has the specified permission.

hearingPermitted(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChannelPermissions

Checks if the player may receive messages from this channel.

HELMET - Static variable in class net.draycia.carbon.api.util.InventorySlot

I

id() - Method in interface net.draycia.carbon.api.users.Party

Get the unique id of this party.

ignoring() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Gets the ids of the players this player is currently ignoring.

ignoring(UUID) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Checks if the other player is being ignored by this player.

ignoring(UUID, boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Adds the player to and removes the player from the ignore list.

ignoring(CarbonPlayer) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Checks if the other player is being ignored by this player.

ignoring(CarbonPlayer, boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Adds the player to and removes the player from the ignore list.

ignoringDirectMessages() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Controls if the player should receive direct messages or if they should be hidden.

ignoringDirectMessages(boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets whether the player should receive direct messages or if they should be hidden.

InventorySlot - Class in net.draycia.carbon.api.util

A slot in a player's inventory.

J

joinChannel(ChatChannel) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Join a channel for this player if they have left it.

joinPermitted(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChannelPermissions

Checks if the player may join this channel.

K

keyedRenderer(Key, ChatComponentRenderer) - Static method in interface net.draycia.carbon.api.util.KeyedRenderer

Creates a new renderer with the corresponding key.

KeyedRenderer - Interface in net.draycia.carbon.api.util

A chat renderer that's identifiable by key.

keys() - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Gets the list of registered channel keys.

L

lastWhisperTarget() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The last player this player has whispered.

lastWhisperTarget(UUID) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets the last player this player has whispered.

leaveChannel(ChatChannel) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Leave a channel for this player.

leftChannels() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

A list of all the channels the player has left using the leave command.

LEGS - Static variable in class net.draycia.carbon.api.util.InventorySlot

locale() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The player's locale.

M

MAIN_HAND - Static variable in class net.draycia.carbon.api.util.InventorySlot

members() - Method in interface net.draycia.carbon.api.users.Party

Get a snapshot of the current party members.

message() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

Get the chat message that will be sent.

message() - Method in interface net.draycia.carbon.api.event.events.CarbonPrivateChatEvent

The message that will be sent.

message() - Method in record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Returns the value of the message record component.

message(Component) - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

Set the chat message that will be sent.

message(Component) - Method in interface net.draycia.carbon.api.event.events.CarbonPrivateChatEvent

Sets the message that will be sent.

muted() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns if the player is muted.

muted(boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Mutes and unmutes the player.

muteExpiration() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The time the mute will expire, in epoch millis.

muteExpiration(long) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets the epoch time the player's mute will expire.

N

name() - Method in interface net.draycia.carbon.api.users.Party

Get the name of this party.

net.draycia.carbon.api - package net.draycia.carbon.api

net.draycia.carbon.api.channels - package net.draycia.carbon.api.channels

net.draycia.carbon.api.event - package net.draycia.carbon.api.event

net.draycia.carbon.api.event.events - package net.draycia.carbon.api.event.events

net.draycia.carbon.api.users - package net.draycia.carbon.api.users

net.draycia.carbon.api.util - package net.draycia.carbon.api.util

nickname() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Gets the player's nickname, shown in places like chat and tab menu.

nickname(Component) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets the player's nickname.

O

of(String...) - Static method in class net.draycia.carbon.api.util.InventorySlot

An InventorySlot instance, usable in chat with the given placeholders.

OFF_HAND - Static variable in class net.draycia.carbon.api.util.InventorySlot

on(T) - Method in interface net.draycia.carbon.api.event.CarbonEventSubscriber

Invokes this event consumer.

online() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns whether the player is online.

originalMessage() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

Get the original message that was sent.

P

party() - Method in interface net.draycia.carbon.api.event.events.PartyJoinEvent

The party being joined.

party() - Method in interface net.draycia.carbon.api.event.events.PartyLeaveEvent

The party being left.

party() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Get this player's current Party.

party(UUID) - Method in interface net.draycia.carbon.api.users.UserManager

Look up an existing party by its id.

Party - Interface in net.draycia.carbon.api.users

Reference to a chat party.

PartyJoinEvent - Interface in net.draycia.carbon.api.event.events

Called when a player is added to a Party.

PartyLeaveEvent - Interface in net.draycia.carbon.api.event.events

Called when a player is removed from a Party.

permission(String) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Create a channel permissions handler for the provided base permission string.

permissions() - Method in interface net.draycia.carbon.api.channels.ChatChannel

Returns the permissions handler for the channel.

permitted() - Method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Check whether the action checked was permitted.

placeholders() - Method in class net.draycia.carbon.api.util.InventorySlot

Returns this slot's placeholders, which can be used in chat to show the item in said slot.

player() - Method in interface net.draycia.carbon.api.event.events.ChannelSwitchEvent

The player switching channels.

playerCooldown(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChatChannel

The epoch time (millis) when the player's cooldown expires.

playerId() - Method in interface net.draycia.carbon.api.event.events.PartyJoinEvent

ID of the player joining a party.

playerId() - Method in interface net.draycia.carbon.api.event.events.PartyLeaveEvent

ID of the player leaving a party.

players() - Method in interface net.draycia.carbon.api.CarbonServer

The players that are online on the server.

primaryGroup() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns the player's primary group.

Q

quickPrefix() - Method in interface net.draycia.carbon.api.channels.ChatChannel

Messages will be sent in this channel if they start with this prefix.

R

radius() - Method in interface net.draycia.carbon.api.channels.ChatChannel

The distance from the sender players must be to receive chat messages.
Return of '0' means players must be in the same world/server.
Return of '-1' means there is no radius.

reason() - Method in interface net.draycia.carbon.api.channels.ChannelPermissionResult

Reason for permission being denied.

recipient() - Method in interface net.draycia.carbon.api.event.events.CarbonPrivateChatEvent

The message recipient.

recipients() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

The recipients of the message.

recipients(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChatChannel

Returns a list of all recipients that will receive messages from the sender.

register(CarbonChat) - Static method in class net.draycia.carbon.api.CarbonChatProvider

Registers the CarbonChat implementation.

register(ChatChannel) - Method in interface net.draycia.carbon.api.channels.ChannelRegistry

Registers the chat channel with its key.

registered() - Method in interface net.draycia.carbon.api.event.events.CarbonChannelRegisterEvent

Gets the key(s) that were registered to trigger this event.

removeMember(UUID) - Method in interface net.draycia.carbon.api.users.Party

Remove a user from this party.

render(CarbonPlayer, Audience, Component, Component) - Method in interface net.draycia.carbon.api.util.ChatComponentRenderer

Renders a Component for the specified recipient.

renderers() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

Get the renderers used to construct components for each of the recipients.

S

sameWorldAs(CarbonPlayer) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns if both players are in the same world or server.

selectedChannel() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The player's selected channel, or null if one isn't set.

selectedChannel(ChatChannel) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets the player's selected channel.

sender() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

Get the sender of the message.

sender() - Method in interface net.draycia.carbon.api.event.events.CarbonPrivateChatEvent

The message sender.

sendMessageAsPlayer(String) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sends the message as the player.

server() - Method in interface net.draycia.carbon.api.CarbonChat

The server that carbon is running on.

shouldCrossServer() - Method in interface net.draycia.carbon.api.channels.ChatChannel

Whether messages from this channel should be broadcast and sent to other servers.

shouldRegisterCommands() - Method in interface net.draycia.carbon.api.channels.ChatChannel

If commands should be registered for this channel.

signedMessage() - Method in interface net.draycia.carbon.api.event.events.CarbonChatEvent

If the message is being previewed by the player.

SLOTS - Static variable in class net.draycia.carbon.api.util.InventorySlot

speechPermitted(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChannelPermissions

Checks if the player may send messages in this channel.

spying() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Returns if the player is spying on messages and able to read muted/private messages.

spying(boolean) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets and unsets the player's ability to spy.

startCooldown(CarbonPlayer) - Method in interface net.draycia.carbon.api.channels.ChatChannel

Starts the cooldown timer for the specified player.

subscribe(Class<T>, int, boolean, CarbonEventSubscriber<T>) - Method in interface net.draycia.carbon.api.event.CarbonEventHandler

Registers a subscriber for the given event class.
Includes extra values to control when the consumer is executed.

subscribe(Class<T>, CarbonEventSubscriber<T>) - Method in interface net.draycia.carbon.api.event.CarbonEventHandler

Registers a subscriber for the given event class.

subscriber() - Method in interface net.draycia.carbon.api.event.CarbonEventSubscription

Gets the subscriber.

T

toString() - Method in record class net.draycia.carbon.api.users.CarbonPlayer.ChannelMessage

Returns a string representation of this record class.

U

uniformDynamic(Function<CarbonPlayer, ChannelPermissionResult>) - Static method in interface net.draycia.carbon.api.channels.ChannelPermissions

Creates a new ChannelPermissions that performs the same check for ChannelPermissions.joinPermitted(CarbonPlayer), ChannelPermissions.hearingPermitted(CarbonPlayer), and ChannelPermissions.speechPermitted(CarbonPlayer).

user(UUID) - Method in interface net.draycia.carbon.api.users.UserManager

Gets the CarbonPlayer for the provided player UUID, whether they are online or not.

userManager() - Method in interface net.draycia.carbon.api.CarbonChat

The user manager.

UserManager<C> - Interface in net.draycia.carbon.api.users

Manager used to load/obtain and save CarbonPlayers.

username() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Gets the player's username.

uuid() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The player's UUID, often used for identification purposes.

V

vanished() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

If this player is vanished in another supported plugin.

W

whisperReplyTarget() - Method in interface net.draycia.carbon.api.users.CarbonPlayer

The UUID of the player that replies will be sent to.

whisperReplyTarget(UUID) - Method in interface net.draycia.carbon.api.users.CarbonPlayer

Sets the whisper reply target for this player.

A B C D E G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages