Update docs for capability rework #34
Conversation
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
Deploying with Cloudflare Pages
|
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
There was a problem hiding this comment.
Bunch of general questions because my lack of understanding of the underlying system. I have avoided commenting on syntax changes as much as possible as per your request. They will be addressed at a later point in time since they don't affect the user experience.
docs/datastorage/attachments.md
Outdated
|
|
||
| To use the system, you need to register an `AttachmentType`. | ||
| The attachment type contains: | ||
| - a default value supplier to create the instance when the data is first accessed, or to compare stacks that have the data and stacks that don't have it; |
There was a problem hiding this comment.
Is this only true for stacks, or does it apply to any attached object?
There was a problem hiding this comment.
The default instance is for any attachment holder object (BE, chunk, entity, stack). Only stacks are comparable so that remark only applies to them, but admittedly we could probably omit it.
| Providers are asked for a capability in the order that they are registered. | ||
| Should you want to run before a provider that NeoForge already registers for one of your objects, | ||
| register your `RegisterCapabilitiesEvent` handler with a higher priority. |
There was a problem hiding this comment.
When would this matter?
There was a problem hiding this comment.
For example if you have a LivingEntity and you want to register a more specific IItemHandler than the one NeoForge already registers.
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
There was a problem hiding this comment.
Good enough, any formatting errors can be addressed in a future commit. @XFactHD and @Matyrobbrt, will give you until whenever Thursday to do any additional reviews or comments.
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
|
Looks good to me overall, just a few minor points
Other than that: |
neoforged-pages-deployments
bot
deployed
to
neoforged-docs-previews (Preview)
Mostly adapted from the blog post, but keeping some of the old content where that made sense.
Beyond the two main changed files, I also fixed references to capabilities elsewhere. Some of the other pages will still need an update, but at least everything related to caps should be clean now.
Preview URL: https://pr-34.neoforged-docs-previews.pages.dev