org.geysermc.connector.network.translators.world

Class WorldManager

java.lang.Object

org.geysermc.connector.network.translators.world.WorldManager

Direct Known Subclasses:

GeyserWorldManager

public abstract class WorldManager
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
WorldManager()

Method Summary

Modifier and Type	Method and Description
abstract int[]	getBiomeDataAt(GeyserSession session, int x, int z) Gets the Java biome data for the specified chunk.
abstract int	getBlockAt(GeyserSession session, int x, int y, int z) Gets the Java block state at the specified location
int	getBlockAt(GeyserSession session, com.github.steveice10.mc.protocol.data.game.entity.metadata.Position position) Gets the Java block state at the specified location
int	getBlockAt(GeyserSession session, com.nukkitx.math.vector.Vector3i vector) Gets the Java block state at the specified location
abstract void	getBlocksInSection(GeyserSession session, int x, int y, int z, com.github.steveice10.mc.protocol.data.game.chunk.Chunk section) Gets all block states in the specified chunk section.
abstract Boolean	getGameRuleBool(GeyserSession session, GameRule gameRule) Gets a gamerule value as a boolean
abstract int	getGameRuleInt(GeyserSession session, GameRule gameRule) Get a gamerule value as an integer
abstract boolean	hasMoreBlockDataThanChunkCache() Checks whether or not this world manager has access to more block data than the chunk cache.
abstract boolean	hasPermission(GeyserSession session, String permission) Checks if the given session's player has a permission
abstract void	setDifficulty(GeyserSession session, com.github.steveice10.mc.protocol.data.game.setting.Difficulty difficulty) Change the difficulty of the Java server
abstract void	setGameRule(GeyserSession session, String name, Object value) Updates a gamerule value on the Java server
abstract void	setPlayerGameMode(GeyserSession session, com.github.steveice10.mc.protocol.data.game.entity.player.GameMode gameMode) Change the game mode of the given session

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorldManager

public WorldManager()

Method Detail

getBlockAt

public int getBlockAt(GeyserSession session,
                      com.github.steveice10.mc.protocol.data.game.entity.metadata.Position position)

Gets the Java block state at the specified location

Parameters:

session - the session

position - the position

Returns:

the block state at the specified location

getBlockAt

public int getBlockAt(GeyserSession session,
                      com.nukkitx.math.vector.Vector3i vector)

Gets the Java block state at the specified location

Parameters:

session - the session

vector - the position

Returns:

the block state at the specified location

getBlockAt

public abstract int getBlockAt(GeyserSession session,
                               int x,
                               int y,
                               int z)

Gets the Java block state at the specified location

Parameters:

session - the session

x - the x coordinate to get the block at

y - the y coordinate to get the block at

z - the z coordinate to get the block at

Returns:

the block state at the specified location

getBlocksInSection

public abstract void getBlocksInSection(GeyserSession session,
                                        int x,
                                        int y,
                                        int z,
                                        com.github.steveice10.mc.protocol.data.game.chunk.Chunk section)

Gets all block states in the specified chunk section.

Parameters:

session - the session

x - the chunk's X coordinate

y - the chunk's Y coordinate

z - the chunk's Z coordinate

section - the chunk section to store the block data in

hasMoreBlockDataThanChunkCache

public abstract boolean hasMoreBlockDataThanChunkCache()

Checks whether or not this world manager has access to more block data than the chunk cache.

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.

Returns:

whether or not this world manager has access to more block data than the chunk cache

getBiomeDataAt

public abstract int[] getBiomeDataAt(GeyserSession session,
                                     int x,
                                     int z)

Gets the Java biome data for the specified chunk.

Parameters:

session - the session of the player

x - the chunk's X coordinate

z - the chunk's Z coordinate

Returns:

the biome data for the specified region with a length of 1024.

setGameRule

public abstract void setGameRule(GeyserSession session,
                                 String name,
                                 Object value)

Updates a gamerule value on the Java server

Parameters:

session - The session of the user that requested the change

name - The gamerule to change

value - The new value for the gamerule

getGameRuleBool

public abstract Boolean getGameRuleBool(GeyserSession session,
                                        GameRule gameRule)

Gets a gamerule value as a boolean

Parameters:

session - The session of the user that requested the value

gameRule - The gamerule to fetch the value of

Returns:

The boolean representation of the value

getGameRuleInt

public abstract int getGameRuleInt(GeyserSession session,
                                   GameRule gameRule)

Get a gamerule value as an integer

Parameters:

session - The session of the user that requested the value

gameRule - The gamerule to fetch the value of

Returns:

The integer representation of the value

setPlayerGameMode

public abstract void setPlayerGameMode(GeyserSession session,
                                       com.github.steveice10.mc.protocol.data.game.entity.player.GameMode gameMode)

Change the game mode of the given session

Parameters:

session - The session of the player to change the game mode of

gameMode - The game mode to change the player to

setDifficulty

public abstract void setDifficulty(GeyserSession session,
                                   com.github.steveice10.mc.protocol.data.game.setting.Difficulty difficulty)

Change the difficulty of the Java server

Parameters:

session - The session of the user that requested the change

difficulty - The difficulty to change to

hasPermission

public abstract boolean hasPermission(GeyserSession session,
                                      String permission)

Checks if the given session's player has a permission

Parameters:

session - The session of the player to check the permission of

permission - The permission node to check

Returns:

True if the player has the requested permission, false if not