-
-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Explain blocks and blockstates in more depth #21
Explain blocks and blockstates in more depth #21
Conversation
Deploying with Cloudflare Pages
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
More explanations and examples are necessary. Also, if you are rewriting the page, use the notes in the new contribution guidelines.
I was under the impression that we held to the old project's standard of not including example code in the docs. As I understand it, this has changed, so I will update the PR accordingly. |
Yeah, generally prefer pseudocode like java with comments over exact examples unless necessary. The guidelines should show an example |
Rewrote major parts of it to consider the feedback, examples have been added. I also added a WIP method reference page that I will finish tomorrow (hopefully). Converting to draft for now. |
I also dismissed most of the feedback since I fixed most of it when rewriting ("fixed" from my point of view). If there are problems with it still, feel free to re-add feedback as needed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, this has improved so much. In general, I think the detail is great, but there are instances where you are straight up defining the method. That's fine when comparing between vanilla and NeoForge, but I believe most of those descriptions should go into Parchment or NeoForge itself. The interaction workflow meanwhile, can probably stick around.
Anything else I still need to think on what makes sense in the docs. I'm now marking this as the issue to resolve the block portion of #20
Co-authored-by: ChampionAsh5357 <[email protected]>
Co-authored-by: ChampionAsh5357 <[email protected]>
Co-authored-by: ChampionAsh5357 <[email protected]>
Co-authored-by: Dennis C <[email protected]>
Co-authored-by: Dennis C <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Final thing I missed yesterday, finally good to go from me when that's fixed
Co-authored-by: Dennis C <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Will try to merge on phone.
This PR improves and expands on the explanation of blocks and blockstates. More specifically, it:
new Block()
is a bad ideaBlockState
rather than aBlock
, and why that is the caseBlockState
's most important usecases, specificallyBlockState#getProperty
,BlockState#setProperty
,Level#getBlockState
andLevel#setBlock
Level#setBlock
Preview URL: https://pr-21.neoforged-docs-previews.pages.dev