Registry Modification API #8920
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Machine-Maker
added
the
status: blocked
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
a9bf51a to
2f40827
Compare
jpenilla
reviewed
Feb 27, 2023
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
2f40827 to
52f2089
Compare
kennytv
reviewed
Feb 28, 2023
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
8db100c to
1edf434
Compare
Machine-Maker
removed
the
status: blocked
Lulu13022002
reviewed
Mar 2, 2023
patches/server/0964-Support-registry-mod-API-with-GameEvent.patch
Outdated
Show resolved
Hide resolved
patches/server/0964-Support-registry-mod-API-with-GameEvent.patch
Outdated
Show resolved
Hide resolved
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
4faadcf to
41d255f
Compare
|
Updated for 1.19.4 and moved the vibration level to the builder so that it can be changed. Also added a test to make sure the match the map that was previously used. |
patches/server/0962-Support-registry-mod-API-with-GameEvent.patch
Outdated
Show resolved
Hide resolved
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
5ace877 to
19508f6
Compare
2 tasks
Machine-Maker
force-pushed
the
feature/registry-modification
branch
2 times, most recently
from
9b1ff9b to
d0708a3
Compare
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
d0708a3 to
b9991c4
Compare
Machine-Maker
force-pushed
the
feature/registry-modification
branch
2 times, most recently
from
73ec071 to
ee324d6
Compare
|
For the GameEvent builder, I decided to not make the vibration level configurable there. They are really 2 different systems, the vibration stuff and game events. Not all game events are listened to for vibrations, so I think a better solution is to use the game event bukkit events to change the level of certain game events. I also reverted the change that changed all the static final fields in GameEvent to Reference because we are now going with code generation to generate a file full of keys for GameEvent for use with the registry mod api. |
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
18eebc2 to
c32bcc0
Compare
Owen1212055
reviewed
May 28, 2023
Owen1212055
reviewed
May 28, 2023
Comment on lines
316
to
251
| +/** | ||
| + * Register listeners to points in a registry's lifecycle. | ||
| + */ | ||
| [email protected] | ||
| [email protected] | ||
| +public interface RegistryManager { | ||
| + | ||
| + /** | ||
| + * Register a listener which is called when an object is about | ||
| + * to be added to the specified registry. Useful for modifying | ||
| + * objects before they are added. | ||
| + * | ||
| + * @param registryKey the registry key | ||
| + * @param listener an instance of the listener | ||
| + * @param <T> object type | ||
| + * @param <B> object builder type | ||
| + */ | ||
| + <T extends Keyed, B extends RegistryBuilder<T>> void registerAdditionListener(@NotNull RegistryKey<T> registryKey, @NotNull RegistryAdditionListener<T, B> listener); | ||
| + | ||
| + /** | ||
| + * Register a listener which is called when a registry is about | ||
| + * to be frozen. Useful for adding new entries to registries | ||
| + * that support custom entries. | ||
| + * | ||
| + * @param registryKey the registry key | ||
| + * @param listener an instance of the listener | ||
| + * @param <T> object type | ||
| + * @param <B> object builder type | ||
| + */ | ||
| + <T extends Keyed, B extends RegistryBuilder<T>> void registerPreFreezeListener(@NotNull RegistryKey<T> registryKey, @NotNull RegistryPreFreezeListener<T, B> listener); | ||
| +} |
There was a problem hiding this comment.
It may just be me, but I find the usage of "register" in the context of registries despite being used for the listener system be a bit confusing.
Although it would deviate from PluginManger's registerEvent naming scheme.. I think it may be better to reduce confusion.
Maybe something like:
newRegisterListener,newRegistrationListener,onRegistrationonFinalization,onPreFreeze,onRegistryFinalization
I am not sure, the point is, I think that we should perhaps not use the term register here as it may be a bit confusing. Although, just seeing what others might think here.
Owen1212055
reviewed
May 28, 2023
Owen1212055
reviewed
May 28, 2023
Owen1212055
reviewed
May 28, 2023
Machine-Maker
force-pushed
the
feature/registry-modification
branch
3 times, most recently
from
1ff0675 to
38e3441
Compare
kennytv
reviewed
May 28, 2024
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
38e3441 to
6a9d061
Compare
56738
reviewed
Jun 8, 2024
Machine-Maker
force-pushed
the
feature/registry-modification
branch
3 times, most recently
from
e882fe4 to
0511ba4
Compare
kennytv
approved these changes
Jun 9, 2024
|
🥳❔ |
Machine-Maker
force-pushed
the
feature/registry-modification
branch
3 times, most recently
from
d7fc4f7 to
6385241
Compare
Machine-Maker
force-pushed
the
feature/registry-modification
branch
from
7054949 to
df157b7
Compare
|
Merged into preliminary 1.21 registry dev branch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds two new "events" that PluginBootstrap can register to which enable modification and addition to both built-in and data-driven registries. This opens up tons of new possibilities for plugins to customize things with API that was previously only possible with nms/reflection.
Data-Driven: Types which are loaded purely from datapacks (custom and vanilla)
Built-In: Loaded via source code, never read from a file
There are two events plugins can listen to, one is fired when an "entry" is about to be added to a registry, either a built-in or data-driven. This allows modification of the "entry" before it's registered. The second event is fired right before the registry is frozen (to prevent new additions). This is used to add completely new entries.
Demo
There are two "demonstration" apis added, one for ChatType and one for GameEvent. Just allows some very simply customization, more just to show how it works for both built-in and data-driven types.
TODO