Package com.plotsquared.core.util

Class SchematicHandler

java.lang.Object

com.plotsquared.core.util.SchematicHandler

public abstract class SchematicHandler
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchematicHandler.UnsupportedFormatException

Field Summary

Fields

Modifier and Type	Field	Description
static SchematicHandler	manager

Constructor Summary

Constructors

Constructor	Description
SchematicHandler(@NonNull WorldUtil worldUtil, @NonNull ProgressSubscriberFactory subscriberFactory)

Method Summary

Modifier and Type	Method	Description
boolean	exportAll(Collection<Plot> collection, File outputDir, String namingScheme, Runnable ifSuccess)
CompletableFuture<CompoundTag>	getCompoundTag(@NonNull Plot plot)	Get the given plot as CompoundTag matching the Sponge schematic format.
@NonNull CompletableFuture<CompoundTag>	getCompoundTag(@NonNull String worldName, @NonNull Set<CuboidRegion> regions)	Get the contents of the given regions in the given world as CompoundTag matching the Sponge schematic format.
List<String>	getSaves(UUID uuid)
Schematic	getSchematic(@NonNull InputStream is)
Schematic	getSchematic(@NonNull URL url)
Schematic	getSchematic(File file)	Get a schematic
Schematic	getSchematic(String name)	Get a schematic
Collection<String>	getSchematicNames()	Get an immutable collection containing all schematic names
void	paste(Schematic schematic, Plot plot, int xOffset, int yOffset, int zOffset, boolean autoHeight, PlotPlayer<?> actor, RunnableVal<Boolean> whenDone)	Paste a schematic.
abstract boolean	restoreTile(QueueCoordinator queue, CompoundTag tag, int x, int y, int z)
boolean	save(CompoundTag tag, String path)	Saves a schematic to a file path.
static void	upload(@Nullable UUID uuid, @Nullable String file, @NonNull String extension, @Nullable RunnableVal<OutputStream> writeTask, @NonNull RunnableVal<URL> whenDone)	Deprecated, for removal: This API element is subject to removal in a future version.
void	upload(CompoundTag tag, UUID uuid, String file, RunnableVal<URL> whenDone)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

manager

public static SchematicHandler manager

Constructor Details

SchematicHandler

@Inject
public SchematicHandler(@NonNull WorldUtil worldUtil,
 @NonNull ProgressSubscriberFactory subscriberFactory)

Method Details

upload

@Deprecated(forRemoval=true,
            since="6.0.0")
public static void upload(@Nullable UUID uuid,
 @Nullable String file,
 @NonNull String extension,
 @Nullable RunnableVal<OutputStream> writeTask,
 @NonNull RunnableVal<URL> whenDone)

Deprecated, for removal: This API element is subject to removal in a future version.

exportAll

public boolean exportAll(Collection<Plot> collection,
 File outputDir,
 String namingScheme,
 Runnable ifSuccess)

paste

public void paste(Schematic schematic,
 Plot plot,
 int xOffset,
 int yOffset,
 int zOffset,
 boolean autoHeight,
 PlotPlayer<?> actor,
 RunnableVal<Boolean> whenDone)

Paste a schematic.

Parameters:

schematic - the schematic object to paste

plot - plot to paste in

xOffset - offset x to paste it from plot origin

yOffset - offset y to paste it from plot origin

zOffset - offset z to paste it from plot origin

autoHeight - if to automatically choose height to paste from

actor - the actor pasting the schematic

whenDone - task to run when schematic is pasted

restoreTile

public abstract boolean restoreTile(QueueCoordinator queue,
 CompoundTag tag,
 int x,
 int y,
 int z)

getSchematic

public Schematic getSchematic(String name)
                       throws SchematicHandler.UnsupportedFormatException

Get a schematic

Parameters:

name - to check

Returns:

schematic if found, else null

Throws:

SchematicHandler.UnsupportedFormatException - thrown if schematic format is unsupported

getSchematicNames

public Collection<String> getSchematicNames()

Get an immutable collection containing all schematic names

Returns:

Immutable collection with schematic names

getSchematic

public Schematic getSchematic(File file)
                       throws SchematicHandler.UnsupportedFormatException

Get a schematic

Parameters:

file - to check

Returns:

schematic if found, else null

Throws:

SchematicHandler.UnsupportedFormatException - thrown if schematic format is unsupported

getSchematic

public Schematic getSchematic(@NonNull URL url)

getSchematic

public Schematic getSchematic(@NonNull InputStream is)

getSaves

public List<String> getSaves(UUID uuid)

upload

@Deprecated(forRemoval=true,
            since="6.0.0")
public void upload(CompoundTag tag,
 UUID uuid,
 String file,
 RunnableVal<URL> whenDone)

Deprecated, for removal: This API element is subject to removal in a future version.

save

public boolean save(CompoundTag tag,
 String path)

Saves a schematic to a file path.

Parameters:

tag - to save

path - to save in

Returns:

true if succeeded

getCompoundTag

public CompletableFuture<CompoundTag> getCompoundTag(@NonNull Plot plot)

Get the given plot as CompoundTag matching the Sponge schematic format.

Parameters:

plot - The plot to get the contents from.

Returns:

a CompletableFuture that provides the created CompoundTag.

getCompoundTag

public @NonNull CompletableFuture<CompoundTag> getCompoundTag(@NonNull String worldName,
 @NonNull Set<CuboidRegion> regions)

Get the contents of the given regions in the given world as CompoundTag matching the Sponge schematic format.

Parameters:

worldName - The world to get the contents from.

regions - The regions to get the contents from.

Returns:

a CompletableFuture that provides the created CompoundTag.