ChunkPos.java

/*
 * This file is part of FalsePatternLib.
 *
 * Copyright (C) 2022-2024 FalsePattern
 * All Rights Reserved
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * FalsePatternLib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FalsePatternLib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FalsePatternLib. If not, see <https://www.gnu.org/licenses/>.
 */
package com.falsepattern.lib.compat;

import com.falsepattern.lib.StableAPI;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import lombok.val;

import net.minecraft.entity.Entity;

import javax.annotation.concurrent.Immutable;

/**
 * A functional equivalent to ChunkPos present in Minecraft 1.12.
 */
@Immutable
@EqualsAndHashCode
@AllArgsConstructor
@StableAPI(since = "0.6.0")
public class ChunkPos {
    /**
     * The x position of the chunk.
     */
    @StableAPI.Expose
    public final int x;
    /**
     * The z position of the chunk.
     */
    @StableAPI.Expose
    public final int z;

    /**
     * Instantiates a new ChunkPos.
     *
     * @param blockPos the block pos
     */
    @StableAPI.Expose
    public ChunkPos(@NonNull BlockPos blockPos) {
        x = blockPos.getX() >> 4;
        z = blockPos.getZ() >> 4;
    }

    /**
     * Converts the chunk coordinate pair to a long
     *
     * @param x the chunk x
     * @param z the chunk x
     *
     * @return the unique chunk long
     */
    @StableAPI.Expose
    public static long asLong(int x, int z) {
        return (long) x & 0xFFFFFFFFL | ((long) z & 0xFFFFFFFFL) << 32;
    }

    /**
     * Gets distance sq.
     *
     * @param entity the entity
     *
     * @return the distance sq
     */
    @StableAPI.Expose
    public double getDistanceSq(@NonNull Entity entity) {
        val dX = ((x << 4) + 8) - entity.posX;
        val dY = ((z << 4) + 8) - entity.posZ;
        return dX * dX + dY * dY;
    }

    /**
     * Get the first x pos inside this chunk.
     *
     * @return the x start
     */
    @StableAPI.Expose
    public int getXStart() {
        return x << 4;
    }

    /**
     * Get the first z pos inside this chunk.
     *
     * @return the z start
     */
    @StableAPI.Expose
    public int getZStart() {
        return z << 4;
    }

    /**
     * Get the last x pos inside this chunk.
     *
     * @return the x end
     */
    @StableAPI.Expose
    public int getXEnd() {
        return (x << 4) + 15;
    }

    /**
     * Get the last z pos inside this chunk.
     *
     * @return the z end
     */
    @StableAPI.Expose
    public int getZEnd() {
        return (z << 4) + 15;
    }

    /**
     * Get BlockPos with respect to this chunk.
     *
     * @param x the x pos
     * @param y the y pos
     * @param z the z pos
     *
     * @return the relative block position
     */
    @StableAPI.Expose
    public BlockPos getBlock(int x, int y, int z) {
        return new BlockPos((this.x << 4) + x, y, (this.z << 4) + z);
    }

    @Override
    public String toString() {
        return String.format("[%d, %d]", x, z);
    }
}