Geyser/core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockStructureTemplateDataRequestTranslator.java

/*
 * 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.translator.protocol.bedrock;

import com.github.steveice10.mc.protocol.data.game.inventory.UpdateStructureBlockAction;
import com.github.steveice10.mc.protocol.data.game.inventory.UpdateStructureBlockMode;
import org.cloudburstmc.math.vector.Vector3i;
import org.cloudburstmc.protocol.bedrock.data.structure.StructureSettings;
import org.cloudburstmc.protocol.bedrock.data.structure.StructureTemplateRequestOperation;
import org.cloudburstmc.protocol.bedrock.packet.StructureTemplateDataRequestPacket;
import org.geysermc.geyser.session.GeyserSession;
import org.geysermc.geyser.translator.protocol.PacketTranslator;
import org.geysermc.geyser.translator.protocol.Translator;
import org.geysermc.geyser.util.StructureBlockUtils;

/**
 * Packet used in Bedrock to load structure size into the structure block GUI. It is sent every time the GUI is opened.
 * Or, if the player updates the structure name. Which we can use to request the structure size from the Java server!
 * <p>
 * Java does not have this preview, instead, Java clients are forced out of the GUI to look at the area.
 */
@Translator(packet = StructureTemplateDataRequestPacket.class)
public class BedrockStructureTemplateDataRequestTranslator extends PacketTranslator<StructureTemplateDataRequestPacket> {

    @Override
    public void translate(GeyserSession session, StructureTemplateDataRequestPacket packet) {
        // All other operation types are ignored by Geyser since we do not support exporting/importing structures
        if (packet.getOperation().equals(StructureTemplateRequestOperation.QUERY_SAVED_STRUCTURE)) {
            Vector3i size = packet.getSettings().getSize();
            StructureSettings settings = packet.getSettings();

            // If we send a load packet to the Java server when the structure size is known, it would place the structure.
            String currentStructureName = session.getStructureBlockCache().getCurrentStructureName();

            // Case 1: Opening a structure block with information about structure size, but not yet saved by us
            // Case 2: Getting an update from Bedrock with new information, doesn't bother us if it's the same structure
            if (!packet.getSettings().getSize().equals(Vector3i.ZERO)) {
                if (currentStructureName == null) {
                    Vector3i offset = StructureBlockUtils.calculateOffset(settings.getRotation(), settings.getMirror(),
                            settings.getSize().getX(), settings.getSize().getZ());
                    session.getStructureBlockCache().setBedrockOffset(offset);
                    session.getStructureBlockCache().setCurrentStructureName(packet.getName());
                    StructureBlockUtils.sendStructureData(session, size, packet.getName());
                    return;
                } else if (packet.getName().equals(currentStructureName)) {
                    StructureBlockUtils.sendStructureData(session, size, packet.getName());
                    return;
                }
            }

            // Request a "structure load" from Java server, so it sends us the structure's size
            // See the block entity translator for more info
            session.getStructureBlockCache().setCurrentStructureBlock(packet.getPosition());

            StructureBlockUtils.sendJavaStructurePacket(session,
                    packet.getPosition(),
                    Vector3i.ZERO, // We expect the Java server to tell us the size
                    UpdateStructureBlockMode.LOAD,
                    UpdateStructureBlockAction.LOAD_STRUCTURE,
                    settings,
                    true,
                    packet.getName()
            );
        } else {
            StructureBlockUtils.sendEmptyStructureData(session);
        }
    }
}