diff --git a/plugin/src/main/java/net/aufdemrand/denizen/NPCCommandHandler.java b/plugin/src/main/java/net/aufdemrand/denizen/NPCCommandHandler.java index 62ff3201b1..da924416e3 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/NPCCommandHandler.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/NPCCommandHandler.java @@ -128,7 +128,7 @@ else if (args.length() > 2) { // @description // The /npc constants command configures a NPC's constants. Uses Denizen's ConstantTrait to keep track of // NPC-specific constants. This provides seamless integration with an assignment script's 'Default Constants' in - // which string variables can be stored and retrieved with the use of 'replaceable tags', or API. Constants set at + // which text variables can be stored and retrieved with the use of 'replaceable tags', or API. Constants set at // the NPC level override any constants from the NPC's assignment script. // // Constants may be used in several ways: Setting, Removing, and Viewing diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java index 5650cfe98c..79dd50e83f 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java @@ -355,7 +355,7 @@ public String run(Attribute attribute, dObject object) { // <--[tag] // @attribute - // @returns dList(Element) + // @returns dList // @description // Returns a list of the height of each block in the chunk. // --> diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java index 06c47bfec0..37844377e4 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java @@ -1841,7 +1841,7 @@ else if (mtr.angle == BlockFace.EAST) { // @returns Element(Boolean) // @group attributes // @description - // Returns if the entity is currently ablaze or not. + // Returns whether the entity is currently ablaze or not. // --> if (attribute.startsWith("on_fire")) { return new Element(entity.getFireTicks() > 0).getAttribute(attribute.fulfill(1)); @@ -2149,7 +2149,7 @@ else if (mtr.angle == BlockFace.EAST) { // @returns Element(Boolean) // @group attributes // @description - // Returns if the entity despawns when away from players. + // Returns whether the entity despawns when away from players. // --> if (attribute.startsWith("remove_when_far")) { return new Element(getLivingEntity().getRemoveWhenFarAway()) diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java index 12063c6001..aaf88f9dc2 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java @@ -1580,7 +1580,7 @@ else if (isOnline()) { // <--[tag] // @attribute - // @returns dList(Element(Number)) + // @returns dList // @description // Returns the current scores set on the player's Sidebar via the Sidebar command, // in the same order as <@link tag p@player.sidebar.lines>. diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/bukkit/BukkitElementProperties.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/bukkit/BukkitElementProperties.java index 5f0551f34e..e680599fa1 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/bukkit/BukkitElementProperties.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/bukkit/BukkitElementProperties.java @@ -310,9 +310,9 @@ public String getAttribute(Attribute attribute) { // <--[tag] // @attribute // @returns Element - // @group string checking + // @group text checking // @description - // Returns the ChatColors used at the end of a string. + // Returns the ChatColors used last in an element. // --> if (attribute.startsWith("last_color")) { return new Element(ChatColor.getLastColors(element.asString())).getAttribute(attribute.fulfill(1)); @@ -321,7 +321,7 @@ public String getAttribute(Attribute attribute) { // <--[tag] // @attribute ]> // @returns Element - // @group string manipulation + // @group text manipulation // @description // Returns the text re-formatted according to a format script. // See <@link example using format scripts>. @@ -344,7 +344,7 @@ public String getAttribute(Attribute attribute) { // <--[tag] // @attribute // @returns Element - // @group string manipulation + // @group text manipulation // @description // Returns the element with all color encoding stripped. // --> @@ -355,7 +355,7 @@ public String getAttribute(Attribute attribute) { // <--[tag] // @attribute ]> // @returns Element - // @group string manipulation + // @group text manipulation // @description // Returns the element with all color codes parsed. // Optionally, specify a character to prefix the color ids. Defaults to '&' if not specified. diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemAttributeNBT.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemAttributeNBT.java index 074d2bca85..2035a0983f 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemAttributeNBT.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemAttributeNBT.java @@ -50,8 +50,9 @@ public String getAttribute(Attribute attribute) { // @attribute // @returns Element(Boolean) // @group properties + // @mechanism dItem.nbt_attributes // @description - // Returns the NBT attribute string, if any. + // Returns the NBT attribute data (as matches the mechanism input), if any. // --> if (attribute.startsWith("nbt_attributes")) { String prop = getPropertyString(); diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemFirework.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemFirework.java index 5644498cb3..dbcc04114f 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemFirework.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemFirework.java @@ -82,7 +82,7 @@ public String getAttribute(Attribute attribute) { // @group properties // @mechanism dItem.firework // @description - // Returns the firework's property string as a list. + // Returns the firework's property value as a list, matching the format of the mechanism. // --> // TODO: Easy tags to get individual parts... if (attribute.startsWith("firework")) { diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemNBT.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemNBT.java index d3d2355cc3..d3656f8147 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemNBT.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/objects/properties/item/ItemNBT.java @@ -71,7 +71,7 @@ public String getAttribute(Attribute attribute) { // @returns Element // @group properties // @description - // Returns the value of this item's NBT key as a string Element as best it can. + // Returns the value of this item's NBT key as an Element as best it can. // --> if (attribute.matches("nbt")) { String res = CustomNBT.getCustomNBT(item.getItemStack(), attribute.getContext(1), CustomNBT.KEY_DENIZEN); diff --git a/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/BukkitCommandRegistry.java b/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/BukkitCommandRegistry.java index 9e0b096d3e..e356f6641d 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/BukkitCommandRegistry.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/BukkitCommandRegistry.java @@ -681,7 +681,7 @@ public void registerCoreMembers() { // @Description // Chat uses an NPCs DenizenSpeechController provided by Denizen, typically inside 'interact' or 'task' // script-containers. Typically there is already player and NPC context inside a queue that is using - // the 'chat' command. In this case, only a text string is required. Alternatively, target entities + // the 'chat' command. In this case, only a text input is required. Alternatively, target entities // can be specified to have any Entity chat to a different target/targets, or specify 'no_target' to // not send the message to any specific target. // @@ -1450,9 +1450,9 @@ public void registerCoreMembers() { // flicker option means the firework will explode with a flicker effect. // // @Tags - // returns the firework item which was used to launch the firework. - // returns if the item is a firework. - // Returns the firework's property string as a list. + // + // + // // // @Usage // Use to launch a star firework which explodes yellow and fades to white afterwards at the player's location @@ -2807,7 +2807,7 @@ public void registerCoreMembers() { // If a location is specified, it will play the sound for // all players if they are nearby that location specified. // - // Optionally, specify 'custom' to play a custom sound added by a resource pack, changing the sound string to something like 'random.click' + // Optionally, specify 'custom' to play a custom sound added by a resource pack, changing the sound name to something like 'random.click' // // For a list of all sounds, check https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html // diff --git a/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/world/SchematicCommand.java b/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/world/SchematicCommand.java index 02e9203851..36ed0a4866 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/world/SchematicCommand.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/scripts/commands/world/SchematicCommand.java @@ -301,7 +301,7 @@ public void schematicTags(ReplaceableTagEvent event) { // <--[tag] // @attribute - // @returns dList(Element) + // @returns dList // @description // Returns a list of all loaded schematics. // --> diff --git a/plugin/src/main/java/net/aufdemrand/denizen/tags/core/ServerTags.java b/plugin/src/main/java/net/aufdemrand/denizen/tags/core/ServerTags.java index fe0e2a159f..efb7c7a91e 100644 --- a/plugin/src/main/java/net/aufdemrand/denizen/tags/core/ServerTags.java +++ b/plugin/src/main/java/net/aufdemrand/denizen/tags/core/ServerTags.java @@ -264,7 +264,7 @@ public void serverTag(ReplaceableTagEvent event) { // <--[tag] // @attribute ]> - // @returns dList(Notable) + // @returns dList // @description // Lists all saved Notables currently on the server. // Optionally, specify a type to search for. @@ -375,7 +375,7 @@ public void serverTag(ReplaceableTagEvent event) { // <--[tag] // @attribute ]> - // @returns dList + // @returns dList(dScript) // @description // Returns a list of all world scripts that will handle a given event name. // This tag will ignore dObject identifiers (see <@link language dobject>). @@ -553,7 +553,7 @@ public void serverTag(ReplaceableTagEvent event) { // @attribute // @returns Element // @description - // Returns the version string of the server. + // Returns the version of the server. // --> if (attribute.startsWith("version")) { event.setReplaced(new Element(Bukkit.getServer().getVersion()) @@ -1118,7 +1118,7 @@ else if (attribute.startsWith("current_bossbars")) { // <--[tag] // @attribute - // @returns dList(Element(Decimal)) + // @returns dList // @description // Returns the 3 most recent ticks per second measurements. // --> @@ -1178,7 +1178,7 @@ public static void adjustServer(Mechanism mechanism) { // @name run_java // @input Element // @description - // Executes an arbitrary Java string. Warning: EXTREMELY DANGEROUS. + // Executes an arbitrary Java method (input as the text of Java code to run). Warning: EXTREMELY DANGEROUS. // Require config setting 'Commands.Java.Allow Running java'. // @tags // None