From bdb1aed40cd31fdd0bc96e4b6f812af2c546036a Mon Sep 17 00:00:00 2001 From: BlueTree242 Date: Mon, 22 Apr 2024 10:37:26 +0200 Subject: [PATCH] Add GeyserCustomPayloadEvent --- .../event/java/GeyserCustomPayloadEvent.java | 66 +++++++++++++++++++ .../java/JavaCustomPayloadTranslator.java | 6 ++ 2 files changed, 72 insertions(+) create mode 100644 api/src/main/java/org/geysermc/geyser/api/event/java/GeyserCustomPayloadEvent.java diff --git a/api/src/main/java/org/geysermc/geyser/api/event/java/GeyserCustomPayloadEvent.java b/api/src/main/java/org/geysermc/geyser/api/event/java/GeyserCustomPayloadEvent.java new file mode 100644 index 000000000..92f9899c7 --- /dev/null +++ b/api/src/main/java/org/geysermc/geyser/api/event/java/GeyserCustomPayloadEvent.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2019-2024 GeyserMC. http://geysermc.org + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + * @author GeyserMC + * @link https://github.com/GeyserMC/Geyser + */ + +package org.geysermc.geyser.api.event.java; + +import org.checkerframework.checker.nullness.qual.NonNull; +import org.geysermc.geyser.api.connection.GeyserConnection; +import org.geysermc.geyser.api.event.connection.ConnectionEvent; + +/** + * Called when the java server sends a custom payload to geyser. + * An extension/addon can use this event to translate this. + * This event is not called when a built-in supported custom payload + * such as floodgate is received. + */ +public class GeyserCustomPayloadEvent extends ConnectionEvent { + + private final String channel; + private final byte[] data; + + public GeyserCustomPayloadEvent(@NonNull GeyserConnection connection, @NonNull String channel, byte[] data) { + super(connection); + this.channel = channel; + this.data = data; + } + + /** + * The channel that sent this custom payload. + * A channel would look something like this: + * minecraft:register. + * @return the channel that sent this custom payload. + */ + public @NonNull String getChannel() { + return channel; + } + + /** + * The data field of the custom payload. + * @return the data field of the custom payload. + */ + public byte[] getData() { + return data; + } +} diff --git a/core/src/main/java/org/geysermc/geyser/translator/protocol/java/JavaCustomPayloadTranslator.java b/core/src/main/java/org/geysermc/geyser/translator/protocol/java/JavaCustomPayloadTranslator.java index 2a7202b0c..a3fddb211 100644 --- a/core/src/main/java/org/geysermc/geyser/translator/protocol/java/JavaCustomPayloadTranslator.java +++ b/core/src/main/java/org/geysermc/geyser/translator/protocol/java/JavaCustomPayloadTranslator.java @@ -42,6 +42,7 @@ import org.geysermc.erosion.packet.geyserbound.GeyserboundPacket; import org.geysermc.floodgate.pluginmessage.PluginMessageChannels; import org.geysermc.geyser.GeyserImpl; import org.geysermc.geyser.GeyserLogger; +import org.geysermc.geyser.api.event.java.GeyserCustomPayloadEvent; import org.geysermc.geyser.session.GeyserSession; import org.geysermc.geyser.translator.protocol.PacketTranslator; import org.geysermc.geyser.translator.protocol.Translator; @@ -138,6 +139,11 @@ public class JavaCustomPayloadTranslator extends PacketTranslator