PrismarineJS / PrismarineJS/minecraft-data

entity_effect : rename hideParticles to flags

Open
#501 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
938
Forks
294
Avg merge
2d 10h
Merged PRs (30d)
23

Description

In reference to: https://github.com/PrismarineJS/node-minecraft-protocol/issues/951

Would it be possible to rename the hideParticles field to flags like in the protocol definitions?
https://wiki.vg/Protocol#Entity_Effect

hideParticles is a bit missleading and doesnt represent the two other values behind the flags

        "packet_entity_effect": [
          "container",
          [
            {
              "name": "entityId",
              "type": "varint"
            },
            {
              "name": "effectId",
              "type": "i8"
            },
            {
              "name": "amplifier",
              "type": "i8"
            },
            {
              "name": "duration",
              "type": "varint"
            },
            {
              "name": "hideParticles",
              "type": "i8"
            }
          ]
        ]

Contributor guide

No contributing guide indexed for this repository

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

Locate the packet_entity_effect definition in the minecraft-data protocol data and inspect how its fields are represented. Compare the current hideParticles field with the wiki.vg Entity Effect definition and rename it to flags, checking the surrounding data for consistency.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.