[1.15.x] Rewrite docs for Registries #312
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
tterrag1098
requested changes
Jul 19, 2020
| ------------------------------------- | ||
|
|
||
| It is possible to have Forge inject values from registries into `public static final` fields of classes. This is done by annotating classes and fields with `@ObjectHolder`. If a class has this annotation, all the `public static final` fields within are taken to be object holders too, and the value of the annotation is the namespace of the holder (i.e. every field uses it as the default namespace for the registry name of the object to inject). If a field has this annotation, and the value does not contain a namespace, the namespace is chosen from the surrounding class's `@ObjectHolder` annotation. If the class is not annotated in this situation, the field is ignored with a warning. If it does contain a namespace, then the object to inject into the field is the object with that name. If the class has the annotation and one of the `public static final` fields does not, then the resource path of the object's name is taken to be the field's name. The type of the registry is taken from the type of the field. | ||
| It is possible to have Forge inject registered object from registries into the `public static` fields of classes. This is done by annotating classes or fields with `@ObjectHolder` and supplying enough information to construct a `ResourceLocation` that identifies a specific object in a specific registry. |
There was a problem hiding this comment.
This section should take a back seat to a section about RegistryObject which should also be documented. If you are injecting third-party entries this is the far superior way to do it.
There was a problem hiding this comment.
Hm, I only recently learned that RegistryObjects can be instantiated; I thought that it was a DeferredRegister class.
I'm going to make a new section on this.
|
Also, everything in here is relevant for 1.14.x too, so it should target that branch. |
tterrag1098
added
Out of Date Information
|
Since 1.14.x is essentially the same as 1.15.x in terms of registries, I'll integrate these reviews into the 1.14.x branch and close this PR. Thank you. |
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.
Rewrote the documentation for [Concepts > Registries]:
This is an update of my earlier PR for 1.14.x. See that PR for earlier reviews.
Closes #275 and #85.