[1.21.x] TODOs and NBT cleanup for entities

[robotgryphon]

• Deprecates persistent data (use data attachments)
• Deprecates INBTSerializer for entities (data attachments/workarounds)
• Method renames for the 1.19 world -> level change

[neoforged-pr-publishing]

• Publish PR to GitHub Packages

Last commit published: b5395d2403737c40f13aedc73cba7c1f9944f58f.

PR Publishing

The artifacts published by this PR:

• 📦 net.neoforged:neoforge:21.0.90-beta-pr-1166-feature-nbt-entity-cleanup
• 📦 net.neoforged:testframework:21.0.90-beta-pr-1166-feature-nbt-entity-cleanup

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1166' // https://github.com/neoforged/NeoForge/pull/1166
        url 'https://prmaven.neoforged.net/NeoForge/pr1166'
        content {
            includeModule('net.neoforged', 'neoforge')
            includeModule('net.neoforged', 'testframework')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1166.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1166
cd NeoForge-pr1166
curl -L https://prmaven.neoforged.net/NeoForge/pr1166/net/neoforged/neoforge/21.0.90-beta-pr-1166-feature-nbt-entity-cleanup/mdk-pr1166.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

[Technici4n]

I believe that there are some uses cases for entity persistent data, for example marking item entities that should not be picked up by magnets, and other similar cases of mod compat.

I agree with the other changes.

[robotgryphon]

I believe that there are some uses cases for entity persistent data, for example marking item entities that should not be picked up by magnets, and other similar cases of mod compat.

I agree with the other changes.

You'd rather keep persistent data when attachments exist, for stuff like magnet control? That feels like a capability or attachment thing.. persistent data is like using a sword when you have a scalpel nearby.

[neoforged-compatibility-checks]

@robotgryphon, this PR introduces breaking changes.
Fortunately, this project is currently accepting breaking changes, but if they are not intentional, please revert them.
Last checked commit: b5395d2403737c40f13aedc73cba7c1f9944f58f.

neoforge (:neoforge)

• net/minecraft/world/entity/Entity
  • onAddedToWorld()V: ❗ API method was removed
  • onRemovedFromWorld()V: ❗ API method was removed
  • isAddedToWorld()Z: ❗ API method was removed
• net/neoforged/neoforge/common/extensions/IEntityExtension
  • onAddedToWorld()V: ❗ API method was removed
  • isAddedToLevel()Z: ❗ Method was made abstract
  • onRemovedFromWorld()V: ❗ API method was removed
  • isAddedToWorld()Z: ❗ API method was removed
  • onAddedToLevel()V: ❗ Method was made abstract
  • onRemovedFromLevel()V: ❗ Method was made abstract

[TelepathicGrunt]

Could we skip deprecating/removing persistentData? It is easier for mod compat without compile dependencies at the moment which Data Attachments doesn't fully replace very well at the moment

[HenryLoenwind]

Could we skip deprecating/removing persistentData? It is easier for mod compat without compile dependencies at the moment which Data Attachments doesn't fully replace very well at the moment

Or could neo maybe provide a simple network-synced data attachment that's a Map<String, String> for mod interop? That way, the new system would be used, there'd be no compile-time dependency, and it'd be dead simple to use.

And as bonus, the javadoc could give two nice examples, key="doNotMagnet", value=anything non-empty (preferably modId of the mod to set this) to prevent an item from being attracted by magnets completely and "key="magnetReserved", value=any unique ID" to reserve an item for one specific magnet.

And no, we cannot prevent modders from stuffing their mod's whole save state into one of those Strings if they want.

[sciwhiz12]

Merge when ready.

[sciwhiz12]

Merge when ready.