com.sk89q.worldedit.extent.clipboard.Clipboard Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of FastAsyncWorldEdit-Core Show documentation
Show all versions of FastAsyncWorldEdit-Core Show documentation
Blazingly fast Minecraft world manipulation for artists, builders and everyone else.
/*
* WorldEdit, a Minecraft world manipulation toolkit
* Copyright (C) sk89q
* Copyright (C) WorldEdit team and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see , Closeable, Flushable {
//FAWE end
//FAWE start
/**
* Creates a new {@link ReadOnlyClipboard}.
*/
static Clipboard create(Region region) {
checkNotNull(region);
checkNotNull(
region.getWorld(),
"World cannot be null (use the other constructor for the region)"
);
EditSession session = WorldEdit
.getInstance()
.newEditSessionBuilder()
.world(region.getWorld())
.allowedRegionsEverywhere()
.build();
return ReadOnlyClipboard.of(session, region);
}
/**
* Create a new {@link com.fastasyncworldedit.core.extent.clipboard.SimpleClipboard} instance.
* Will be one of the following, depending on settings:
* - {@link DiskOptimizedClipboard}
* - {@link CPUOptimizedClipboard}
* - {@link MemoryOptimizedClipboard}
*/
static Clipboard create(Region region, UUID uuid) {
if (Settings.settings().CLIPBOARD.USE_DISK) {
return new DiskOptimizedClipboard(region, uuid);
} else if (Settings.settings().CLIPBOARD.COMPRESSION_LEVEL == 0) {
return new CPUOptimizedClipboard(region);
} else {
return new MemoryOptimizedClipboard(region);
}
}
//FAWE end
/**
* Get the bounding region of this extent.
*
* Implementations should return a copy of the region.
*
* @return the bounding region
*/
Region getRegion();
/**
* Get the dimensions of the copy, which is at minimum (1, 1, 1).
*
* @return the dimensions
*/
BlockVector3 getDimensions();
/**
* Get the origin point from which the copy was made from.
*
* @return the origin
*/
BlockVector3 getOrigin();
/**
* Set the origin point from which the copy was made from.
*
* @param origin the origin
*/
void setOrigin(BlockVector3 origin);
/**
* Returns true if the clipboard has biome data. This can be checked since {@link Extent#getBiome(BlockVector2)}
* strongly suggests returning {@link com.sk89q.worldedit.world.biome.BiomeTypes#OCEAN} instead of {@code null}
* if biomes aren't present. However, it might not be desired to set areas to ocean if the clipboard is defaulting
* to ocean, instead of having biomes explicitly set.
*
* @return true if the clipboard has biome data set
*/
default boolean hasBiomes() {
return false;
}
//FAWE start
/**
* Remove entity from clipboard.
*/
void removeEntity(Entity entity);
default int getWidth() {
return getDimensions().getBlockX();
}
default int getHeight() {
return getDimensions().getBlockY();
}
default int getLength() {
return getDimensions().getBlockZ();
}
default int getArea() {
return getWidth() * getLength();
}
default int getVolume() {
return getWidth() * getHeight() * getLength();
}
default Iterator iterator(Order order) {
return order.create(getRegion());
}
@Override
@Nonnull
default Iterator iterator() {
return getRegion().iterator();
}
default Iterator iterator2d() {
return Regions.asFlatRegion(getRegion()).asFlatRegion().iterator();
}
default URI getURI() {
return null;
}
@Override
default T apply(Region region, T filter, boolean full) {
if (region.equals(getRegion())) {
return apply(this, filter);
}
return apply(region, filter);
}
/**
* Close the clipboard. May not allow further reading of the clipboard if saved on disk.
*/
@Override
default void close() {
}
/**
* Flush the clipboard if appropriate. Only does something if using clipboard-on-disk. Blocking method and ensures all data
* is saved to disk for any further operation with the clipboard.
*/
@Override
default void flush() {
}
/**
* Forwards to {@link #paste(World, BlockVector3, boolean, boolean, Transform)}.
*/
default EditSession paste(World world, BlockVector3 to) {
return paste(world, to, true, true, null);
}
default void save(File file, ClipboardFormat format) throws IOException {
checkNotNull(file);
checkNotNull(format);
if (!file.exists()) {
File parent = file.getParentFile();
if (parent != null) {
parent.mkdirs();
}
file.createNewFile();
}
save(new FileOutputStream(file), format);
}
/**
* Save this schematic to a stream.
*/
default void save(OutputStream stream, ClipboardFormat format) throws IOException {
checkNotNull(stream);
checkNotNull(format);
try (ClipboardWriter writer = format.getWriter(stream)) {
writer.write(this);
}
}
default EditSession paste(
World world, BlockVector3 to, boolean allowUndo, boolean pasteAir,
@Nullable Transform transform
) {
return paste(world, to, allowUndo, pasteAir, true, transform);
}
/**
* Paste this schematic in a world.
*/
default EditSession paste(
World world, BlockVector3 to, boolean allowUndo, boolean pasteAir,
boolean pasteEntities, @Nullable Transform transform
) {
checkNotNull(world);
checkNotNull(to);
EditSession editSession;
if (world instanceof EditSession) {
editSession = (EditSession) world;
} else {
EditSessionBuilder builder = WorldEdit
.getInstance()
.newEditSessionBuilder()
.world(world)
.checkMemory(false)
.allowedRegionsEverywhere()
.limitUnlimited();
if (allowUndo) {
editSession = builder.build();
} else {
editSession = builder.changeSetNull().fastMode(true).build();
}
}
Extent extent = this;
Mask sourceMask = editSession.getSourceMask();
if (transform != null && !transform.isIdentity()) {
extent = new BlockTransformExtent(this, transform);
} else if (sourceMask == null) {
paste(editSession, to, pasteAir, pasteEntities, hasBiomes());
editSession.flushQueue();
return editSession;
}
ForwardExtentCopy copy = new ForwardExtentCopy(extent, this.getRegion(),
this.getOrigin(), editSession, to
);
if (transform != null && !transform.isIdentity()) {
copy.setTransform(transform);
}
copy.setCopyingEntities(pasteEntities);
if (sourceMask != null) {
new MaskTraverser(sourceMask).reset(extent);
copy.setSourceMask(sourceMask);
editSession.setSourceMask(null);
}
if (!pasteAir) {
copy.setSourceMask(new ExistingBlockMask(this));
}
try {
Operations.completeLegacy(copy);
} finally {
editSession.close(); // Make sure editsession is always closed
}
return editSession;
}
default void paste(
Extent extent, BlockVector3 to, boolean pasteAir,
@Nullable Transform transform
) {
if (extent instanceof World) {
EditSessionBuilder builder = WorldEdit
.getInstance()
.newEditSessionBuilder()
.world((World) extent)
.checkMemory(false)
.allowedRegionsEverywhere()
.limitUnlimited()
.changeSetNull();
extent = builder.build();
}
Extent source = this;
if (transform != null && !transform.isIdentity()) {
source = new BlockTransformExtent(this, transform);
}
ForwardExtentCopy copy = new ForwardExtentCopy(source, this.getRegion(), this.getOrigin(),
extent, to
);
if (transform != null) {
copy.setTransform(transform);
}
copy.setCopyingBiomes(this.hasBiomes());
if (extent instanceof EditSession editSession) {
Mask sourceMask = editSession.getSourceMask();
if (sourceMask != null) {
new MaskTraverser(sourceMask).reset(extent);
copy.setSourceMask(sourceMask);
editSession.setSourceMask(null);
}
}
if (!pasteAir) {
copy.setSourceMask(new ExistingBlockMask(this));
}
Operations.completeBlindly(copy);
}
default void paste(Extent extent, BlockVector3 to, boolean pasteAir) {
paste(extent, to, pasteAir, false, false);
}
default void paste(Extent extent, BlockVector3 to, boolean pasteAir, boolean pasteEntities, boolean pasteBiomes) {
if (extent instanceof World) {
EditSessionBuilder builder = WorldEdit
.getInstance()
.newEditSessionBuilder()
.world((World) extent)
.checkMemory(false)
.allowedRegionsEverywhere()
.limitUnlimited()
.changeSetNull();
extent = builder.build();
}
final BlockVector3 origin = this.getOrigin();
// To must be relative to the clipboard origin ( player location - clipboard origin ) (as the locations supplied are relative to the world origin)
final int relx = to.getBlockX() - origin.getBlockX();
final int rely = to.getBlockY() - origin.getBlockY();
final int relz = to.getBlockZ() - origin.getBlockZ();
pasteBiomes &= Clipboard.this.hasBiomes();
for (BlockVector3 pos : this) {
BaseBlock block = pos.getFullBlock(this);
int xx = pos.getX() + relx;
int yy = pos.getY() + rely;
int zz = pos.getZ() + relz;
if (pasteBiomes) {
extent.setBiome(xx, yy, zz, pos.getBiome(this));
}
if (!pasteAir && block.getBlockType().getMaterial().isAir()) {
continue;
}
extent.setBlock(xx, yy, zz, block);
}
// Entity offset is the paste location subtract the clipboard origin (entity's location is already relative to the world origin)
final int entityOffsetX = to.getBlockX() - origin.getBlockX();
final int entityOffsetY = to.getBlockY() - origin.getBlockY();
final int entityOffsetZ = to.getBlockZ() - origin.getBlockZ();
// entities
if (pasteEntities) {
for (Entity entity : this.getEntities()) {
// skip players on pasting schematic
if (entity.getState() != null && entity.getState().getType().getId()
.equals("minecraft:player")) {
continue;
}
Location pos = entity.getLocation();
Location newPos = new Location(pos.getExtent(), pos.getX() + entityOffsetX,
pos.getY() + entityOffsetY, pos.getZ() + entityOffsetZ, pos.getYaw(),
pos.getPitch()
);
extent.createEntity(newPos, entity.getState());
}
}
}
//FAWE end
}