AreaContainmentObject and BiomeTag examples
#2394
Merged
Conversation
This file contains 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
Also de-dented code for 'spawnable_blocks' to make it look more uniform :)
Mechanism not done as they can't be tested currently. Fixed up some funky new lines here and there.
Returns specific data, and so it should probably be shown in the example.
plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java
Outdated
Show resolved
Hide resolved
| @@ -96,6 +96,10 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @description | |||
| // Returns a cuboid approximately representing the maximal bounding box of the area (anything this cuboid does not contain, is also not contained by the area, but not vice versa). | |||
| // For single-member CuboidTags, this tag returns a copy of the cuboid. | |||
| // @Example | |||
| // # Gets the cuboid's bounding box and plays a totem effect at the shell of the cuboid. | |||
There was a problem hiding this comment.
This example makes no sense. A cuboid's bounding box is... just the cuboid.
| @@ -107,6 +111,8 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @returns WorldTag | |||
| // @description | |||
| // Returns the area's world. | |||
| // @Example | |||
There was a problem hiding this comment.
For some reason meta norm is lowercase key names in tags (and capital for most other things, idk why, but, maintain the existing format)
plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java
Show resolved
Hide resolved
| @@ -133,6 +142,9 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @returns ListTag(NPCTag) | |||
| // @description | |||
| // Gets a list of all NPCs currently within the area. | |||
| // @Example | |||
| // # Narrates a list of NPCs' names that are within the area separated by a comma and a space. | |||
| // - narrate "List of NPCs in 'my_cuboid': <cuboid[my_cuboid].npcs.parse[name].separated_by[, ]" | |||
There was a problem hiding this comment.
This is missing the > at the end.
Make sure you actually test your examples.
| @@ -152,6 +164,10 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @returns ListTag(EntityTag) | |||
| // @description | |||
| // Gets a list of all entities currently within the area, with an optional search parameter for the entity. | |||
| // @Example | |||
| // # Narrates all the entities that match 'axolotl' within the area. | |||
| @@ -189,6 +209,12 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @returns ElementTag(Boolean) | |||
| // @description | |||
| // Returns a boolean indicating whether the specified location is inside this area. | |||
| // @Example | |||
| // # Checks to see if "my_cuboid" contains the player's location. | |||
| // - if <cuboid[my_cuboid].contains[<player.location>]: | |||
| // @Example | ||
| // # Narrates the locations of blocks that are flagged "my_flag" | ||
| // - foreach <cuboid[my_cuboid].blocks_flagged[my_flag]> as:block: | ||
| // - narrate <[block]> |
There was a problem hiding this comment.
This is narrating a raw object
| @@ -256,6 +294,9 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @description | |||
| // Returns each block location on the 3D outer shell of the area. | |||
| // This tag is useful for displaying particles or blocks to mark the boundary of the area. | |||
| // @Example | |||
| // # Plays the "TOTEM" effect in the shell of the area. | |||
| // - playeffect effect:TOTEM at:<cuboid[my_cuboid].shell> | |||
There was a problem hiding this comment.
Again, testing, this time for the reason that the playeffect command has a bunch of weirdities and you've hit 2 or 3 of them in this example that you'd see if you tried it.
| @@ -180,6 +180,9 @@ public static void registerTags() { | |||
| // @description | |||
| // Returns this biome's downfall type for when a world has weather. | |||
| // This can be RAIN, SNOW, or NONE. | |||
| // @Example | |||
| // # When in a Plains biome, this fills with 'RAIN'. | |||
There was a problem hiding this comment.
When in doesn't make sense as the example is explicitly only plains
| @@ -96,6 +96,9 @@ static <T extends AreaContainmentObject> void registerTags(Class<T> type, Objec | |||
| // @description | |||
| // Returns a cuboid approximately representing the maximal bounding box of the area (anything this cuboid does not contain, is also not contained by the area, but not vice versa). | |||
| // For single-member CuboidTags, this tag returns a copy of the cuboid. | |||
| // @example | |||
| // # Narrates the cuboids bounding box, which is just the cuboid. | |||
| // - narrate <cuboid[my_cuboid].bounding_box> | |||
| // @example | ||
| // # Narrates the locations of blocks that match "*planks" within the area. | ||
| // - foreach <cuboid[my_cuboid].blocks[*planks]> as:plank: | ||
| // - narrate <[plank]> |
There was a problem hiding this comment.
This is narrating a raw location. Should use a more appropriate example behavior, perhaps a debugblock
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added examples for
AreaContainmentObjecttags andBiomeTagtags.I didn't add mechs for
BiomeTagsyet as I am not currently able to test them.I also fixed up some new line things and de-dented
<AreaContainmentObject.spawnable_blocks>.:)
馃悐馃悐馃悐