mirror of
https://github.com/GeyserMC/Geyser.git
synced 2024-08-14 23:57:35 +00:00
152 lines
6.4 KiB
Java
152 lines
6.4 KiB
Java
/*
|
|
* Copyright (c) 2019-2022 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.level;
|
|
|
|
import com.github.steveice10.mc.protocol.data.game.entity.player.GameMode;
|
|
import com.github.steveice10.mc.protocol.data.game.setting.Difficulty;
|
|
import com.nukkitx.math.vector.Vector3i;
|
|
import com.nukkitx.nbt.NbtMap;
|
|
import org.geysermc.geyser.session.GeyserSession;
|
|
|
|
/**
|
|
* Class that manages or retrieves various information
|
|
* from the world. Everything in this class should be
|
|
* safe to return null or an empty value in the event
|
|
* that chunk caching or anything of the sort is disabled
|
|
* on the standalone version of Geyser.
|
|
*/
|
|
public abstract class WorldManager {
|
|
|
|
/**
|
|
* Gets the Java block state at the specified location
|
|
*
|
|
* @param session the session
|
|
* @param vector the position
|
|
* @return the block state at the specified location
|
|
*/
|
|
public final int getBlockAt(GeyserSession session, Vector3i vector) {
|
|
return this.getBlockAt(session, vector.getX(), vector.getY(), vector.getZ());
|
|
}
|
|
|
|
/**
|
|
* Gets the Java block state at the specified location
|
|
*
|
|
* @param session the session
|
|
* @param x the x coordinate to get the block at
|
|
* @param y the y coordinate to get the block at
|
|
* @param z the z coordinate to get the block at
|
|
* @return the block state at the specified location
|
|
*/
|
|
public abstract int getBlockAt(GeyserSession session, int x, int y, int z);
|
|
|
|
/**
|
|
* Checks whether or not this world manager requires a separate chunk cache/has access to more block data than the chunk cache.
|
|
* <p>
|
|
* Some world managers (e.g. Spigot) can provide access to block data outside of the chunk cache, and even with chunk caching disabled. This
|
|
* method provides a means to check if this manager has this capability.
|
|
*
|
|
* @return whether or not this world manager has access to more block data than the chunk cache
|
|
*/
|
|
public abstract boolean hasOwnChunkCache();
|
|
|
|
/**
|
|
* Sigh. <br>
|
|
*
|
|
* So, on Java Edition, the lectern is an inventory. Java opens it and gets the contents of the book there.
|
|
* On Bedrock, the lectern contents are part of the block entity tag. Therefore, Bedrock expects to have the contents
|
|
* of the lectern ready and present in the world. If the contents are not there, it takes at least two clicks for the
|
|
* lectern to update the tag and then present itself. <br>
|
|
*
|
|
* We solve this problem by querying all loaded lecterns, where possible, and sending their information in a block entity
|
|
* tag.
|
|
*
|
|
* @param session the session of the player
|
|
* @param x the x coordinate of the lectern
|
|
* @param y the y coordinate of the lectern
|
|
* @param z the z coordinate of the lectern
|
|
* @param isChunkLoad if this is called during a chunk load or not. Changes behavior in certain instances.
|
|
* @return the Bedrock lectern block entity tag. This may not be the exact block entity tag - for example, Spigot's
|
|
* block handled must be done on the server thread, so we send the tag manually there.
|
|
*/
|
|
public abstract NbtMap getLecternDataAt(GeyserSession session, int x, int y, int z, boolean isChunkLoad);
|
|
|
|
/**
|
|
* @return whether we should expect lectern data to update, or if we have to fall back on a workaround.
|
|
*/
|
|
public abstract boolean shouldExpectLecternHandled();
|
|
|
|
/**
|
|
* Updates a gamerule value on the Java server
|
|
*
|
|
* @param session The session of the user that requested the change
|
|
* @param name The gamerule to change
|
|
* @param value The new value for the gamerule
|
|
*/
|
|
public abstract void setGameRule(GeyserSession session, String name, Object value);
|
|
|
|
/**
|
|
* Gets a gamerule value as a boolean
|
|
*
|
|
* @param session The session of the user that requested the value
|
|
* @param gameRule The gamerule to fetch the value of
|
|
* @return The boolean representation of the value
|
|
*/
|
|
public abstract Boolean getGameRuleBool(GeyserSession session, GameRule gameRule);
|
|
|
|
/**
|
|
* Get a gamerule value as an integer
|
|
*
|
|
* @param session The session of the user that requested the value
|
|
* @param gameRule The gamerule to fetch the value of
|
|
* @return The integer representation of the value
|
|
*/
|
|
public abstract int getGameRuleInt(GeyserSession session, GameRule gameRule);
|
|
|
|
/**
|
|
* Change the game mode of the given session
|
|
*
|
|
* @param session The session of the player to change the game mode of
|
|
* @param gameMode The game mode to change the player to
|
|
*/
|
|
public abstract void setPlayerGameMode(GeyserSession session, GameMode gameMode);
|
|
|
|
/**
|
|
* Change the difficulty of the Java server
|
|
*
|
|
* @param session The session of the user that requested the change
|
|
* @param difficulty The difficulty to change to
|
|
*/
|
|
public abstract void setDifficulty(GeyserSession session, Difficulty difficulty);
|
|
|
|
/**
|
|
* Checks if the given session's player has a permission
|
|
*
|
|
* @param session The session of the player to check the permission of
|
|
* @param permission The permission node to check
|
|
* @return True if the player has the requested permission, false if not
|
|
*/
|
|
public abstract boolean hasPermission(GeyserSession session, String permission);
|
|
}
|