From ffa29f1d710b87787767cb5b9b8fe3ffc5e0aad8 Mon Sep 17 00:00:00 2001 From: Alex 'mcmonkey' Goodwin Date: Tue, 15 Jun 2021 14:10:32 -0700 Subject: [PATCH] meta corrections --- .../denizen/objects/AreaContainmentObject.java | 12 ++++++++++++ .../com/denizenscript/denizen/objects/ColorTag.java | 2 +- .../denizenscript/denizen/objects/InventoryTag.java | 6 +++--- .../denizenscript/denizen/objects/LocationTag.java | 3 ++- .../com/denizenscript/denizen/objects/NPCTag.java | 2 +- .../denizen/tags/core/BiomeTagBase.java | 2 +- .../denizen/tags/core/ChunkTagBase.java | 2 +- .../denizen/tags/core/ColorTagBase.java | 2 +- .../denizen/tags/core/CuboidTagBase.java | 2 +- .../denizen/tags/core/EllipsoidTagBase.java | 2 +- .../denizen/tags/core/EntityTagBase.java | 2 +- .../denizen/tags/core/InventoryTagBase.java | 2 +- .../denizenscript/denizen/tags/core/ItemTagBase.java | 2 +- .../denizen/tags/core/LocationTagBase.java | 2 +- .../denizen/tags/core/MaterialTagBase.java | 2 +- .../denizenscript/denizen/tags/core/NPCTagBase.java | 2 +- .../denizen/tags/core/PlayerTagBase.java | 2 +- .../denizen/tags/core/PluginTagBase.java | 2 +- .../denizen/tags/core/PolygonTagBase.java | 2 +- .../denizen/tags/core/ServerTagBase.java | 6 +++--- .../denizen/tags/core/TradeTagBase.java | 2 +- .../denizen/tags/core/WorldTagBase.java | 2 +- 22 files changed, 38 insertions(+), 25 deletions(-) diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java b/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java index bb67a0c24c..41b4cca74f 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java +++ b/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java @@ -5,6 +5,18 @@ public interface AreaContainmentObject extends ObjectTag { + // <--[ObjectType] + // @name AreaObject + // @prefix None + // @base None + // @format + // N/A + // + // @description + // "AreaObject" is a pseudo-ObjectType that represents any object that indicates a world-space area, such as a CuboidTag. + // + // --> + String getNoteName(); boolean doesContainLocation(Location loc); diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java b/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java index 0d3b32d364..6ed7a59d13 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java +++ b/plugin/src/main/java/com/denizenscript/denizen/objects/ColorTag.java @@ -198,7 +198,7 @@ public static void registerTags() { // <--[tag] // @attribute - // @returns ElementTag) + // @returns ElementTag // @description // Returns a hex code formatting of this color, like '#ff00ff'. // --> diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java b/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java index e1734462c2..2285c8c680 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java +++ b/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java @@ -1971,10 +1971,10 @@ else if (meta.hasDisplayName() && CoreUtilities.toLowerCase(meta.getDisplayName( // <--[tag] // @attribute |...]> - // @returns ItemTag or ListTag(ItemTag) + // @returns ObjectTag // @description - // If one slot is specified, returns the item in the specified slot. - // If more than what slot is specified, returns a list of the item in each given slot. + // If one slot is specified, returns the ItemTag in the specified slot. + // If more than what slot is specified, returns a ListTag(ItemTag) of the item in each given slot. // --> registerTag("slot", (attribute, object) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java b/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java index a283008a64..25ba071666 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java +++ b/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java @@ -1409,11 +1409,12 @@ public static void registerTags() { // <--[tag] // @attribute - // @returns ElementTag|ElementTag + // @returns ElementTag // @mechanism LocationTag.skull_skin // @description // Returns the skin the skull item is displaying - just the name or UUID as text, not a player object, // along with the permanently cached texture property. + // In format "uuid|texture" - separated by a pipe, but not a ListTag. // --> if (attribute.startsWith("full", 2)) { attribute.fulfill(1); diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java b/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java index 265f2631c1..2f62f5c009 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java +++ b/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java @@ -815,7 +815,7 @@ else if (attribute.startsWith("list", 2)) { // <--[tag] // @attribute - // @returns PlayerTag/ElementTag + // @returns PlayerTag // @mechanism NPCTag.owner // @description // Returns the owner of the NPC as a PlayerTag if it's a player, otherwise as just the name. diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/BiomeTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/BiomeTagBase.java index aeaf8ba25f..6215eae83a 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/BiomeTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/BiomeTagBase.java @@ -12,7 +12,7 @@ public BiomeTagBase() { // @returns BiomeTag // @description // Returns a biome object constructed from the input value. - // Refer to <@link language BiomeTag objects>. + // Refer to <@link objecttype BiomeTag>. // --> TagManager.registerTagHandler("biome", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ChunkTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ChunkTagBase.java index 14b9319183..49947af4f6 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ChunkTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ChunkTagBase.java @@ -12,7 +12,7 @@ public ChunkTagBase() { // @returns ChunkTag // @description // Returns a chunk object constructed from the input value. - // Refer to <@link language ChunkTag objects>. + // Refer to <@link objecttype ChunkTag>. // --> TagManager.registerTagHandler("chunk", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ColorTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ColorTagBase.java index d6d7a251fc..d450372740 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ColorTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ColorTagBase.java @@ -12,7 +12,7 @@ public ColorTagBase() { // @returns ColorTag // @description // Returns a color object constructed from the input value. - // Refer to <@link language ColorTag objects>. + // Refer to <@link objecttype ColorTag>. // --> TagManager.registerTagHandler("color", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/CuboidTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/CuboidTagBase.java index a8a3d1f9bd..2e4d3c04ed 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/CuboidTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/CuboidTagBase.java @@ -12,7 +12,7 @@ public CuboidTagBase() { // @returns CuboidTag // @description // Returns a cuboid object constructed from the input value. - // Refer to <@link language CuboidTag objects>. + // Refer to <@link objecttype CuboidTag>. // --> TagManager.registerTagHandler("cuboid", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/EllipsoidTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/EllipsoidTagBase.java index 5ba3b198b5..41b7ec59af 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/EllipsoidTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/EllipsoidTagBase.java @@ -12,7 +12,7 @@ public EllipsoidTagBase() { // @returns EllipsoidTag // @description // Returns an ellipsoid object constructed from the input value. - // Refer to <@link language EllipsoidTag objects>. + // Refer to <@link objecttype EllipsoidTag>. // --> TagManager.registerTagHandler("ellipsoid", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/EntityTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/EntityTagBase.java index 575f30b6f6..52c90c1451 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/EntityTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/EntityTagBase.java @@ -12,7 +12,7 @@ public EntityTagBase() { // @returns EntityTag // @description // Returns an entity object constructed from the input value. - // Refer to <@link language EntityTag objects>. + // Refer to <@link objecttype EntityTag>. // --> TagManager.registerTagHandler("entity", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/InventoryTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/InventoryTagBase.java index fab96934b9..fb305c3bb7 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/InventoryTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/InventoryTagBase.java @@ -12,7 +12,7 @@ public InventoryTagBase() { // @returns InventoryTag // @description // Returns an inventory object constructed from the input value. - // Refer to <@link language InventoryTag objects>. + // Refer to <@link objecttype InventoryTag>. // --> TagManager.registerTagHandler("inventory", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ItemTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ItemTagBase.java index 2fae613df3..afa576af28 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ItemTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ItemTagBase.java @@ -12,7 +12,7 @@ public ItemTagBase() { // @returns ItemTag // @description // Returns an item object constructed from the input value. - // Refer to <@link language ItemTag objects>. + // Refer to <@link objecttype ItemTag>. // --> TagManager.registerTagHandler("item", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/LocationTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/LocationTagBase.java index a0266dca58..1360d8ed27 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/LocationTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/LocationTagBase.java @@ -12,7 +12,7 @@ public LocationTagBase() { // @returns LocationTag // @description // Returns a location object constructed from the input value. - // Refer to <@link language LocationTag objects>. + // Refer to <@link objecttype LocationTag>. // --> TagManager.registerTagHandler("location", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/MaterialTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/MaterialTagBase.java index 75ede79934..30c90fd38b 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/MaterialTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/MaterialTagBase.java @@ -12,7 +12,7 @@ public MaterialTagBase() { // @returns MaterialTag // @description // Returns a material object constructed from the input value. - // Refer to <@link language MaterialTag objects>. + // Refer to <@link objecttype MaterialTag>. // --> TagManager.registerTagHandler("material", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java index d0aa42f5bc..603c0bed3b 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java @@ -34,7 +34,7 @@ public NPCTagBase() { // @returns NPCTag // @description // Returns an npc object constructed from the input value. - // Refer to <@link language NPCTag objects>. + // Refer to <@link objecttype NPCTag>. // If no input value is specified, returns the linked NPC. // --> if (Depends.citizens != null) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java index 351e89680a..17636de007 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PlayerTagBase.java @@ -22,7 +22,7 @@ public PlayerTagBase() { // @returns PlayerTag // @description // Returns a player object constructed from the input value. - // Refer to <@link language PlayerTag objects>. + // Refer to <@link objecttype PlayerTag>. // If no input value is specified, returns the linked player. // --> Bukkit.getServer().getPluginManager().registerEvents(this, Denizen.getInstance()); diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PluginTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PluginTagBase.java index debb529aec..ddc0bc9b7a 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PluginTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PluginTagBase.java @@ -12,7 +12,7 @@ public PluginTagBase() { // @returns PluginTag // @description // Returns a plugin object constructed from the input value. - // Refer to <@link language PluginTag objects>. + // Refer to <@link objecttype PluginTag>. // --> TagManager.registerTagHandler("plugin", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PolygonTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PolygonTagBase.java index 2e20bd8b63..3c37704fc7 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/PolygonTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/PolygonTagBase.java @@ -12,7 +12,7 @@ public PolygonTagBase() { // @returns PolygonTag // @description // Returns a polygon object constructed from the input value. - // Refer to <@link language PolygonTag objects>. + // Refer to <@link objecttype PolygonTag>. // --> TagManager.registerTagHandler("polygon", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java index 8262244054..1e8f7e2137 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java @@ -616,7 +616,7 @@ else if (recipe instanceof CookingRecipe) { // @returns ListTag(BiomeTag) // @description // Returns a list of all biomes known to the server. - // Generally used with <@link language BiomeTag Objects>. + // Generally used with <@link objecttype BiomeTag>. // This is based on Bukkit Biome enum, as seen at <@link url https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html>. // --> if (attribute.startsWith("biome_types") || attribute.startsWith("list_biome_types")) { @@ -679,7 +679,7 @@ else if (recipe instanceof CookingRecipe) { // @returns ListTag // @description // Returns a list of all entity types known to the server. - // Generally used with <@link language EntityTag Objects>. + // Generally used with <@link objecttype EntityTag>. // This is only their Bukkit enum names, as seen at <@link url https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html>. // --> if (attribute.startsWith("entity_types") || attribute.startsWith("list_entity_types")) { @@ -696,7 +696,7 @@ else if (recipe instanceof CookingRecipe) { // @returns ListTag(MaterialTag) // @description // Returns a list of all materials known to the server. - // Generally used with <@link language MaterialTag Objects>. + // Generally used with <@link objecttype MaterialTag>. // This is only types listed in the Bukkit Material enum, as seen at <@link url https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html>. // --> if (attribute.startsWith("material_types") || attribute.startsWith("list_material_types")) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/TradeTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/TradeTagBase.java index a2d92041ed..d49d77f910 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/TradeTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/TradeTagBase.java @@ -12,7 +12,7 @@ public TradeTagBase() { // @returns TradeTag // @description // Returns a trade object constructed from the input value. - // Refer to <@link language TradeTag objects>. + // Refer to <@link objecttype TradeTag>. // --> TagManager.registerTagHandler("trade", (attribute) -> { if (!attribute.hasContext(1)) { diff --git a/plugin/src/main/java/com/denizenscript/denizen/tags/core/WorldTagBase.java b/plugin/src/main/java/com/denizenscript/denizen/tags/core/WorldTagBase.java index 2a3a5e3b55..1b73c1c6ff 100644 --- a/plugin/src/main/java/com/denizenscript/denizen/tags/core/WorldTagBase.java +++ b/plugin/src/main/java/com/denizenscript/denizen/tags/core/WorldTagBase.java @@ -12,7 +12,7 @@ public WorldTagBase() { // @returns WorldTag // @description // Returns a world object constructed from the input value. - // Refer to <@link language WorldTag objects>. + // Refer to <@link objecttype WorldTag>. // --> TagManager.registerTagHandler("world", (attribute) -> { if (!attribute.hasContext(1)) {