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

Add 'Client' suffix to some 'World' methods to indicate that they only work on the client #4052

Open
wants to merge 5 commits into
base: 24w46a
Choose a base branch
from

Conversation

Octol1ttle
Copy link
Contributor

@Octol1ttle Octol1ttle commented Nov 17, 2024

  • change: add 'Client' suffix to some 'World' methods to indicate that they only work on the client
    Self-explanatory.
  • change(World#playSound): explain the behavior on client vs. server in more detail
    Explains that, on the client, the sound will play if it's the same as the client's player (source == this.client.player). On the server, every player except the source will get a sound packet.
  • Add Javadocs to World#add(Important)ParticlesClient
    The Javadocs explain what an "important" particle is, what these methods do on the server (nothing), and reference the ServerWorld method used for spawning particles in case the developer is looking for it.

@Octol1ttle Octol1ttle requested a review from Syst3ms November 17, 2024 18:18
@apple502j apple502j added the impactful A change that is likely to affect some mods. Will require more reviews. label Nov 19, 2024
@Shnupbups Shnupbups added refactor A PR that renames existing names. snapshot A PR that targets a snapshot version of Minecraft javadoc A PR that adds or refactors javadoc. labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impactful A change that is likely to affect some mods. Will require more reviews. javadoc A PR that adds or refactors javadoc. refactor A PR that renames existing names. snapshot A PR that targets a snapshot version of Minecraft
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants