Index (api 2.2.4-SNAPSHOT API)

A C D E F G H I L N O P R S T U V W

A

addAddon(InjectorAddon) - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

Adds an addon to the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel).
addHandshakeHandler(HandshakeHandler) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeHandlers: Deprecated.

Register a custom handshake handler.
addProperty(PropertyKey, Object) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
addProperty(String, Object) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
andThen(Function<? super R, ? extends S>) - Method in interface org.geysermc.floodgate.api.util.TriFunction: Returns a composed function that first applies this function to its input, and then applies the after function to the result.
apply(T, U, V) - Method in interface org.geysermc.floodgate.api.util.TriFunction: Performs this operation on the given arguments.
as(Class<T>) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Casts the FloodgatePlayer instance to a class that extends FloodgatePlayer.

C

canRemoveInjection() - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

Some platforms may not be able to remove their injection process.
closeForm(UUID) - Method in interface org.geysermc.floodgate.api.FloodgateApi
createJavaPlayerId(long) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Create a valid Java player uuid of a xuid
createLinkRequest(UUID, String, String) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Creates a link request for the given Java player.
currentSkin() - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent: Returns the skin texture currently applied to the player.

D

debug(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs a debug message to the console, with 0 or more arguments.
deregister(PacketHandler) - Method in interface org.geysermc.floodgate.api.packet.PacketHandlers: Deprecated.

Unregisters all handlers registered under the given packet handler

E

error(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs an error message to the console, with 0 or more arguments.
error(String, Throwable, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs an error message to the console, with 0 or more arguments.

F

FloodgateApi - Interface in org.geysermc.floodgate.api
FloodgateEventBus - Interface in org.geysermc.floodgate.api.event
FloodgateLogger - Interface in org.geysermc.floodgate.api.logger
FloodgatePlayer - Interface in org.geysermc.floodgate.api.player
FloodgateSubscriber<T> - Interface in org.geysermc.floodgate.api.event

G

getApi() - Static method in class org.geysermc.floodgate.api.InstanceHolder
getBedrockData() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the decrypted BedrockData sent by Geyser or null if the player isn't a Floodgate player.
getBedrockUsername() - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Returns the username of player being linked.
getChannel() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the Channel holding the connection between the client and the server.
getCorrectUniqueId() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.
getCorrectUniqueId() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the uuid that the server will use as uuid of that player.
getCorrectUsername() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.
getCorrectUsername() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the username the server will as username for that player.
getDeviceOs() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the Operating System of the Bedrock client
getDisconnectReason() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the reason to disconnect the current player.
getEventBus() - Method in interface org.geysermc.floodgate.api.FloodgateApi
getEventBus() - Static method in class org.geysermc.floodgate.api.InstanceHolder
getGamertagFor(long) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Get the gamertag of the user that has the given xuid.
getHandshakeHandlers() - Static method in class org.geysermc.floodgate.api.InstanceHolder: Deprecated.
Handshake handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
getHostname() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the hostname used in the handshake packet.
getInjector() - Static method in class org.geysermc.floodgate.api.InstanceHolder: Deprecated.
Injector addons will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
getInputMode() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the Input Mode of the Bedrock client
getInstance() - Static method in interface org.geysermc.floodgate.api.FloodgateApi: Returns the Floodgate API instance.
getIp() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the IP address of the client.
getJavaUniqueId() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.
getJavaUniqueId() - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Returns the Java unique id of the linked player.
getJavaUniqueId() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the uuid that will be used as UUID on the server.
Note that this field is not used when the player is a LinkedPlayer
getJavaUsername() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.
getJavaUsername() - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Returns the Java username of the linked player.
getJavaUsername() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the Bedrock username that will be used as username on the server.
getKey() - Method in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.
getLanguageCode() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the language code of the Bedrock client
getLinkCode() - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Returns the code that the Bedrock player has to enter in order to link the account.
getLinkedPlayer() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns the linked account associated with the client or null if the player isn't linked or not a Floodgate player.
getLinkedPlayer(UUID) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Get a linked player by the bedrock uuid
getLinkedPlayer() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the LinkedPlayer object if the player is linked to a Java account.
getName() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Returns the name of this database implementation.
getPacketHandlers() - Static method in class org.geysermc.floodgate.api.InstanceHolder: Deprecated.
Packet handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
getPlayer(UUID) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Get info about the given Bedrock player
getPlayerCount() - Method in interface org.geysermc.floodgate.api.FloodgateApi: Returns the number of Floodgate players who are currently online.
getPlayerLink() - Method in interface org.geysermc.floodgate.api.FloodgateApi: Returns the instance that manages all the linking.
getPlayerLink() - Static method in class org.geysermc.floodgate.api.InstanceHolder
getPlayerPrefix() - Method in interface org.geysermc.floodgate.api.FloodgateApi: Returns the character(s) that will be added in front of a Bedrock player's name to prevent username duplicates.
getPlayers() - Method in interface org.geysermc.floodgate.api.FloodgateApi: Returns all the online Floodgate players.
getProperty(PropertyKey) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
getProperty(String) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
getRequestTime() - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Returns the unix time when the player link was requested.
getUiProfile() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the User Interface Profile of the Bedrock client
getUsername() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the real username of the Bedrock client.
getUuidFor(String) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Get the xuid of the player that has the given gamertag.
getVerifyLinkTimeout() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Returns the duration (in seconds) before a LinkRequest timeouts
getVersion() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the version of the Bedrock client
getXuid() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns the Xbox Unique Identifier of the Bedrock client
getXuidFor(String) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Get the xuid of the user that has the given gamertag.

H

handle(HandshakeData) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeHandler: Deprecated.

Method that will be called during the time that Floodgate handles the handshake.
handle(ChannelHandlerContext, Object, boolean) - Method in interface org.geysermc.floodgate.api.packet.PacketHandler: Deprecated.

Called when a registered packet has been seen.
HandshakeData - Interface in org.geysermc.floodgate.api.handshake: Deprecated.
Handshake handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
HandshakeHandler - Interface in org.geysermc.floodgate.api.handshake: Deprecated.
Handshake handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
HandshakeHandlers - Interface in org.geysermc.floodgate.api.handshake: Deprecated.
Handshake handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
hasProperty(PropertyKey) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
hasProperty(String) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.

I

info(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs an info message to the console, with 0 or more arguments.
inject() - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

Injects the server connection.
InjectorAddon - Interface in org.geysermc.floodgate.api.inject: Deprecated.
Injector addons will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
InstanceHolder - Class in org.geysermc.floodgate.api
InstanceHolder() - Constructor for class org.geysermc.floodgate.api.InstanceHolder
isAddAllowed(Object) - Method in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.
isAllowLinking() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Return if account linking is allowed.
isChangeable() - Method in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.
isDebug() - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Returns true if debugging is enabled
isEnabled() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Return if account linking is enabled.
isEnabledAndAllowed() - Method in interface org.geysermc.floodgate.api.link.PlayerLink
isExpired(long) - Method in interface org.geysermc.floodgate.api.link.LinkRequest: If this player link request is expired.
isFloodgateId(UUID) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Checks if the uuid of the player has the FloodgateApi.createJavaPlayerId(long) format.
isFloodgatePlayer(UUID) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Method to determine if the given online player is a bedrock player
isFloodgatePlayer() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns true if the given player is a Floodgate player, false otherwise.
isFromProxy() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns if the Floodgate player is connected through a proxy
isInjected() - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

If the server connection is currently injected.
isLinked() - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Returns true if the player is linked to a Java account
isLinkedPlayer(UUID) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Tells if the given player is a linked player
isRemovable() - Method in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.
isRequestedPlayer(FloodgatePlayer) - Method in interface org.geysermc.floodgate.api.link.LinkRequest: Checks if the given FloodgatePlayer is the player requested in this LinkRequest.

L

linkPlayer(UUID, UUID, String) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Links a Java account to a Bedrock account.
LinkRequest - Interface in org.geysermc.floodgate.api.link
LinkRequestResult - Enum in org.geysermc.floodgate.api.link: This enum has all the available result types of both creating a player link request and validating it.
load() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Called by Floodgate after the initialization of the class.
LOGGER_NAME - Static variable in interface org.geysermc.floodgate.api.logger.FloodgateLogger

N

newSkin() - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent: Returns the skin texture to be applied to the player.
newSkin(SkinApplyEvent.SkinData) - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent: Sets the skin texture to be applied to the player

O

onChannelClosed(Channel) - Method in interface org.geysermc.floodgate.api.inject.InjectorAddon: Deprecated.

Called when the channel has been closed.
onInject(Channel, boolean) - Method in interface org.geysermc.floodgate.api.inject.InjectorAddon: Deprecated.

Called when injecting a specific channel (every client that is connected to the server has his own channel).
onRemoveInject(Channel) - Method in interface org.geysermc.floodgate.api.inject.InjectorAddon: Deprecated.

Called when Floodgate is removing the injection from the server.
org.geysermc.floodgate.api - package org.geysermc.floodgate.api
org.geysermc.floodgate.api.event - package org.geysermc.floodgate.api.event
org.geysermc.floodgate.api.event.skin - package org.geysermc.floodgate.api.event.skin
org.geysermc.floodgate.api.handshake - package org.geysermc.floodgate.api.handshake
org.geysermc.floodgate.api.inject - package org.geysermc.floodgate.api.inject
org.geysermc.floodgate.api.link - package org.geysermc.floodgate.api.link
org.geysermc.floodgate.api.logger - package org.geysermc.floodgate.api.logger
org.geysermc.floodgate.api.packet - package org.geysermc.floodgate.api.packet
org.geysermc.floodgate.api.player - package org.geysermc.floodgate.api.player
org.geysermc.floodgate.api.unsafe - package org.geysermc.floodgate.api.unsafe
org.geysermc.floodgate.api.util - package org.geysermc.floodgate.api.util

P

PacketHandler - Interface in org.geysermc.floodgate.api.packet: Deprecated.
Packet handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
PacketHandlers - Interface in org.geysermc.floodgate.api.packet: Deprecated.
Packet handlers will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
PlatformInjector - Interface in org.geysermc.floodgate.api.inject: Deprecated.
Injector addons will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.
player() - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent: Returns the player that will receive the skin.
PlayerLink - Interface in org.geysermc.floodgate.api.link: The base class of the PlayerLink database implementation.
PropertyKey - Class in org.geysermc.floodgate.api.player: Deprecated.
PropertyKey(String, boolean, boolean) - Constructor for class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.
PropertyKey.Result - Enum in org.geysermc.floodgate.api.player: Deprecated.

R

register(PacketHandler, Class<?>, TriFunction<ChannelHandlerContext, Object, Boolean, Object>) - Method in interface org.geysermc.floodgate.api.packet.PacketHandlers: Deprecated.

Register a specific class for a specific consumer.
register(PacketHandler, Class<?>) - Method in interface org.geysermc.floodgate.api.packet.PacketHandlers: Deprecated.

Register a specific class for the given packet handler's PacketHandler.handle(ChannelHandlerContext, Object, boolean).
registerAll(PacketHandler) - Method in interface org.geysermc.floodgate.api.packet.PacketHandlers: Deprecated.

Register every packet for the given packet handler's PacketHandler.handle(ChannelHandlerContext, Object, boolean)
removeAddon(Class<T>) - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

Removes an addon from the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel).
removeHandshakeHandler(int) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeHandlers: Deprecated.

Removes a custom handshake handler by id.
removeHandshakeHandler(Class<? extends HandshakeHandler>) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeHandlers: Deprecated.

Remove a custom handshake handler by instance.
removeInjection() - Method in interface org.geysermc.floodgate.api.inject.PlatformInjector: Deprecated.

Removes the injection from the server.
removeProperty(PropertyKey) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
removeProperty(String) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.

S

sendForm(UUID, Form) - Method in interface org.geysermc.floodgate.api.FloodgateApi
sendForm(UUID, FormBuilder<?, ?, ?>) - Method in interface org.geysermc.floodgate.api.FloodgateApi
sendForm(UUID, Form<?>) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Deprecated.
since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.
sendForm(UUID, FormBuilder<?, ?>) - Method in interface org.geysermc.floodgate.api.FloodgateApi: Deprecated.
since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.
sendForm(Form) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer
sendForm(FormBuilder<?, ?, ?>) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer
sendForm(Form<?>) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.
sendForm(FormBuilder<?, ?>) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer: Deprecated.
since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.
sendPacket(UUID, int, byte[]) - Method in interface org.geysermc.floodgate.api.unsafe.Unsafe: Send a raw Bedrock packet to the given online Bedrock player.
sendPacket(FloodgatePlayer, int, byte[]) - Method in interface org.geysermc.floodgate.api.unsafe.Unsafe: Send a raw Bedrock packet to the given online Bedrock player.
set(FloodgateApi, PlayerLink, FloodgateEventBus, PlatformInjector, PacketHandlers, HandshakeHandlers, UUID) - Static method in class org.geysermc.floodgate.api.InstanceHolder
setDisconnectReason(String) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Set the reason to disconnect the current player.
setHostname(String) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Set the hostname of the handshake packet.
setIp(String) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Set the IP address of the connected client.
setLinkedPlayer(LinkedPlayer) - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Set the LinkedPlayer.
shouldDisconnect() - Method in interface org.geysermc.floodgate.api.handshake.HandshakeData: Deprecated.

Returns if the player should be disconnected
shouldInject() - Method in interface org.geysermc.floodgate.api.inject.InjectorAddon: Deprecated.

If the Injector should call InjectorAddon.onInject(Channel, boolean)
signature() - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent.SkinData: Returns the signature of the skin texture.
SKIN_UPLOADED - Static variable in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.

Skin Uploaded returns a SkinData object containing the value and signature of the Skin
SkinApplyEvent - Interface in org.geysermc.floodgate.api.event.skin: An event that's fired when Floodgate receives a player skin.
SkinApplyEvent.SkinData - Interface in org.geysermc.floodgate.api.event.skin
SOCKET_ADDRESS - Static variable in class org.geysermc.floodgate.api.player.PropertyKey: Deprecated.

Socket Address returns the InetSocketAddress of the Bedrock player
stop() - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Called when the Floodgate plugin is going to shutdown

T

trace(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs a trace message to the console, with 0 or more arguments.
transfer(String, int) - Method in interface org.geysermc.floodgate.api.player.FloodgatePlayer
transferPlayer(UUID, String, int) - Method in interface org.geysermc.floodgate.api.FloodgateApi
translatedInfo(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger
TriFunction<T,U,V,R> - Interface in org.geysermc.floodgate.api.util: Represents a function that accepts three arguments and produces a result.

U

unlinkPlayer(UUID) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Unlinks a Java account from a Bedrock account.
unsafe() - Method in interface org.geysermc.floodgate.api.FloodgateApi
Unsafe - Interface in org.geysermc.floodgate.api.unsafe

V

value() - Method in interface org.geysermc.floodgate.api.event.skin.SkinApplyEvent.SkinData: Returns the value of the skin texture.
valueOf(String) - Static method in enum org.geysermc.floodgate.api.link.LinkRequestResult: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.geysermc.floodgate.api.player.PropertyKey.Result: Deprecated.

Returns the enum constant of this type with the specified name.
values() - Static method in enum org.geysermc.floodgate.api.link.LinkRequestResult: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.geysermc.floodgate.api.player.PropertyKey.Result: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
verifyLinkRequest(UUID, String, String, String) - Method in interface org.geysermc.floodgate.api.link.PlayerLink: Verifies a link request for the given Bedrock player.

W

warn(String, Object...) - Method in interface org.geysermc.floodgate.api.logger.FloodgateLogger: Logs a warning message to the console, with 0 or more arguments.

A C D E F G H I L N O P R S T U V W