Java/JavaPlayEffectTranslator.java

/*
 * Copyright (c) 2019-2021 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.connector.network.translators.java.world;

import com.github.steveice10.mc.protocol.data.game.world.effect.*;
import com.github.steveice10.mc.protocol.packet.ingame.server.world.ServerPlayEffectPacket;
import com.nukkitx.math.vector.Vector3f;
import com.nukkitx.protocol.bedrock.data.LevelEventType;
import com.nukkitx.protocol.bedrock.data.SoundEvent;
import com.nukkitx.protocol.bedrock.packet.LevelEventPacket;
import com.nukkitx.protocol.bedrock.packet.LevelSoundEventPacket;
import com.nukkitx.protocol.bedrock.packet.TextPacket;
import org.geysermc.connector.GeyserConnector;
import org.geysermc.connector.network.session.GeyserSession;
import org.geysermc.connector.network.translators.PacketTranslator;
import org.geysermc.connector.network.translators.Translator;
import org.geysermc.connector.network.translators.effect.Effect;
import org.geysermc.connector.registry.Registries;
import org.geysermc.connector.utils.LocaleUtils;

import java.util.Collections;
import java.util.Locale;

@Translator(packet = ServerPlayEffectPacket.class)
public class JavaPlayEffectTranslator extends PacketTranslator<ServerPlayEffectPacket> {

    @Override
    public void translate(GeyserSession session, ServerPlayEffectPacket packet) {
        // Separate case since each RecordEffectData in Java is an individual track in Bedrock
        if (packet.getEffect() == SoundEffect.RECORD) {
            RecordEffectData recordEffectData = (RecordEffectData) packet.getData();
            SoundEvent soundEvent = Registries.RECORDS.getOrDefault(recordEffectData.getRecordId(), SoundEvent.STOP_RECORD);
            Vector3f pos = Vector3f.from(packet.getPosition().getX(), packet.getPosition().getY(), packet.getPosition().getZ()).add(0.5f, 0.5f, 0.5f);

            LevelSoundEventPacket levelSoundEvent = new LevelSoundEventPacket();
            levelSoundEvent.setIdentifier("");
            levelSoundEvent.setSound(soundEvent);
            levelSoundEvent.setPosition(pos);
            levelSoundEvent.setRelativeVolumeDisabled(packet.isBroadcast());
            levelSoundEvent.setExtraData(-1);
            levelSoundEvent.setBabySound(false);
            session.sendUpstreamPacket(levelSoundEvent);

            if (soundEvent != SoundEvent.STOP_RECORD) {
                // Send text packet as it seems to be handled in Java Edition client-side.
                TextPacket textPacket = new TextPacket();
                textPacket.setType(TextPacket.Type.JUKEBOX_POPUP);
                textPacket.setNeedsTranslation(true);
                textPacket.setXuid("");
                textPacket.setPlatformChatId("");
                textPacket.setSourceName(null);
                textPacket.setMessage("record.nowPlaying");
                String recordString = "%item." + soundEvent.name().toLowerCase(Locale.ROOT) + ".desc";
                textPacket.setParameters(Collections.singletonList(LocaleUtils.getLocaleString(recordString, session.getLocale())));
                session.sendUpstreamPacket(textPacket);
            }
            return;
        }

        if (packet.getEffect() instanceof SoundEffect) {
            SoundEffect soundEffect = (SoundEffect) packet.getEffect();
            Effect geyserEffect = Registries.SOUND_EFFECTS.get(soundEffect);
            if (geyserEffect != null) {
                geyserEffect.handleEffectPacket(session, packet);
                return;
            }
            GeyserConnector.getInstance().getLogger().debug("Unhandled sound effect: " + soundEffect.name());
        } else if (packet.getEffect() instanceof ParticleEffect) {
            ParticleEffect particleEffect = (ParticleEffect) packet.getEffect();
            Vector3f pos = Vector3f.from(packet.getPosition().getX(), packet.getPosition().getY(), packet.getPosition().getZ()).add(0.5f, 0.5f, 0.5f);

            LevelEventPacket effectPacket = new LevelEventPacket();
            effectPacket.setPosition(pos);
            effectPacket.setData(0);
            switch (particleEffect) {
                case COMPOSTER: {
                    effectPacket.setType(LevelEventType.PARTICLE_CROP_GROWTH);

                    ComposterEffectData composterEffectData = (ComposterEffectData) packet.getData();
                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    switch (composterEffectData) {
                        case FILL:
                            soundEventPacket.setSound(SoundEvent.COMPOSTER_FILL);
                            break;
                        case FILL_SUCCESS:
                            soundEventPacket.setSound(SoundEvent.COMPOSTER_FILL_LAYER);
                            break;
                    }
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case BLOCK_LAVA_EXTINGUISH: {
                    effectPacket.setType(LevelEventType.PARTICLE_EVAPORATE);
                    effectPacket.setPosition(pos.add(-0.5f, 0.7f, -0.5f));

                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    soundEventPacket.setSound(SoundEvent.EXTINGUISH_FIRE);
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case BLOCK_REDSTONE_TORCH_BURNOUT: {
                    effectPacket.setType(LevelEventType.PARTICLE_EVAPORATE);
                    effectPacket.setPosition(pos.add(-0.5f, 0, -0.5f));

                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    soundEventPacket.setSound(SoundEvent.EXTINGUISH_FIRE);
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case BLOCK_END_PORTAL_FRAME_FILL: {
                    effectPacket.setType(LevelEventType.PARTICLE_EVAPORATE);
                    effectPacket.setPosition(pos.add(-0.5f, 0.3125f, -0.5f));

                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    soundEventPacket.setSound(SoundEvent.BLOCK_END_PORTAL_FRAME_FILL);
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case SMOKE: {
                    effectPacket.setType(LevelEventType.PARTICLE_SHOOT);

                    SmokeEffectData smokeEffectData = (SmokeEffectData) packet.getData();
                    int data = 0;
                    switch (smokeEffectData) {
                        case DOWN:
                            data = 4;
                            pos = pos.add(0, -0.9f, 0);
                            break;
                        case UP:
                            data = 4;
                            pos = pos.add(0, 0.5f, 0);
                            break;
                        case NORTH:
                            data = 1;
                            pos = pos.add(0, -0.2f, -0.7f);
                            break;
                        case SOUTH:
                            data = 7;
                            pos = pos.add(0, -0.2f, 0.7f);
                            break;
                        case WEST:
                            data = 3;
                            pos = pos.add(-0.7f, -0.2f, 0);
                            break;
                        case EAST:
                            data = 5;
                            pos = pos.add(0.7f, -0.2f, 0);
                            break;

                    }
                    effectPacket.setPosition(pos);
                    effectPacket.setData(data);
                    break;
                }
                //TODO: Block break particles when under fire
                case BREAK_BLOCK: {
                    effectPacket.setType(LevelEventType.PARTICLE_DESTROY_BLOCK);

                    BreakBlockEffectData breakBlockEffectData = (BreakBlockEffectData) packet.getData();
                    effectPacket.setData(session.getBlockMappings().getBedrockBlockId(breakBlockEffectData.getBlockState()));
                    break;
                }
                case BREAK_SPLASH_POTION: {
                    effectPacket.setType(LevelEventType.PARTICLE_POTION_SPLASH);
                    effectPacket.setPosition(pos.add(0, -0.5f, 0));

                    BreakPotionEffectData splashPotionData = (BreakPotionEffectData) packet.getData();
                    effectPacket.setData(splashPotionData.getPotionId());

                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    soundEventPacket.setSound(SoundEvent.GLASS);
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case BREAK_EYE_OF_ENDER: {
                    effectPacket.setType(LevelEventType.PARTICLE_EYE_OF_ENDER_DEATH);
                    break;
                }
                case MOB_SPAWN: {
                    effectPacket.setType(LevelEventType.PARTICLE_MOB_BLOCK_SPAWN); // TODO: Check, but I don't think I really verified this ever went into effect on Java
                    break;
                }
                case BONEMEAL_GROW_WITH_SOUND: // Note that there is no particle without sound in Bedrock. If you wanted to implement the sound, send a PlaySoundPacket with "item.bone_meal.use" and volume and pitch at 1.0F
                case BONEMEAL_GROW: {
                    effectPacket.setType(LevelEventType.PARTICLE_CROP_GROWTH);

                    BonemealGrowEffectData growEffectData = (BonemealGrowEffectData) packet.getData();
                    effectPacket.setData(growEffectData.getParticleCount());
                    break;
                }
                case ENDERDRAGON_FIREBALL_EXPLODE: {
                    effectPacket.setType(LevelEventType.PARTICLE_EYE_OF_ENDER_DEATH); // TODO

                    DragonFireballEffectData fireballEffectData = (DragonFireballEffectData) packet.getData();
                    if (fireballEffectData == DragonFireballEffectData.HAS_SOUND) {
                        LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                        soundEventPacket.setSound(SoundEvent.EXPLODE);
                        soundEventPacket.setPosition(pos);
                        soundEventPacket.setIdentifier("");
                        soundEventPacket.setExtraData(-1);
                        soundEventPacket.setBabySound(false);
                        soundEventPacket.setRelativeVolumeDisabled(false);
                        session.sendUpstreamPacket(soundEventPacket);
                    }
                    break;
                }
                case EXPLOSION: {
                    effectPacket.setType(LevelEventType.PARTICLE_GENERIC_SPAWN);
                    effectPacket.setData(61);
                    break;
                }
                case EVAPORATE: {
                    effectPacket.setType(LevelEventType.PARTICLE_EVAPORATE_WATER);
                    effectPacket.setPosition(pos.add(-0.5f, 0.5f, -0.5f));
                    break;
                }
                case END_GATEWAY_SPAWN: {
                    effectPacket.setType(LevelEventType.PARTICLE_EXPLOSION);

                    LevelSoundEventPacket soundEventPacket = new LevelSoundEventPacket();
                    soundEventPacket.setSound(SoundEvent.EXPLODE);
                    soundEventPacket.setPosition(pos);
                    soundEventPacket.setIdentifier("");
                    soundEventPacket.setExtraData(-1);
                    soundEventPacket.setBabySound(false);
                    soundEventPacket.setRelativeVolumeDisabled(false);
                    session.sendUpstreamPacket(soundEventPacket);
                    break;
                }
                case DRIPSTONE_DRIP: {
                    effectPacket.setType(LevelEventType.PARTICLE_DRIPSTONE_DRIP);
                    break;
                }
                case ELECTRIC_SPARK: {
                    // Matches with a Bedrock server but doesn't seem to match up with Java
                    effectPacket.setType(LevelEventType.PARTICLE_ELECTRIC_SPARK);
                    break;
                }
                case WAX_ON: {
                    effectPacket.setType(LevelEventType.PARTICLE_WAX_ON);
                    break;
                }
                case WAX_OFF: {
                    effectPacket.setType(LevelEventType.PARTICLE_WAX_OFF);
                    break;
                }
                case SCRAPE: {
                    effectPacket.setType(LevelEventType.PARTICLE_SCRAPE);
                    break;
                }
                default: {
                    GeyserConnector.getInstance().getLogger().debug("Unhandled particle effect: " + particleEffect.name());
                    return;
                }
            }
            session.sendUpstreamPacket(effectPacket);
        }
    }
}