Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
org.spongepowered.api.data.manipulator.mutable.tileentity.BedData Use DyeableData instead
org.spongepowered.api.world.schematic.BlockPalette Use Palette for improved generics
org.spongepowered.api.world.schematic.BlockPaletteType Use PaletteType for better generics
org.spongepowered.api.event.entity.BreedEntityEvent
org.spongepowered.api.event.entity.living.humanoid.ChangeLevelEvent Use ChangeEntityExperienceEvent instead
org.spongepowered.api.data.manipulator.immutable.tileentity.ImmutableBedData Use ImmutableDyeableData instead
org.spongepowered.api.event.entity.projectile.LaunchProjectileEvent This is equivalent to SpawnEntityEvent where AffectEntityEvent.getEntities() are Projectiles
org.spongepowered.api.event.entity.SpawnEntityEvent.Spawner Utilize SpawnTypes.MOB_SPAWNER as context.

Deprecated Classes

Class and Description
org.spongepowered.api.data.manipulator.mutable.common.AbstractIntData Useless without its immutable counterpart, use AbstractSingleData instead.
org.spongepowered.api.world.schematic.BlockPaletteTypes Use PaletteTypes.
org.spongepowered.api.data.property.DisplacementProperty As of API 7, intended for removal in API 8, with no alternative due to accidental existence in the API
org.spongepowered.api.util.GuavaCollectors Use methods provided by Guava
org.spongepowered.api.data.key.KeyFactory To be removed in future API versions. Use Key.builder() to create keys.
org.spongepowered.api.data.MemoryDataContainer To be removed in future releases to avoid implementation bugs being part of the API.
org.spongepowered.api.data.MemoryDataView To be moved to implementation to avoid implementation bugs being existing in the API.
org.spongepowered.api.extra.modifier.skylands.SkylandsBiomeGenerator Will be removed from the api
org.spongepowered.api.extra.modifier.skylands.SkylandsGrassPopulator Will be removed from the api
org.spongepowered.api.extra.modifier.skylands.SkylandsGroundCoverPopulator Will be removed from the api
org.spongepowered.api.extra.modifier.skylands.SkylandsTerrainGenerator Will be removed from the api
org.spongepowered.api.extra.modifier.skylands.SkylandsWorldGeneratorModifier Will be removed from the api

Deprecated Fields

Field and Description
org.spongepowered.api.CatalogTypes.ENCHANTMENT Use CatalogTypes.ENCHANTMENT_TYPE instead
org.spongepowered.api.world.schematic.BlockPaletteTypes.GLOBAL See PaletteTypes.GLOBAL_BLOCKS
org.spongepowered.api.data.key.Keys.JOHNNY_VINDICATOR In favor of Keys.IS_JOHNNY to match with the rest of API and in-case other mobs ever support "johnny" mode in any implementation. Will be removed in API 8
org.spongepowered.api.util.TypeTokens.LAST_ATTACKER_TOKEN
org.spongepowered.api.util.TypeTokens.LAST_ATTACKER_VALUE_TOKEN
org.spongepowered.api.text.serializer.TextSerializers.LEGACY_FORMATTING_CODE Legacy formatting codes are being phased out of Minecraft
org.spongepowered.api.world.schematic.BlockPaletteTypes.LOCAL See PaletteTypes.LOCAL_BLOCKS
org.spongepowered.api.world.gen.WorldGeneratorModifiers.SKYLANDS Will be removed from the api
org.spongepowered.api.event.cause.entity.damage.DamageModifierTypes.SWEAPING use DamageModifierTypes.SWEEPING
org.spongepowered.api.world.WorldArchetypes.THE_SKYLANDS Will be removed from the api
org.spongepowered.api.event.cause.EventContextKeys.THROWER this key is a duplicate of EventContextKeys.PROJECTILE_SOURCE and will be removed in API 8. See this issue on SpongeAPI, Use EventContextKeys.PROJECTILE_SOURCE instead.
org.spongepowered.api.event.entity.TameEntityEvent.USED_ITEM Use EventContextKeys.USED_ITEM

Deprecated Methods

Method and Description
org.spongepowered.api.profile.GameProfileCache.add(GameProfile, boolean, Date) Use GameProfileCache.add(GameProfile, boolean, Instant)
org.spongepowered.api.profile.GameProfileCache.add(GameProfile, Date) Use GameProfileCache.add(GameProfile, Instant)
org.spongepowered.api.util.metric.MetricsConfigManager.areMetricsEnabled(Object)
org.spongepowered.api.util.metric.MetricsConfigManager.areMetricsEnabled(PluginContainer)
org.spongepowered.api.item.recipe.crafting.ShapedCraftingRecipe.Builder.EndStep.build(String, Object) Use CatalogBuilder.build() instead in combination with ShapedCraftingRecipe.Builder.EndStep.id(String)
org.spongepowered.api.item.recipe.crafting.ShapelessCraftingRecipe.Builder.EndStep.build(String, Object) Use CatalogBuilder.build() instead in combination with ShapelessCraftingRecipe.Builder.EndStep.id(String)
org.spongepowered.api.data.DataRegistration.Builder.buildAndRegister(PluginContainer) Use DataRegistration.Builder.build() instead
org.spongepowered.api.event.entity.ChangeEntityExperienceEvent.createChangeEntityExperienceEvent(Cause, int, int, Entity)
org.spongepowered.api.event.entity.MoveEntityEvent.Teleport.createMoveEntityEventTeleport(Cause, Transform<World>, Transform<World>, Entity)
org.spongepowered.api.event.entity.MoveEntityEvent.Teleport.Portal.createMoveEntityEventTeleportPortal(Cause, Transform<World>, Transform<World>, PortalAgent, Entity, boolean)
org.spongepowered.api.data.DataRegistration.Builder.dataName(String) Use CatalogBuilder.name(String) instead
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleEnumData.enumType() Use AbstractImmutableSingleEnumData.getValueGetter() instead.
org.spongepowered.api.advancement.Advancement.Builder.from(Advancement)
org.spongepowered.api.advancement.AdvancementTree.Builder.from(AdvancementTree)
org.spongepowered.api.util.CatalogBuilder.from(C) It's not allowed to duplicate catalog types.
org.spongepowered.api.data.DataRegistration.Builder.from(DataRegistration<T, I>)
org.spongepowered.api.data.key.Key.Builder.from(Key<V>)
org.spongepowered.api.advancement.criteria.trigger.Trigger.Builder.from(Trigger<C>)
org.spongepowered.api.Platform.getApi() Use Platform.getContainer(Component) with Platform.Component.API
org.spongepowered.api.block.tileentity.Bed.getBedData() Use Bed.getDyeableData() instead
org.spongepowered.api.event.entity.living.humanoid.player.KickPlayerEvent.getChannel() Not used in this event.
org.spongepowered.api.item.inventory.ItemStackSnapshot.getCount() Use ItemStackSnapshot.getQuantity()
org.spongepowered.api.event.entity.RideEntityEvent.Dismount.getDismountType() Use EventContextKeys.DISMOUNT_TYPE instead
org.spongepowered.api.event.entity.ChangeEntityExperienceEvent.getExperience() Use ChangeEntityExperienceEvent.getFinalData() instead, which provides more information about the experience.
org.spongepowered.api.Platform.getImplementation() Use Platform.getContainer(Component) with Platform.Component.IMPLEMENTATION
org.spongepowered.api.world.Chunk.getInhabittedTime() Due to misspelling, use Chunk.getInhabitedTime() instead
org.spongepowered.api.item.inventory.ItemStack.getItem() Use ItemStack.getType()
org.spongepowered.api.event.entity.ChangeEntityEquipmentEvent.getItemStack() Use ChangeEntityEquipmentEvent.getTransaction() instead
org.spongepowered.api.event.impl.AbstractChangeEntityEquipmentEvent.getItemStack()
org.spongepowered.api.event.action.FishingEvent.Stop.getItemStackTransaction() Use FishingEvent.Stop.getTransactions()
org.spongepowered.api.service.context.Context.getName() This method name is misleading - contexts only have a "key" and "value". It is not immediately clear what "name" relates to. (it could reasonably be either key or value)
org.spongepowered.api.event.entity.living.humanoid.player.KickPlayerEvent.getOriginalChannel() Not used in this event.
org.spongepowered.api.event.entity.ChangeEntityExperienceEvent.getOriginalExperience() Use ChangeEntityExperienceEvent.getOriginalData() instead, which provides more information about the experience.
org.spongepowered.api.event.entity.ChangeEntityEquipmentEvent.getOriginalItemStack() Use ChangeEntityEquipmentEvent.getTransaction() instead
org.spongepowered.api.event.impl.AbstractChangeEntityEquipmentEvent.getOriginalItemStack()
org.spongepowered.api.world.schematic.Schematic.getPalette()
org.spongepowered.api.item.recipe.RecipeRegistry.getRecipes() Use CatalogRegistryModule.getAll() instead.
org.spongepowered.api.GameRegistry.getSelectorFactory() Use the appropriate class in the selector package instead
org.spongepowered.api.event.block.tileentity.SmeltEvent.Interrupt.getSmeltedItems() always empty
org.spongepowered.api.item.inventory.Slot.getStackSize() Use Inventory.totalItems() instead.
org.spongepowered.api.command.args.CommandArgs.getState() Use CommandArgs.getSnapshot() and CommandArgs.applySnapshot(Snapshot) instead
org.spongepowered.api.GameRegistry.getTextSerializerFactory() Use TextSerializers instead
org.spongepowered.api.service.context.Context.getType() The presence of this method is misleading - the context "type" is the same value as the "key". They are not separate attributes, as the presence of two distinct methods would otherwise suggest.
org.spongepowered.api.util.Functional.guavaToJava8(Predicate<E>) Predicate extends Predicate
org.spongepowered.api.data.DataTransactionResult.ifSucessful(Consumer<List<ImmutableValue<?>>>) Use DataTransactionResult.ifSuccessful(Consumer) instead
org.spongepowered.api.item.inventory.ItemStack.Builder.keyValue(Key<? extends BaseValue<E>>, E) As of API 7 due to being a duplicate method. Accomplishes the same thing as ItemStack.Builder.add(Key, Object), so is not needed alongside that, expected for removal in API 8 or 9. Use ItemStack.Builder.add(Key, Object) instead
org.spongepowered.api.data.key.KeyFactory.makeListKey(TypeToken<? extends List<E>>, TypeToken<ListValue<E>>, DataQuery, String, String) Use Key.builder() to build keys. Implementation is being removed in future API versions
org.spongepowered.api.data.key.KeyFactory.makeMapKey(TypeToken<Map<K, V>>, TypeToken<MapValue<K, V>>, DataQuery, String, String) Use Key.builder() to build keys. Implementation is being removed in future API versions
org.spongepowered.api.data.key.KeyFactory.makeOptionalKey(TypeToken<Optional<E>>, TypeToken<OptionalValue<E>>, DataQuery, String, String) Use Key.builder() to build keys. Implementation is being removed in future API versions
org.spongepowered.api.data.key.KeyFactory.makeSetKey(TypeToken<? extends Set<E>>, TypeToken<SetValue<E>>, DataQuery, String, String) Use Key.builder() to build keys. Implementation is being removed in future API versions
org.spongepowered.api.data.key.KeyFactory.makeSingleKey(TypeToken<E>, TypeToken<V>, DataQuery, String, String) Use Key.builder() to build keys. Implementation is being removed in future API versions
org.spongepowered.api.data.DataRegistration.Builder.manipulatorId(String) Use CatalogBuilder.id(String) instead
org.spongepowered.api.world.schematic.Schematic.Builder.palette(BlockPalette) Use Schematic.Builder.blockPalette(Palette)
org.spongepowered.api.world.schematic.Schematic.Builder.paletteType(BlockPaletteType) Use Schematic.Builder.blockPaletteType(PaletteType)
org.spongepowered.api.item.inventory.Inventory.query(Class<?>...) use Inventory.query(QueryOperation...) instead
org.spongepowered.api.item.inventory.Inventory.query(InventoryProperty<?, ?>...) use Inventory.query(QueryOperation...) instead
org.spongepowered.api.item.inventory.Inventory.query(ItemStack...) use Inventory.query(QueryOperation...) instead
org.spongepowered.api.item.inventory.Inventory.query(ItemType...) use Inventory.query(QueryOperation...) instead
org.spongepowered.api.item.inventory.Inventory.query(Object...) use instead
org.spongepowered.api.item.inventory.Inventory.query(Translation...) use instead
org.spongepowered.api.item.inventory.Inventory.queryAny(ItemStack...) use Inventory.query(QueryOperation...) instead
org.spongepowered.api.GameRegistry.register(Class<T>, T) Is scheduled to be removed in API 8, the GameRegistryEvent.Register should be used instead
org.spongepowered.api.item.recipe.RecipeRegistry.register(T) Use the event GameRegistryEvent.Register
org.spongepowered.api.data.DataManager.registerTranslator(Class<T>, DataTranslator<T>) Use the event org.spongepowered.api.event.game.GameRegistryEvent.Register&lt;DataTranslator&lt;?&gt;&gt; instead
org.spongepowered.api.command.args.CommandArgs.removeArgs(Object, Object) Use with CommandArgs.getSnapshot() instead of CommandArgs.getState() with CommandArgs.removeArgs(Snapshot, Snapshot)
org.spongepowered.api.text.selector.Selector.resolveForce(Collection<? extends Extent>) Use Selector.resolve(Collection)
org.spongepowered.api.text.selector.Selector.resolveForce(CommandSource) Use Selector.resolve(CommandSource)
org.spongepowered.api.text.selector.Selector.resolveForce(Extent...) Use Selector.resolve(Extent[])
org.spongepowered.api.text.selector.Selector.resolveForce(Location<World>) Use Selector.resolve(Location)
org.spongepowered.api.command.args.CommandFlags.Builder.setAcceptsArbitraryLongFlags(boolean) in favor of #setUnknownLongFlagBehavior(UnknownFlagBehavior).
org.spongepowered.api.event.entity.living.humanoid.player.KickPlayerEvent.setChannel(MessageChannel) Not used in this event.
org.spongepowered.api.event.entity.ChangeEntityExperienceEvent.setExperience(int) Modify the value returned by ChangeEntityExperienceEvent.getFinalData() instead, which provides more information about the experience.
org.spongepowered.api.event.entity.living.humanoid.player.KickPlayerEvent.setMessageCancelled(boolean)
org.spongepowered.api.command.args.CommandArgs.setState(Object) Use CommandArgs.getSnapshot() and CommandArgs.applySnapshot(Snapshot) instead
org.spongepowered.api.service.context.Context.setValue(String)
org.spongepowered.api.util.blockray.BlockRay.BlockRayBuilder.skipFilter(Predicate<BlockRayHit<E>>...) Use BlockRay.BlockRayBuilder.select(Predicate)
org.spongepowered.api.util.blockray.BlockRay.BlockRayBuilder.skipFilter(Predicate<BlockRayHit<E>>) Use BlockRay.BlockRayBuilder.select(Predicate)
org.spongepowered.api.util.blockray.BlockRay.BlockRayBuilder.stopFilter(Predicate<BlockRayHit<E>>...)
org.spongepowered.api.util.blockray.BlockRay.BlockRayBuilder.stopFilter(Predicate<BlockRayHit<E>>) Confusing name. Use BlockRay.BlockRayBuilder.whilst(Predicate) instead.
org.spongepowered.api.util.GuavaCollectors.toImmutableList() Use ImmutableList.toImmutableList()
org.spongepowered.api.util.GuavaCollectors.toImmutableSet() Use ImmutableSet.toImmutableSet()

Deprecated Constructors

Constructor and Description
org.spongepowered.api.data.manipulator.mutable.common.AbstractBooleanData(boolean, Key<? extends BaseValue<Boolean>>, boolean) Use AbstractBooleanData(Key, boolean, boolean) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractBoundedComparableData(T, Key<MutableBoundedValue<T>>, Comparator<T>, T, T, T) Use AbstractBoundedComparableData(Key, Comparable, Comparable, Comparable, Comparable, Comparator) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableBooleanData(boolean, Key<Value<Boolean>>, boolean) Use AbstractImmutableBooleanData(Key, boolean, boolean) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableBoundedComparableData(T, Key<MutableBoundedValue<T>>, Comparator<T>, T, T, T) Use AbstractImmutableBoundedComparableData(Key, Comparable, Comparable, Comparable, Comparable, Comparator) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableListData(List<E>, Key<? extends BaseValue<List<E>>>) Use AbstractImmutableListData(Key, List) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableMappedData(Map<K, V>, Key<? extends BaseValue<Map<K, V>>>) Use AbstractImmutableMappedData(Key, Map, Map) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleCatalogData(E, E, Key<? extends BaseValue<E>>) Use AbstractImmutableSingleCatalogData(Key, CatalogType, CatalogType) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleData(T, Key<? extends BaseValue<T>>) Use AbstractImmutableSingleData(Key, Object) instead.
org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleEnumData(E, E, Key<Value<E>>) Use AbstractImmutableSingleEnumData(Key, Enum, Enum) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractIntData(int, Key<? extends BaseValue<Integer>>)
org.spongepowered.api.data.manipulator.mutable.common.AbstractListData(List<E>, Key<? extends BaseValue<List<E>>>) Use AbstractListData(Key, List) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractMappedData(Map<K, V>, Key<? extends BaseValue<Map<K, V>>>) Use AbstractMappedData(Key, Map) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleCatalogData(T, Key<Value<T>>) Use AbstractSingleCatalogData(Key, CatalogType) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData(T, Key<? extends BaseValue<T>>) Use AbstractSingleData(Key, Object) instead.
org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleEnumData(E, Key<? extends BaseValue<E>>, E) Use AbstractSingleEnumData(Key, Enum, Enum) instead.
org.spongepowered.api.command.args.ChildCommandElementExecutor(CommandExecutor) Use the other constructor instead. Note: this entire system will be replaced in API 8.
org.spongepowered.api.item.inventory.InventoryArchetypes() Will be made private in API 8
org.spongepowered.api.data.MemoryDataContainer() Use DataContainer.createNew()
org.spongepowered.api.data.MemoryDataContainer(DataView.SafetyMode) Use DataContainer.createNew(org.spongepowered.api.data.DataView.SafetyMode)
org.spongepowered.api.world.SerializationBehaviors() Will be made private in API 8