Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2024-11-16 23:55:14 +01:00
Code Issues Projects Releases Wiki Activity

Comments for BlockModifier

Browse Source
This commit is contained in:
themode 2020-10-12 17:00:43 +02:00
parent 5ea2f960a5
commit 4d78677a0a
1 changed files with 46 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
src/main/java/net/minestom/server/instance/BlockModifier.java
View File

@ -2,18 +2,64 @@ package net.minestom.server.instance;
import net.minestom.server.MinecraftServer;
import net.minestom.server.data.Data;
import net.minestom.server.instance.batch.BlockBatch;
import net.minestom.server.instance.batch.ChunkBatch;
import net.minestom.server.instance.block.Block;
import net.minestom.server.instance.block.BlockManager;
import net.minestom.server.instance.block.CustomBlock;
import net.minestom.server.utils.BlockPosition;
import net.minestom.server.utils.validate.Check;
/**
* Represents an element which can place blocks at position.
* <p>
* Notably used by {@link Instance}, {@link BlockBatch} and {@link ChunkBatch}.
*/
public interface BlockModifier {
BlockManager BLOCK_MANAGER = MinecraftServer.getBlockManager();
/**
* Set a block at a position.
* <p>
* You can use {@link #setBlock(int, int, int, Block)} if you want it to be more explicit.
*
* @param x the block X
* @param y the block Y
* @param z the block Z
* @param blockStateId the block state id
* @param data the block {@link Data}, can be null
*/
void setBlockStateId(int x, int y, int z, short blockStateId, Data data);
/**
* Set a {@link CustomBlock} at a position.
* <p>
* The custom block id should be the one returned by {@link CustomBlock#getCustomBlockId()}.
*
* @param x the block X
* @param y the block Y
* @param z the block Z
* @param customBlockId the custom block id
* @param data the block {@link Data}, can be null
*/
void setCustomBlock(int x, int y, int z, short customBlockId, Data data);
/**
* Set a {@link CustomBlock} at a position with a custom state id.
* <p>
* The custom block id should be the one returned by {@link CustomBlock#getCustomBlockId()},
* and the block state id can be anything you want, state id can be retrieved using {@link Block#getBlockId()}.
*
* @param x the block X
* @param y the block Y
* @param z the block Z
* @param blockStateId the block state id
* @param customBlockId the custom block id
* @param data the block {@link Data}, can be null
*/
void setSeparateBlocks(int x, int y, int z, short blockStateId, short customBlockId, Data data);
default void setBlockStateId(int x, int y, int z, short blockStateId) {
setBlockStateId(x, y, z, blockStateId, null);
}
@ -33,9 +79,6 @@ public interface BlockModifier {
setBlockStateId(blockPosition.getX(), blockPosition.getY(), blockPosition.getZ(), blockStateId);
}
void setCustomBlock(int x, int y, int z, short customBlockId, Data data);
default void setCustomBlock(int x, int y, int z, short customBlockId) {
setCustomBlock(x, y, z, customBlockId, null);
}
@ -56,8 +99,6 @@ public interface BlockModifier {
setCustomBlock(blockPosition.getX(), blockPosition.getY(), blockPosition.getZ(), customBlockId);
}
void setSeparateBlocks(int x, int y, int z, short blockStateId, short customBlockId, Data data);
default void setSeparateBlocks(int x, int y, int z, short blockStateId, short customBlockId) {
setSeparateBlocks(x, y, z, blockStateId, customBlockId, null);
}