PaperMC / PaperMC/Paper

Remove @Internal from Note.getId()

Open
#12,919 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
12.7k
Forks
3.5k
Avg merge
3d 13h
Merged PRs (30d)
11

Description

Is your feature request related to a problem?

The ID value represents a block state property and is used as part of the type's constructor which is not marked as @Internal. It is not some unreliable internal magic value, there are reasonable justifications as to why someone may need access this value.

Describe the solution you'd like.

Remove the @Internal annotation from Note.getId().

Describe alternatives you've considered.

Using it anyway, which I can and will do. However as the value isn't really internal, there is no reason it should be marked as such.

Other

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating Note.getId() in the Paper API sources and inspect the @Internal annotation on that method. Done when the annotation is removed and the project’s relevant API or build checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.