Skip to content
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

Update wiki #308

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Update wiki #308

merged 1 commit into from
Nov 13, 2024

Conversation

SoSeDiK
Copy link
Contributor

@SoSeDiK SoSeDiK commented Nov 12, 2024

  • Update wiki to reflect 2.14.0 changes
  • Clarify ItemMeta usage with NBT

ItemMeta usage clarifications
Copy link

sonarcloud bot commented Nov 12, 2024

Copy link

what-the-diff bot commented Nov 12, 2024

PR Summary

  • Updated User Instructions for the NBT Class
    A major update has been implemented to the instructions on how to use the NBT class properly. This emphasizes the importance of referring to the detailed instructions (Javadocs) for specific scenarios.

  • Added New Usage Examples
    New examples depicting how to include pre-existing NBT components to a list have been added. In addition, instructions that dictate the correct way to use 'ItemMeta' feature along with NBT are emphasized, thereby helping to prevent potential information loss.

  • Introduced Warning for Potential NBT Changes Overwrite
    A core feature of this PR is a warning message put out about the potential risk of overwriting NBT changes when utilizing 'ItemMeta'. Examples demonstrating both the correct and the incorrect practices are provided.

  • Clarified Handling of NBT Files
    To give a clearer understanding of the handling of NBT files, the terminology has been refined. References from 'NBTFile' have been switched to 'NBTFileHandle', effectively communicating that files would be automatically created if they don’t exist beforehand.

  • Inclusion of Examples for Reading Non-Existent NBT Files
    The PR also includes examples on how to read from NBT files even if they don't exist. This a useful addition for many users.

  • Emphasis on Appropriate Approach for Modifying Vanilla Data and Reading Components from Items
    The PR further places emphasis on the correct procedure of modifying vanilla data and how to effectively read components from items. This clear guideline ensures overall better data handling.

@tr7zw tr7zw merged commit 3425a66 into tr7zw:master Nov 13, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants