PSA: SpongeAPI 4.0 and what it means for YOU!

PSA: SpongeAPI 4.0 and what it means for YOU!
@gabizou wrote:

We're making the release of SpongeAPI 4.0 after two months of development additions and minor breakages. Many of these breakages have been made for better quality of life adjustments. For those who are still developing against SpongeAPI 3.1-SNAPSHOT, we'll also be making a small release of 3.1.0. Any further additions to the API will be made against 4.1-SNAPSHOT.

What version of Minecraft is this for?


4.0.0 is targeted for Minecraft 1.8.9. As previously mentioned, Sponge does not back port the API for previous versions of Minecraft. Minecraft 1.8.0 had quite a few security bugs that have been fixed since and overall culminate in 1.8.9.

Will there be bug fixes released for 3.1.0?


Unfortunately, as most of the implementation is already moving forward, backwards incompatible bug fixes will only target their specified versions, be it 4.0.0 or 4.0.1 etc. Any minor bug fixes that can be made for 3.1.0 may be made in the implementations, however we will highly advise you to move towards a 4.x compatible implementation version.

How many plugins will be broken with this update?


Not a great many. The few API breakages we've made were minor and a simple recompile can be achieved. Some plugins that utilize Cause for example may break. A full changelog can be viewed further down.

Is 4.x the last update for Minecraft 1.8.9?


At this time, it is not determined whether 4.x will be the last version for 1.8.9. As it stands, it is not guaranteed that 1.9's branch will be targeting API 5.x as there can be breaking changes necessary during 4.x's lifetime before 1.9 is actually stable.

What's the full changeling?

A rough changelog of 4.0.0's release is as follows:

• New DataFormat API
• Minor changes in DisplayName related Data
• Add ProfileProperty API
• Refactor abstract implementations of DataManipulators
• Add PitchModulation for Sound API
• Change inventory opening/closing to Players only
• Require a Cause when opening/closing inventories
• Expose head rotations
• Add ChatType to MessageChannel
• TargetedLocation uses a Vector3d instead of Location
• PopulateChunkEvent.Post no longer includes populated transactions, use the World Gen API to modify these sort of things
• Switch using ListenableFuture to CompletableFuture
• Add Plugin Annotation Processor for File metadata generation
• Add TextTemplate API
• MessageEvent changes in relation to TextTemplates
• Change RespawnLocationData to use new RespawnLocation which bundles a boolean value for forced locations
• Refactor TabList API
• Add AssetManager for managing assets
• Improve Pagination API
• Clean up Economy Account creation
• Add ItemStackGenerator, TradeOfferGenerator, and TradeOfferListMutator API, modify TradeOffers to use ItemStackSnapshots
• Ues DyeableData for all colored blocks (wool, clay, carpet, glass)
• Refactor SpawnCause for proper implementation, provides abstract SpawnCauses for plugin extension
• Same treatment to HealingSource

​

Posts: 2

Participants: 1

Read full topic

 

PSA: SpongeAPI 4.0 и что это значит для вас!
@gabizou писал:

Мы делаем релиз SpongeAPI 4.0 после двух месяцев разработки дополнений и незначительных перерывов. Многие из этих перерывов были сделаны для поддержания нашего здоровья и жизни в общем. Для тех, кто еще только начинает писать на SpongeAPI 3.1-SNAPSHOT, мы также будем делать небольшой релиз 3.1.0-SNAPSHOT. Любые дальнейшие дополнения к API будут сделаны после 4.1-SNAPSHOT.

Какая версия minecraft подойдёт для релиза?

4.0.0 расчитан для minecraft 1.8.9. Как уже упоминалось ранее, Sponge не поддерживает API для предыдущих версий minecraft. Майнкрафт 1.8.0 имеет немало ошибок безопасности, которые были исправлены совсем недавно и завершатся в целом в 1.8.9.

Будут ли исправления выпущенные для 3.1.0?

К сожалению, как и большая часть реализации - это уже движение вперед, позади несовместимые исправления, которые нумируются только для целевых указанных версий, будь то 4.0.0 или 4.0.1 и т. д. Любые незначительные исправления ошибок, которые могут быть сделаны для 3.1.0 могут быть добавлены, однако мы настоятельно рекомендуем Вам двигаться в направлении 4.x так как это - совместимая версия для 1.8.

Сколько плагинов перестанет работать в этом обновлении?

Не большое множество. В данном API-интерфейсе мы сделали незначительные изменения и простая рекомпиляция вашего плагина может исправить все ошибки. Некоторые плагины, использующие причины (Cause), могут не работать. Полный список изменений можно посмотреть ниже.

Является ли 4.х последним обновлением для minecraft 1.8.9?

На этот раз, мы не решили, будет ли 4.х последней версией для 1.8.9. Как можно заметить, не гарантируется, что на релиз 1.9 будет предназначаться API 5.x, так как там могут быть критические изменения, которые могут изменяться в 4.х до того, как выйдет 1.9 стабильная.

Какие именно изменения произошли?

Вот примерный список изменений в 4.0.0 release:

• Новый API-интерфейс для DataFormat
• Незначительные изменения в методе displayname связанные с данными
• Добавлен ProfileProperty API
• Рефакторинг абстрактных реализаций DataManipulators
• Добавлен PitchModulation для API звука
• Изменена инвентаризация открытия/закрытия только для игроков
• Требование (Cause) вызывать при открытии/закрытии инвентаря
• Решён поворот голов? (Expose head rotations)
• Добавлен ChatType к элементу MessageChannel
• TargetedLocation использует вместо местоположения объекта vector3d
• PopulateChunkEvent.Post больше не включает в себя популяционные транзакции, используйте API World Gen чтобы изменять род вещей
• Переключение между использованием ListenableFuture и CompletableFuture
• Добавлен плагин аннотации процессора для файла метаданных генерации Add Plugin Annotation Processor for File metadata generation
• Добавить TextTemplate по API
• MessageEvent изменения в отношении TextTemplates
• Изменение RespawnLocationData используйте новые RespawnLocation которые включает логическое значение для нужного места
• Рефакторинг API для TabList
• Добавлен AssetManager для управления asset'ами
  
• Более удобная разбивка данных в API
• Удалена (Clean up) возможность создания экономической учётной записи
• Добавлен ItemStackGenerator, TradeOfferGenerator, и TradeOfferListMutator API-интерфейс, чтобы модифицировать TradeOffers для использования ItemStackSnapshots
• Возможность использовать DyeableData на все цветные блоки (шерсть, глина, ковер, стекло)
• Рефакторинг SpawnCause для надлежащего осуществления, обеспечивает абстрактное SpawnCauses для возможности расширения плагином
• Одинаковое отношение к HealingSource

Подробнее...