Updating @example sections for several EntityTag Mechanism's and Tags. #2813
+22
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
mcmonkey4eva
reviewed
Feb 2, 2026
| // @returns ElementTag | ||
| // @deprecated Use 'EntityTag.type' on MC 1.20+. | ||
| // @description | ||
| // Returns the entities type. NOTE: For NPC's it will say "PLAYER". |
mcmonkey4eva
reviewed
Feb 2, 2026
| // Deprecated in favor of <@link tag EntityTag.type> on MC 1.20+, which returns entity type names as specified by Mojang (scripts using this may need an update when switching). | ||
| // @example | ||
| // # Describes the type of entity at the players cursor in the world. | ||
| // # For use in-game: /ex narrate <player.target.entity_type> |
Member
There was a problem hiding this comment.
we do not need every example doc to tell you about the /ex command
mcmonkey4eva
reviewed
Feb 2, 2026
| // Returns the type of the entity. | ||
| // @example | ||
| // # Checks if the entity that a player is looking at is also a player. | ||
| // # - if <player.target.type> == Player: |
Member
There was a problem hiding this comment.
this is a bad script, for multiple reasons. The if/else is silly, the target tag is used without a fallback
mcmonkey4eva
reviewed
Feb 2, 2026
| // @example | ||
| // # Checks if the player's name is "mcmonkey". | ||
| // # For use in game: /ex narrate <player.name.matches[mcmonkey]> | ||
| // - if <player.name> == mcmonkey: |
Member
There was a problem hiding this comment.
This is actively violating one of the basic points in the Denizen beginner's guide
mcmonkey4eva
reviewed
Feb 2, 2026
| // @example | ||
| // # Narrates the linked player's eye location. | ||
| // # /ex narrate <player.eye_location> | ||
| // - narrate <player.eye_location> |
Member
There was a problem hiding this comment.
just narrating tags is not a very good example usage
Entity.world and velocity had examples that weren't very useable in their generated form.
Author
|
Thanks for the feedback, I opened a thread on the discord. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds some missing @example sections to various Mechanisms and Tags.
Tags:
Mechanisms: