Package com.sk89q.worldedit.command

Class SchematicCommands

java.lang.Object

com.sk89q.worldedit.command.SchematicCommands

public class SchematicCommands
extends Object

Commands that work with schematic files.

Constructor Summary

Constructors

Constructor	Description
SchematicCommands(WorldEdit worldEdit)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	clear(Actor actor, LocalSession session)
void	delete(Actor actor, LocalSession session, String filename)
void	formats(Actor actor)
void	list(Actor actor, LocalSession session, int page, boolean oldFirst, boolean newFirst, String formatName, String filter, Arguments arguments)
void	load(Actor actor, LocalSession session, String filename, String formatName, boolean randomRotate)
void	loadall(Actor actor, LocalSession session, String formatName, String filename, boolean overwrite)	Deprecated.
void	move(Actor actor, LocalSession session, String directory)
void	save(Actor actor, LocalSession session, String filename, ClipboardFormat format, boolean allowOverwrite, boolean global)
void	share(Actor actor, LocalSession session, String schematicName, ClipboardShareDestination destination, ClipboardFormat format)
void	unload(Actor actor, LocalSession session, String fileName)

Methods inherited from class java.lang.Object

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

Constructor Details

SchematicCommands

public SchematicCommands(WorldEdit worldEdit)

Create a new instance.

Parameters:

worldEdit - reference to WorldEdit

Method Details

loadall

@Deprecated
public void loadall(Actor actor,
 LocalSession session,
 @Arg(desc="Format name.",def="fast")
 String formatName,
 @Arg(desc="File name.")
 String filename,
 @Switch(name='o',desc="Overwrite/replace existing clipboard(s)")
 boolean overwrite)
             throws FilenameException

Deprecated.

Throws:

FilenameException

clear

public void clear(Actor actor,
 LocalSession session)
           throws WorldEditException

Throws:

WorldEditException

unload

public void unload(Actor actor,
 LocalSession session,
 @Arg(desc="File name, requires extension.")
 String fileName)
            throws WorldEditException

Throws:

WorldEditException

move

public void move(Actor actor,
 LocalSession session,
 @Arg(desc="Directory.")
 String directory)
          throws WorldEditException,
IOException

Throws:

WorldEditException

IOException

load

public void load(Actor actor,
 LocalSession session,
 @Arg(desc="File name.")
 String filename,
 @Arg(desc="Format name.",def="")
 String formatName,
 @Switch(name='r',desc="Apply random rotation to the clipboard")
 boolean randomRotate)
          throws FilenameException

Throws:

FilenameException

save

public void save(Actor actor,
 LocalSession session,
 @Arg(desc="File name.")
 String filename,
 @Arg(desc="Format name.",def="fast")
 ClipboardFormat format,
 @Switch(name='f',desc="Overwrite an existing file.")
 boolean allowOverwrite,
 @Switch(name='g',desc="Bypasses per-player-schematic folders")
 boolean global)
          throws WorldEditException

Throws:

WorldEditException

share

public void share(Actor actor,
 LocalSession session,
 @Arg(desc="Schematic name. Defaults to name-millis",def="")
 String schematicName,
 @Arg(desc="Share location",def="arkitektonika")
 ClipboardShareDestination destination,
 @Arg(desc="Format name",def="fast")
 ClipboardFormat format)
           throws WorldEditException

Throws:

WorldEditException

delete

public void delete(Actor actor,
 LocalSession session,
 @Arg(desc="File name.")
 String filename)
            throws WorldEditException,
IOException

Throws:

WorldEditException

IOException

formats

public void formats(Actor actor)

list

public void list(Actor actor,
 LocalSession session,
 @ArgFlag(name='p',desc="Page to view.",def="1")
 int page,
 @Switch(name='d',desc="Sort by date, oldest first")
 boolean oldFirst,
 @Switch(name='n',desc="Sort by date, newest first")
 boolean newFirst,
 @ArgFlag(name='f',desc="Restricts by format.",def="")
 String formatName,
 @Arg(name="filter",desc="Filter for schematics",def="all")
 String filter,
 Arguments arguments)
          throws WorldEditException

Throws:

WorldEditException