mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2024-12-23 01:37:37 +00:00
Fix some additional Javadoc errors.
This commit is contained in:
parent
1dc84d2511
commit
d8622fb30f
@ -309,7 +309,9 @@ public final class CompoundTag extends Tag {
|
|||||||
* list will also be returned.</p>
|
* list will also be returned.</p>
|
||||||
*
|
*
|
||||||
* @param key the key
|
* @param key the key
|
||||||
|
* @param listType the class of the contained type
|
||||||
* @return a list of tags
|
* @return a list of tags
|
||||||
|
* @param <T> the type of list
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
public <T extends Tag> List<T> getList(String key, Class<T> listType) {
|
public <T extends Tag> List<T> getList(String key, Class<T> listType) {
|
||||||
|
@ -323,7 +323,9 @@ public final class ListTag extends Tag {
|
|||||||
* list will also be returned.</p>
|
* list will also be returned.</p>
|
||||||
*
|
*
|
||||||
* @param index the index
|
* @param index the index
|
||||||
|
* @param listType the class of the contained type
|
||||||
* @return a list of tags
|
* @return a list of tags
|
||||||
|
* @param <T> the NBT type
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
public <T extends Tag> List<T> getList(int index, Class<T> listType) {
|
public <T extends Tag> List<T> getList(int index, Class<T> listType) {
|
||||||
|
@ -31,6 +31,8 @@ public @interface CommandPermissions {
|
|||||||
/**
|
/**
|
||||||
* A list of permissions. Only one permission has to be met
|
* A list of permissions. Only one permission has to be met
|
||||||
* for the command to be permitted.
|
* for the command to be permitted.
|
||||||
|
*
|
||||||
|
* @return a list of permissions strings
|
||||||
*/
|
*/
|
||||||
String[] value();
|
String[] value();
|
||||||
|
|
||||||
|
@ -396,10 +396,9 @@ public abstract class CommandsManager<T> {
|
|||||||
* @param args arguments
|
* @param args arguments
|
||||||
* @param player command source
|
* @param player command source
|
||||||
* @param methodArgs method arguments
|
* @param methodArgs method arguments
|
||||||
* @throws CommandException
|
* @throws CommandException thrown when the command throws an error
|
||||||
*/
|
*/
|
||||||
public void execute(String cmd, String[] args, T player,
|
public void execute(String cmd, String[] args, T player, Object... methodArgs) throws CommandException {
|
||||||
Object... methodArgs) throws CommandException {
|
|
||||||
|
|
||||||
String[] newArgs = new String[args.length + 1];
|
String[] newArgs = new String[args.length + 1];
|
||||||
System.arraycopy(args, 0, newArgs, 1, args.length);
|
System.arraycopy(args, 0, newArgs, 1, args.length);
|
||||||
@ -574,6 +573,8 @@ public abstract class CommandsManager<T> {
|
|||||||
/**
|
/**
|
||||||
* Get the injector used to create new instances. This can be
|
* Get the injector used to create new instances. This can be
|
||||||
* null, in which case only classes will be registered statically.
|
* null, in which case only classes will be registered statically.
|
||||||
|
*
|
||||||
|
* @return an injector instance
|
||||||
*/
|
*/
|
||||||
public Injector getInjector() {
|
public Injector getInjector() {
|
||||||
return injector;
|
return injector;
|
||||||
|
@ -31,11 +31,10 @@ public interface Injector {
|
|||||||
*
|
*
|
||||||
* @param cls class
|
* @param cls class
|
||||||
* @return object
|
* @return object
|
||||||
* @throws IllegalAccessException
|
* @throws IllegalAccessException thrown on injection fault
|
||||||
* @throws InstantiationException
|
* @throws InstantiationException thrown on injection fault
|
||||||
* @throws InvocationTargetException
|
* @throws InvocationTargetException thrown on injection fault
|
||||||
*/
|
*/
|
||||||
public Object getInstance(Class<?> cls) throws InvocationTargetException,
|
public Object getInstance(Class<?> cls) throws InvocationTargetException, IllegalAccessException, InstantiationException;
|
||||||
IllegalAccessException, InstantiationException;
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -59,7 +59,9 @@ public @interface Logging {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Log mode. Can be either POSITION, REGION, ORIENTATION_REGION, PLACEMENT or ALL.
|
* Log mode.
|
||||||
|
*
|
||||||
|
* @return either POSITION, REGION, ORIENTATION_REGION, PLACEMENT or ALL
|
||||||
*/
|
*/
|
||||||
LogMode value();
|
LogMode value();
|
||||||
|
|
||||||
|
@ -35,11 +35,15 @@ public @interface NestedCommand {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A list of classes with the child commands.
|
* A list of classes with the child commands.
|
||||||
|
*
|
||||||
|
* @return a list of classes
|
||||||
*/
|
*/
|
||||||
Class<?>[] value();
|
Class<?>[] value();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If set to true it will execute the body of the tagged method.
|
* If set to true it will execute the body of the tagged method.
|
||||||
|
*
|
||||||
|
* @return true to execute the body of the annotated method
|
||||||
*/
|
*/
|
||||||
boolean executeBody() default false;
|
boolean executeBody() default false;
|
||||||
|
|
||||||
|
@ -100,7 +100,7 @@ public class YAMLProcessor extends YAMLNode {
|
|||||||
/**
|
/**
|
||||||
* Loads the configuration file.
|
* Loads the configuration file.
|
||||||
*
|
*
|
||||||
* @throws java.io.IOException
|
* @throws java.io.IOException on load error
|
||||||
*/
|
*/
|
||||||
public void load() throws IOException {
|
public void load() throws IOException {
|
||||||
InputStream stream = null;
|
InputStream stream = null;
|
||||||
@ -298,6 +298,7 @@ public class YAMLProcessor extends YAMLNode {
|
|||||||
* This method returns an empty ConfigurationNode for using as a
|
* This method returns an empty ConfigurationNode for using as a
|
||||||
* default in methods that select a node from a node list.
|
* default in methods that select a node from a node list.
|
||||||
*
|
*
|
||||||
|
* @param writeDefaults true to write default values when a property is requested that doesn't exist
|
||||||
* @return a node
|
* @return a node
|
||||||
*/
|
*/
|
||||||
public static YAMLNode getEmptyNode(boolean writeDefaults) {
|
public static YAMLNode getEmptyNode(boolean writeDefaults) {
|
||||||
|
@ -505,6 +505,7 @@ public class CuboidClipboard {
|
|||||||
* Set the block at a position in the clipboard.
|
* Set the block at a position in the clipboard.
|
||||||
*
|
*
|
||||||
* @param position the point, relative to the origin of the copy (0, 0, 0) and not to the actual copy origin.
|
* @param position the point, relative to the origin of the copy (0, 0, 0) and not to the actual copy origin.
|
||||||
|
* @param block the block to set
|
||||||
* @throws ArrayIndexOutOfBoundsException if the position is outside the bounds of the CuboidClipboard
|
* @throws ArrayIndexOutOfBoundsException if the position is outside the bounds of the CuboidClipboard
|
||||||
*/
|
*/
|
||||||
public void setBlock(Vector position, BaseBlock block) {
|
public void setBlock(Vector position, BaseBlock block) {
|
||||||
|
@ -95,7 +95,7 @@ import static com.sk89q.worldedit.regions.Regions.*;
|
|||||||
* {@link Extent}s that are chained together. For example, history is logged
|
* {@link Extent}s that are chained together. For example, history is logged
|
||||||
* using the {@link ChangeSetExtent}.</p>
|
* using the {@link ChangeSetExtent}.</p>
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("FieldCanBeLocal")
|
@SuppressWarnings({"FieldCanBeLocal", "deprecation"})
|
||||||
public class EditSession implements Extent {
|
public class EditSession implements Extent {
|
||||||
|
|
||||||
private static final Logger log = Logger.getLogger(EditSession.class.getCanonicalName());
|
private static final Logger log = Logger.getLogger(EditSession.class.getCanonicalName());
|
||||||
@ -134,6 +134,10 @@ public class EditSession implements Extent {
|
|||||||
private Mask oldMask;
|
private Mask oldMask;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Create a new instance.
|
||||||
|
*
|
||||||
|
* @param world a world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
* @deprecated use {@link WorldEdit#getEditSessionFactory()} to create {@link EditSession}s
|
* @deprecated use {@link WorldEdit#getEditSessionFactory()} to create {@link EditSession}s
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("deprecation")
|
@SuppressWarnings("deprecation")
|
||||||
@ -143,6 +147,11 @@ public class EditSession implements Extent {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Create a new instance.
|
||||||
|
*
|
||||||
|
* @param world a world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @param blockBag the block bag to set, or null to use none
|
||||||
* @deprecated use {@link WorldEdit#getEditSessionFactory()} to create {@link EditSession}s
|
* @deprecated use {@link WorldEdit#getEditSessionFactory()} to create {@link EditSession}s
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -234,7 +243,7 @@ public class EditSession implements Extent {
|
|||||||
* Get the maximum number of blocks that can be changed. -1 will be returned
|
* Get the maximum number of blocks that can be changed. -1 will be returned
|
||||||
* if it the limit disabled.
|
* if it the limit disabled.
|
||||||
*
|
*
|
||||||
* @return the limit (>= 0) or -1 for no limit
|
* @return the limit (>= 0) or -1 for no limit
|
||||||
*/
|
*/
|
||||||
public int getBlockChangeLimit() {
|
public int getBlockChangeLimit() {
|
||||||
return changeLimiter.getLimit();
|
return changeLimiter.getLimit();
|
||||||
@ -243,7 +252,7 @@ public class EditSession implements Extent {
|
|||||||
/**
|
/**
|
||||||
* Set the maximum number of blocks that can be changed.
|
* Set the maximum number of blocks that can be changed.
|
||||||
*
|
*
|
||||||
* @param limit the limit (>= 0) or -1 for no limit
|
* @param limit the limit (>= 0) or -1 for no limit
|
||||||
*/
|
*/
|
||||||
public void setBlockChangeLimit(int limit) {
|
public void setBlockChangeLimit(int limit) {
|
||||||
changeLimiter.setLimit(limit);
|
changeLimiter.setLimit(limit);
|
||||||
@ -299,6 +308,9 @@ public class EditSession implements Extent {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Set the mask.
|
||||||
|
*
|
||||||
|
* @param mask the mask
|
||||||
* @deprecated Use {@link #setMask(Mask)}
|
* @deprecated Use {@link #setMask(Mask)}
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -483,6 +495,7 @@ public class EditSession implements Extent {
|
|||||||
* @param block the block
|
* @param block the block
|
||||||
* @param stage the level
|
* @param stage the level
|
||||||
* @return whether the block changed
|
* @return whether the block changed
|
||||||
|
* @throws WorldEditException thrown on a set error
|
||||||
*/
|
*/
|
||||||
public boolean setBlock(Vector position, BaseBlock block, Stage stage) throws WorldEditException {
|
public boolean setBlock(Vector position, BaseBlock block, Stage stage) throws WorldEditException {
|
||||||
switch (stage) {
|
switch (stage) {
|
||||||
@ -683,6 +696,13 @@ public class EditSession implements Extent {
|
|||||||
return bypassNone.commit();
|
return bypassNone.commit();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Count the number of blocks of a given list of types in a region.
|
||||||
|
*
|
||||||
|
* @param region the region
|
||||||
|
* @param searchIDs a list of IDs to search
|
||||||
|
* @return the number of found blocks
|
||||||
|
*/
|
||||||
public int countBlock(Region region, Set<Integer> searchIDs) {
|
public int countBlock(Region region, Set<Integer> searchIDs) {
|
||||||
Set<BaseBlock> passOn = new HashSet<BaseBlock>();
|
Set<BaseBlock> passOn = new HashSet<BaseBlock>();
|
||||||
for (Integer i : searchIDs) {
|
for (Integer i : searchIDs) {
|
||||||
@ -954,7 +974,7 @@ public class EditSession implements Extent {
|
|||||||
* @param region the region
|
* @param region the region
|
||||||
* @param block the block to place
|
* @param block the block to place
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("deprecation")
|
@SuppressWarnings("deprecation")
|
||||||
public int makeCuboidFaces(Region region, BaseBlock block) throws MaxChangedBlocksException {
|
public int makeCuboidFaces(Region region, BaseBlock block) throws MaxChangedBlocksException {
|
||||||
@ -1009,7 +1029,7 @@ public class EditSession implements Extent {
|
|||||||
* @param region the region
|
* @param region the region
|
||||||
* @param block the block to place
|
* @param block the block to place
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("deprecation")
|
@SuppressWarnings("deprecation")
|
||||||
public int makeCuboidWalls(Region region, BaseBlock block) throws MaxChangedBlocksException {
|
public int makeCuboidWalls(Region region, BaseBlock block) throws MaxChangedBlocksException {
|
||||||
@ -1301,7 +1321,7 @@ public class EditSession implements Extent {
|
|||||||
* @param height The cylinder's up/down extent. If negative, extend downward.
|
* @param height The cylinder's up/down extent. If negative, extend downward.
|
||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
* @return number of blocks changed
|
* @return number of blocks changed
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makeCylinder(Vector pos, Pattern block, double radius, int height, boolean filled) throws MaxChangedBlocksException {
|
public int makeCylinder(Vector pos, Pattern block, double radius, int height, boolean filled) throws MaxChangedBlocksException {
|
||||||
return makeCylinder(pos, block, radius, radius, height, filled);
|
return makeCylinder(pos, block, radius, radius, height, filled);
|
||||||
@ -1317,7 +1337,7 @@ public class EditSession implements Extent {
|
|||||||
* @param height The cylinder's up/down extent. If negative, extend downward.
|
* @param height The cylinder's up/down extent. If negative, extend downward.
|
||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
* @return number of blocks changed
|
* @return number of blocks changed
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makeCylinder(Vector pos, Pattern block, double radiusX, double radiusZ, int height, boolean filled) throws MaxChangedBlocksException {
|
public int makeCylinder(Vector pos, Pattern block, double radiusX, double radiusZ, int height, boolean filled) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -1395,7 +1415,7 @@ public class EditSession implements Extent {
|
|||||||
* @param radius The sphere's radius
|
* @param radius The sphere's radius
|
||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
* @return number of blocks changed
|
* @return number of blocks changed
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makeSphere(Vector pos, Pattern block, double radius, boolean filled) throws MaxChangedBlocksException {
|
public int makeSphere(Vector pos, Pattern block, double radius, boolean filled) throws MaxChangedBlocksException {
|
||||||
return makeSphere(pos, block, radius, radius, radius, filled);
|
return makeSphere(pos, block, radius, radius, radius, filled);
|
||||||
@ -1411,7 +1431,7 @@ public class EditSession implements Extent {
|
|||||||
* @param radiusZ The sphere/ellipsoid's largest east/west extent
|
* @param radiusZ The sphere/ellipsoid's largest east/west extent
|
||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
* @return number of blocks changed
|
* @return number of blocks changed
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makeSphere(Vector pos, Pattern block, double radiusX, double radiusY, double radiusZ, boolean filled) throws MaxChangedBlocksException {
|
public int makeSphere(Vector pos, Pattern block, double radiusX, double radiusY, double radiusZ, boolean filled) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -1497,7 +1517,7 @@ public class EditSession implements Extent {
|
|||||||
* @param size size of pyramid
|
* @param size size of pyramid
|
||||||
* @param filled true if filled
|
* @param filled true if filled
|
||||||
* @return number of blocks changed
|
* @return number of blocks changed
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makePyramid(Vector position, Pattern block, int size, boolean filled) throws MaxChangedBlocksException {
|
public int makePyramid(Vector position, Pattern block, int size, boolean filled) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -1537,7 +1557,7 @@ public class EditSession implements Extent {
|
|||||||
* @param position the position
|
* @param position the position
|
||||||
* @param radius the radius
|
* @param radius the radius
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int thaw(Vector position, double radius)
|
public int thaw(Vector position, double radius)
|
||||||
throws MaxChangedBlocksException {
|
throws MaxChangedBlocksException {
|
||||||
@ -1596,7 +1616,7 @@ public class EditSession implements Extent {
|
|||||||
* @param position a position
|
* @param position a position
|
||||||
* @param radius a radius
|
* @param radius a radius
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int simulateSnow(Vector position, double radius) throws MaxChangedBlocksException {
|
public int simulateSnow(Vector position, double radius) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -1660,7 +1680,7 @@ public class EditSession implements Extent {
|
|||||||
* @param position a position
|
* @param position a position
|
||||||
* @param radius a radius
|
* @param radius a radius
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
* @deprecated Use {@link #green(Vector, double, boolean)}.
|
* @deprecated Use {@link #green(Vector, double, boolean)}.
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -1675,7 +1695,7 @@ public class EditSession implements Extent {
|
|||||||
* @param radius a radius
|
* @param radius a radius
|
||||||
* @param onlyNormalDirt only affect normal dirt (data value 0)
|
* @param onlyNormalDirt only affect normal dirt (data value 0)
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int green(Vector position, double radius, boolean onlyNormalDirt)
|
public int green(Vector position, double radius, boolean onlyNormalDirt)
|
||||||
throws MaxChangedBlocksException {
|
throws MaxChangedBlocksException {
|
||||||
@ -1737,7 +1757,7 @@ public class EditSession implements Extent {
|
|||||||
* @param position the base position
|
* @param position the base position
|
||||||
* @param apothem the apothem of the (square) area
|
* @param apothem the apothem of the (square) area
|
||||||
* @return number of patches created
|
* @return number of patches created
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makePumpkinPatches(Vector position, int apothem) throws MaxChangedBlocksException {
|
public int makePumpkinPatches(Vector position, int apothem) throws MaxChangedBlocksException {
|
||||||
// We want to generate pumpkins
|
// We want to generate pumpkins
|
||||||
@ -1766,7 +1786,7 @@ public class EditSession implements Extent {
|
|||||||
* @param density between 0 and 1, inclusive
|
* @param density between 0 and 1, inclusive
|
||||||
* @param treeGenerator the tree genreator
|
* @param treeGenerator the tree genreator
|
||||||
* @return number of trees created
|
* @return number of trees created
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int makeForest(Vector basePosition, int size, double density, TreeGenerator treeGenerator) throws MaxChangedBlocksException {
|
public int makeForest(Vector basePosition, int size, double density, TreeGenerator treeGenerator) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -2005,7 +2025,7 @@ public class EditSession implements Extent {
|
|||||||
* @param pattern The block pattern to use
|
* @param pattern The block pattern to use
|
||||||
*
|
*
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int hollowOutRegion(Region region, int thickness, Pattern pattern) throws MaxChangedBlocksException {
|
public int hollowOutRegion(Region region, int thickness, Pattern pattern) throws MaxChangedBlocksException {
|
||||||
int affected = 0;
|
int affected = 0;
|
||||||
@ -2086,7 +2106,7 @@ public class EditSession implements Extent {
|
|||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
*
|
*
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int drawLine(Pattern pattern, Vector pos1, Vector pos2, double radius, boolean filled)
|
public int drawLine(Pattern pattern, Vector pos1, Vector pos2, double radius, boolean filled)
|
||||||
throws MaxChangedBlocksException {
|
throws MaxChangedBlocksException {
|
||||||
@ -2157,7 +2177,7 @@ public class EditSession implements Extent {
|
|||||||
* @param filled If false, only a shell will be generated.
|
* @param filled If false, only a shell will be generated.
|
||||||
*
|
*
|
||||||
* @return number of blocks affected
|
* @return number of blocks affected
|
||||||
* @throws MaxChangedBlocksException
|
* @throws MaxChangedBlocksException thrown if too many blocks are changed
|
||||||
*/
|
*/
|
||||||
public int drawSpline(Pattern pattern, List<Vector> nodevectors, double tension, double bias, double continuity, double quality, double radius, boolean filled)
|
public int drawSpline(Pattern pattern, List<Vector> nodevectors, double tension, double bias, double continuity, double quality, double radius, boolean filled)
|
||||||
throws MaxChangedBlocksException {
|
throws MaxChangedBlocksException {
|
||||||
|
@ -42,6 +42,7 @@ public class EditSessionFactory {
|
|||||||
*
|
*
|
||||||
* @param world the world
|
* @param world the world
|
||||||
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @return an instance
|
||||||
*/
|
*/
|
||||||
public EditSession getEditSession(World world, int maxBlocks) {
|
public EditSession getEditSession(World world, int maxBlocks) {
|
||||||
|
|
||||||
@ -65,6 +66,7 @@ public class EditSessionFactory {
|
|||||||
* @param world the world
|
* @param world the world
|
||||||
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
* @param player the player that the {@link EditSession} is for
|
* @param player the player that the {@link EditSession} is for
|
||||||
|
* @return an instance
|
||||||
*/
|
*/
|
||||||
public EditSession getEditSession(World world, int maxBlocks, Player player) {
|
public EditSession getEditSession(World world, int maxBlocks, Player player) {
|
||||||
|
|
||||||
@ -88,6 +90,7 @@ public class EditSessionFactory {
|
|||||||
* @param world the world
|
* @param world the world
|
||||||
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
||||||
|
* @return an instance
|
||||||
*/
|
*/
|
||||||
public EditSession getEditSession(World world, int maxBlocks, BlockBag blockBag) {
|
public EditSession getEditSession(World world, int maxBlocks, BlockBag blockBag) {
|
||||||
|
|
||||||
@ -112,6 +115,7 @@ public class EditSessionFactory {
|
|||||||
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
||||||
* @param player the player that the {@link EditSession} is for
|
* @param player the player that the {@link EditSession} is for
|
||||||
|
* @return an instance
|
||||||
*/
|
*/
|
||||||
public EditSession getEditSession(World world, int maxBlocks, BlockBag blockBag, Player player) {
|
public EditSession getEditSession(World world, int maxBlocks, BlockBag blockBag, Player player) {
|
||||||
|
|
||||||
@ -134,6 +138,11 @@ public class EditSessionFactory {
|
|||||||
// ------------------------------------------------------------------------
|
// ------------------------------------------------------------------------
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Construct an edit session.
|
||||||
|
*
|
||||||
|
* @param world the world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @return an instance
|
||||||
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int)} instead
|
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int)} instead
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -142,6 +151,12 @@ public class EditSessionFactory {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Construct an edit session.
|
||||||
|
*
|
||||||
|
* @param world the world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @param player the player that the {@link EditSession} is for
|
||||||
|
* @return an instance
|
||||||
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, Player)} instead
|
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, Player)} instead
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -150,6 +165,12 @@ public class EditSessionFactory {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Construct an edit session.
|
||||||
|
*
|
||||||
|
* @param world the world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
||||||
|
* @return an instance
|
||||||
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, BlockBag)} instead
|
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, BlockBag)} instead
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -158,6 +179,13 @@ public class EditSessionFactory {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Construct an edit session.
|
||||||
|
*
|
||||||
|
* @param world the world
|
||||||
|
* @param maxBlocks the maximum number of blocks that can be changed, or -1 to use no limit
|
||||||
|
* @param blockBag an optional {@link BlockBag} to use, otherwise null
|
||||||
|
* @param player the player that the {@link EditSession} is for
|
||||||
|
* @return an instance
|
||||||
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, BlockBag, Player)} instead
|
* @deprecated We are replacing {@link LocalWorld} with {@link World}, so use {@link #getEditSession(World, int, BlockBag, Player)} instead
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
|
@ -599,7 +599,7 @@ public class Vector implements Comparable<Vector> {
|
|||||||
/**
|
/**
|
||||||
* Rounds all components to the closest integer.
|
* Rounds all components to the closest integer.
|
||||||
*
|
*
|
||||||
* <p>Components < 0.5 are rounded down, otherwise up.</p>
|
* <p>Components < 0.5 are rounded down, otherwise up.</p>
|
||||||
*
|
*
|
||||||
* @return a new vector
|
* @return a new vector
|
||||||
*/
|
*/
|
||||||
|
@ -509,7 +509,7 @@ public class Vector2D {
|
|||||||
/**
|
/**
|
||||||
* Rounds all components to the closest integer.
|
* Rounds all components to the closest integer.
|
||||||
*
|
*
|
||||||
* <p>Components < 0.5 are rounded down, otherwise up.</p>
|
* <p>Components < 0.5 are rounded down, otherwise up.</p>
|
||||||
*
|
*
|
||||||
* @return a new vector
|
* @return a new vector
|
||||||
*/
|
*/
|
||||||
@ -607,6 +607,7 @@ public class Vector2D {
|
|||||||
/**
|
/**
|
||||||
* Creates a 3D vector by adding the specified Y component to this vector.
|
* Creates a 3D vector by adding the specified Y component to this vector.
|
||||||
*
|
*
|
||||||
|
* @param y the Y component
|
||||||
* @return a new vector
|
* @return a new vector
|
||||||
*/
|
*/
|
||||||
public Vector toVector(double y) {
|
public Vector toVector(double y) {
|
||||||
|
@ -64,6 +64,7 @@ public interface Extent extends InputExtent, OutputExtent {
|
|||||||
* game will not have every chunk loaded), then this list may not be
|
* game will not have every chunk loaded), then this list may not be
|
||||||
* incomplete.</p>
|
* incomplete.</p>
|
||||||
*
|
*
|
||||||
|
* @param region the region in which entities must be contained
|
||||||
* @return a list of entities
|
* @return a list of entities
|
||||||
*/
|
*/
|
||||||
List<? extends Entity> getEntities(Region region);
|
List<? extends Entity> getEntities(Region region);
|
||||||
|
@ -48,6 +48,7 @@ public interface OutputExtent {
|
|||||||
* @param position position of the block
|
* @param position position of the block
|
||||||
* @param block block to set
|
* @param block block to set
|
||||||
* @return true if the block was successfully set (return value may not be accurate)
|
* @return true if the block was successfully set (return value may not be accurate)
|
||||||
|
* @throws WorldEditException thrown on an error
|
||||||
*/
|
*/
|
||||||
boolean setBlock(Vector position, BaseBlock block) throws WorldEditException;
|
boolean setBlock(Vector position, BaseBlock block) throws WorldEditException;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user