Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Exceptions
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
com.sk89q.worldedit.masks.Mask Use Mask
com.sk89q.worldedit.patterns.Pattern See Pattern

Deprecated Classes

Class and Description
com.sk89q.worldedit.masks.AbstractMask Switch to AbstractMask
com.sk89q.worldedit.foundation.Block Use BaseBlock
com.sk89q.worldedit.bags.BlockBag Block bags are currently not a supported feature of WorldEdit
com.sk89q.worldedit.patterns.BlockChance Will be removed in the future -- there is no replacement
com.sk89q.worldedit.world.storage.BlockData use BlockData
com.sk89q.worldedit.masks.BlockMask Use BlockMask
com.sk89q.worldedit.masks.BlockTypeMask replaced by #BlockMask
com.sk89q.worldedit.BlockWorldVector Replace all uses of WorldVectors with Locations
com.sk89q.worldedit.BlockWorldVector2D Replace all uses of WorldVectors with Locations
com.sk89q.worldedit.masks.CombinedMask See MaskIntersection
com.sk89q.worldedit.regions.ConvexPolyhedralRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.CuboidClipboard This is slowly being replaced with Clipboard, which is far more versatile. Transforms are supported using affine transformations and full entity support is provided because the clipboard properly implements Extent. However, the new clipboard class is only available in WorldEdit 6.x and beyond. We intend on keeping this deprecated class in WorldEdit for an extended amount of time so there is no rush to switch (but new features will not be supported). To copy between a clipboard and a world (or between any two Extents), one can use ForwardExtentCopy. See ClipboardCommands and SchematicCommands for more information.
com.sk89q.worldedit.regions.CuboidRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.regions.CylinderRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.masks.DynamicRegionMask Use RequestSelection with RegionMask
com.sk89q.worldedit.regions.EllipsoidRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.masks.ExistingBlockMask See ExistingBlockMask
com.sk89q.worldedit.regions.ExtendingCuboidRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.masks.FuzzyBlockMask See FuzzyBlockMask
com.sk89q.worldedit.masks.InvertedBlockTypeMask
com.sk89q.worldedit.masks.InvertedMask See Masks.negate(com.sk89q.worldedit.function.mask.Mask)
com.sk89q.worldedit.LocalEntity replaced with the new entity API using Entity and BaseEntity
com.sk89q.worldedit.LocalPlayer use Actor (or Player, etc.) instead (and AbstractPlayerActor to extend)
com.sk89q.worldedit.LocalWorld Replace with World wherever appropriate
com.sk89q.worldedit.Location Use Location wherever possible
com.sk89q.worldedit.regions.Polygonal2DRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.patterns.RandomFillPattern See RandomPattern
com.sk89q.worldedit.masks.RandomMask See NoiseFilter
com.sk89q.worldedit.masks.RegionMask See RegionMask
com.sk89q.worldedit.ServerInterface Use Platform wherever possible
com.sk89q.worldedit.patterns.SingleBlockPattern See BlockPattern
com.sk89q.worldedit.masks.SolidBlockMask See SolidBlockMask
com.sk89q.worldedit.regions.SphereRegionSelector This class only exists as to not break binary compatibility
com.sk89q.worldedit.masks.UnderOverlayMask Use OffsetMask with MaskIntersection and Masks.negate(com.sk89q.worldedit.function.mask.Mask)
com.sk89q.worldedit.WorldEditOperation This will be removed with no direct replacement. Please use the WorldEdit API.
com.sk89q.worldedit.WorldVector Use Location wherever possible
com.sk89q.worldedit.WorldVector2D Use Location wherever possible
com.sk89q.worldedit.WorldVectorFace Use Location wherever possible

Deprecated Enums

Enum and Description
com.sk89q.worldedit.VectorFace to be replaced with Direction

Deprecated Exceptions

Exceptions and Description
com.sk89q.worldedit.bags.BlockBagException Block bags are currently not a supported feature of WorldEdit
com.sk89q.worldedit.data.DataException Switch to DataException
com.sk89q.worldedit.bags.OutOfBlocksException Block bags are currently not a supported feature of WorldEdit
com.sk89q.worldedit.bags.OutOfSpaceException Block bags are currently not a supported feature of WorldEdit
com.sk89q.worldedit.bags.UnplaceableBlockException Block bags are currently not a supported feature of WorldEdit

Deprecated Fields

Field and Description
com.sk89q.worldedit.blocks.ItemID.GOLD_RECORD
com.sk89q.worldedit.blocks.ItemID.GREEN_RECORD
com.sk89q.worldedit.blocks.BlockID.LOCKED_CHEST
com.sk89q.worldedit.blocks.BlockID.NETHERSTONE
com.sk89q.worldedit.blocks.BlockID.WOODEN_STAIRS

Deprecated Methods

Method and Description
com.sk89q.worldedit.masks.UnderOverlayMask.addAll(Set<Integer>)
com.sk89q.worldedit.WorldEdit.clearSessions() use WorldEdit.getSessionManager()
com.sk89q.worldedit.blocks.BaseBlock.containsFuzzy(Collection<BaseBlock>, BaseBlock) Use Blocks.containsFuzzy(Collection, BaseBlock)
com.sk89q.worldedit.LocalSession.createEditSession(LocalPlayer) use LocalSession.createEditSession(Player)
com.sk89q.worldedit.world.storage.BlockData.cycle(int, int, int) use BlockData.cycle(int, int, int)
com.sk89q.worldedit.blocks.BaseBlock.cycleData(int) Use BlockData.cycle(int, int, int)
com.sk89q.worldedit.extent.inventory.BlockBag.fetchPlacedBlock(int) Use BlockBag.fetchPlacedBlock(int,int) instead
com.sk89q.worldedit.bags.BlockBag.fetchPlacedBlock(int) Use BlockBag.fetchPlacedBlock(int,int) instead
com.sk89q.worldedit.blocks.BaseBlock.flip() Use BlockData.flip(int, int)
com.sk89q.worldedit.blocks.BaseBlock.flip(CuboidClipboard.FlipDirection) Use BlockData#flip(int, int, FlipDirection)
com.sk89q.worldedit.world.storage.BlockData.flip(int, int) use return BlockData.flip(int, int)
com.sk89q.worldedit.world.storage.BlockData.flip(int, int, CuboidClipboard.FlipDirection) use com.sk89q.worldedit.blocks.BlockData#flip(int, int, FlipDirection)
com.sk89q.worldedit.world.World.generateBigTree(EditSession, Vector) Use #generateTree(TreeType, EditSession, Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.generateBigTree(EditSession, Vector)
com.sk89q.worldedit.world.World.generateBirchTree(EditSession, Vector) Use #generateTree(TreeType, EditSession, Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.generateBirchTree(EditSession, Vector)
com.sk89q.worldedit.world.World.generateRedwoodTree(EditSession, Vector) Use #generateTree(TreeType, EditSession, Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.generateRedwoodTree(EditSession, Vector)
com.sk89q.worldedit.world.World.generateTallRedwoodTree(EditSession, Vector) Use #generateTree(TreeType, EditSession, Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.generateTallRedwoodTree(EditSession, Vector)
com.sk89q.worldedit.world.World.generateTree(EditSession, Vector) Use #generateTree(TreeType, EditSession, Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.generateTree(EditSession, Vector)
com.sk89q.worldedit.WorldEdit.getBlock(Player, String) Use WorldEdit.getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlock(Player, String, boolean) Use WorldEdit.getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlock(Player, String, boolean, boolean) Use WorldEdit.getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.EditSession.getBlockData(Vector) Use EditSession.getLazyBlock(Vector) or EditSession.getBlock(Vector)
com.sk89q.worldedit.world.World.getBlockData(Vector) Use InputExtent.getLazyBlock(Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.getBlockData(Vector)
com.sk89q.worldedit.WorldEdit.getBlockIDs(Player, String, boolean) Use WorldEdit.getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlockMask(Player, LocalSession, String) Use WorldEdit.getMaskFactory() ()} and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlockPattern(Player, String) Use WorldEdit.getPatternFactory() and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlocks(Player, String) Use WorldEdit.getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlocks(Player, String, boolean) Use WorldEdit.getBlockFactory() and AbstractFactory.parseFromInput(String, ParserContext)
com.sk89q.worldedit.WorldEdit.getBlocks(Player, String, boolean, boolean) Use WorldEdit.getBlockFactory() and BlockFactory.parseFromListInput(String, ParserContext)
com.sk89q.worldedit.EditSession.getBlockType(Vector) Use EditSession.getLazyBlock(Vector) or EditSession.getBlock(Vector)
com.sk89q.worldedit.world.World.getBlockType(Vector) Use InputExtent.getLazyBlock(Vector)
com.sk89q.worldedit.internal.LocalWorldAdapter.getBlockType(Vector)
com.sk89q.worldedit.blocks.BaseItem.getDamage()
com.sk89q.worldedit.blocks.BlockType.getDroppedBlock(int) This function ignores the data value.
com.sk89q.worldedit.EditSessionFactory.getEditSession(LocalWorld, int) We are replacing LocalWorld with World, so use EditSessionFactory.getEditSession(World, int) instead
com.sk89q.worldedit.EditSessionFactory.getEditSession(LocalWorld, int, BlockBag) We are replacing LocalWorld with World, so use EditSessionFactory.getEditSession(World, int, BlockBag) instead
com.sk89q.worldedit.EditSessionFactory.getEditSession(LocalWorld, int, BlockBag, LocalPlayer) We are replacing LocalWorld with World, so use EditSessionFactory.getEditSession(World, int, BlockBag, Player) instead
com.sk89q.worldedit.EditSessionFactory.getEditSession(LocalWorld, int, LocalPlayer) We are replacing LocalWorld with World, so use EditSessionFactory.getEditSession(World, int, Player) instead
com.sk89q.worldedit.regions.Polygonal2DRegion.getMininumY()
com.sk89q.worldedit.entity.Player.getPitch() use Entity.getLocation()
com.sk89q.worldedit.CuboidClipboard.getPoint(Vector) use CuboidClipboard.getBlock(Vector) instead
com.sk89q.worldedit.entity.Player.getPosition() use Entity.getLocation()
com.sk89q.worldedit.LocalSession.getRegion() use LocalSession.getSelection(World)
com.sk89q.worldedit.LocalSession.getRegionSelector() use LocalSession.getRegionSelector(World)
com.sk89q.worldedit.LocalSession.getRegionSelector(LocalWorld) Use LocalSession.getRegionSelector(World)
com.sk89q.worldedit.scripting.CraftScriptContext.getSafeFile(String, String)
com.sk89q.worldedit.LocalSession.getSelection(LocalWorld) use LocalSession.getSelection(World)
com.sk89q.worldedit.WorldEdit.getSession(Player) use WorldEdit.getSessionManager()
com.sk89q.worldedit.WorldEdit.getSession(String) Use WorldEdit.getSessionManager()
com.sk89q.worldedit.entity.Player.getYaw() use Entity.getLocation()
com.sk89q.worldedit.EditSession.green(Vector, double) Use EditSession.green(Vector, double, boolean).
com.sk89q.worldedit.WorldEdit.hasSession(Player) use WorldEdit.getSessionManager()
com.sk89q.worldedit.blocks.BaseBlock.inIterable(Iterable<BaseBlock>) This method is silly, use BaseBlock.containsFuzzy(java.util.Collection, BaseBlock) instead.
com.sk89q.worldedit.blocks.BlockType.isNaturalTerrainBlock(int) Use BlockType.isNaturalTerrainBlock(int, int)
com.sk89q.worldedit.LocalSession.isRegionDefined()
com.sk89q.worldedit.LocalSession.isSelectionDefined(LocalWorld) use LocalSession.isSelectionDefined(World)
com.sk89q.worldedit.PlayerDirection.leftVector()
com.sk89q.worldedit.command.ClipboardCommands.load(Actor)
com.sk89q.worldedit.command.SchematicCommands.load(Player, LocalSession, String, String)
com.sk89q.worldedit.CuboidClipboard.loadSchematic(File) use SchematicFormat.MCEDIT
com.sk89q.worldedit.world.storage.BlockData.nextClothColor(int) use BlockData.nextClothColor(int)
com.sk89q.worldedit.world.storage.BlockData.prevClothColor(int) use BlockData.prevClothColor(int)
com.sk89q.worldedit.EditSession.rawGetBlock(Vector) Use EditSession.getBlock(Vector)
com.sk89q.worldedit.EditSession.rememberChange(Vector, BaseBlock, BaseBlock) Get the change set with EditSession.getChangeSet() and add the change with that
com.sk89q.worldedit.WorldEdit.removeSession(Player) use WorldEdit.getSessionManager()
com.sk89q.worldedit.blocks.BaseBlock.rotate90() Use BlockData.rotate90(int, int)
com.sk89q.worldedit.world.storage.BlockData.rotate90(int, int) use BlockData.rotate90(int, int)
com.sk89q.worldedit.blocks.BaseBlock.rotate90Reverse() Use BlockData.rotate90Reverse(int, int)
com.sk89q.worldedit.world.storage.BlockData.rotate90Reverse(int, int) use BlockData.rotate90Reverse(int, int)
com.sk89q.worldedit.command.ClipboardCommands.save(Actor)
com.sk89q.worldedit.command.SchematicCommands.save(Player, LocalSession, String, String)
com.sk89q.worldedit.CuboidClipboard.saveSchematic(File) use SchematicFormat.MCEDIT
com.sk89q.worldedit.world.World.setBlockData(Vector, int) Use OutputExtent.setBlock(Vector, BaseBlock)
com.sk89q.worldedit.EditSession.setBlockIfAir(Vector, BaseBlock) Use your own method
com.sk89q.worldedit.world.World.setBlockType(Vector, int) Use OutputExtent.setBlock(Vector, BaseBlock)
com.sk89q.worldedit.regions.CylinderRegion.setCenter(Vector) replaced by CylinderRegion.setCenter(Vector2D)
com.sk89q.worldedit.blocks.BaseItem.setDamage(short)
com.sk89q.worldedit.WorldEdit.setEditSessionFactory(EditSessionFactory) EditSessionFactories are no longer used. Please register an EditSessionEvent event with the event bus in order to override or catch changes to the world
com.sk89q.worldedit.EditSession.setMask(Mask) Use EditSession.setMask(Mask)
com.sk89q.worldedit.LocalSession.setRegionSelector(LocalWorld, RegionSelector) use LocalSession.setRegionSelector(World, RegionSelector)
com.sk89q.worldedit.world.World.setTypeIdAndData(Vector, int, int) Use OutputExtent.setBlock(Vector, BaseBlock)
com.sk89q.worldedit.WorldEdit.setVersion(String) Declare your platform version with Platform.getPlatformVersion()
com.sk89q.worldedit.regions.Region.setWorld(LocalWorld)
com.sk89q.worldedit.extent.inventory.BlockBag.storeDroppedBlock(int) Use BlockBag.storeDroppedBlock(int, int) instead
com.sk89q.worldedit.bags.BlockBag.storeDroppedBlock(int) Use BlockBag.storeDroppedBlock(int, int) instead
com.sk89q.worldedit.function.mask.Masks.wrap(Mask, EditSession) Please avoid if possible

Deprecated Constructors

Constructor and Description
com.sk89q.worldedit.regions.ConvexPolyhedralRegion(LocalWorld) cast world to World
com.sk89q.worldedit.regions.CuboidRegion(LocalWorld, Vector, Vector) cast world to World
com.sk89q.worldedit.regions.CylinderRegion(LocalWorld) cast world to World
com.sk89q.worldedit.regions.CylinderRegion(LocalWorld, Vector, Vector2D, int, int)
com.sk89q.worldedit.EditSession(LocalWorld, int) use WorldEdit.getEditSessionFactory() to create EditSessions
com.sk89q.worldedit.EditSession(LocalWorld, int, BlockBag) use WorldEdit.getEditSessionFactory() to create EditSessions
com.sk89q.worldedit.regions.EllipsoidRegion(LocalWorld, Vector, Vector)
com.sk89q.worldedit.regions.Polygonal2DRegion(LocalWorld)
com.sk89q.worldedit.regions.Polygonal2DRegion(LocalWorld, List<BlockVector2D>, int, int)
com.sk89q.worldedit.regions.selector.Polygonal2DRegionSelector(LocalWorld, List<BlockVector2D>, int, int) cast world to World
com.sk89q.worldedit.util.TreeGenerator(TreeGenerator.TreeType)
com.sk89q.worldedit.masks.UnderOverlayMask(Set<Integer>, boolean)

Deprecated Enum Constants

Enum Constant and Description
com.sk89q.worldedit.blocks.ItemType.GOLD_RECORD
com.sk89q.worldedit.blocks.ItemType.GREEN_RECORD
com.sk89q.worldedit.blocks.BlockType.LOCKED_CHEST
com.sk89q.worldedit.blocks.ItemType.LOCKED_CHEST