diff --git a/src/main/java/net/aufdemrand/denizen/scripts/commands/CommandRegistry.java b/src/main/java/net/aufdemrand/denizen/scripts/commands/CommandRegistry.java index f7c7cda2e1..e85be3cf81 100644 --- a/src/main/java/net/aufdemrand/denizen/scripts/commands/CommandRegistry.java +++ b/src/main/java/net/aufdemrand/denizen/scripts/commands/CommandRegistry.java @@ -303,7 +303,7 @@ public void registerCoreMembers() { // @Name cooldown // @Usage cooldown (duration:) (global) (script:) // @Required 1 - // @Stable 1.0 + // @Stable Stable // @Short Temporarily disables a script-container from meeting requirements. // @Author aufdemrand // @@ -743,8 +743,8 @@ public void registerCoreMembers() { // <--[command] // @Name foreach // @Usage foreach [|...] [] - // @Required 1 - // @Stable Maybe + // @Required 2 + // @Stable Experimental // @Short Loops through a dList, running a set of commands for each item. // @Author Morphan1/mcmonkey // @@ -762,7 +762,7 @@ public void registerCoreMembers() { // // --> registerCoreMember(ForEachCommand.class, - "FOREACH", "foreach [|...] []", 1); + "FOREACH", "foreach [|...] []", 2); // <--[command] // @Name give diff --git a/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementRegistry.java b/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementRegistry.java index 20f4880a03..60a7ba9bf3 100644 --- a/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementRegistry.java +++ b/src/main/java/net/aufdemrand/denizen/scripts/requirements/RequirementRegistry.java @@ -57,63 +57,411 @@ public boolean register(String requirementName, RegistrationableInstance require @Override public void registerCoreMembers() { + + // <--[requirement] + // @Name Enchanted + // @Usage enchanted [iteminhand] + // @Required 1 + // @Stable Stable + // @Short Checks if an item has an enchantment or not. + // + // @Description + // Checks if the specified item has an enchantment. Currently, the only + // item available for this is the "iteminhand". + // + // @Usage + // Use to check if the item in the player's hand has an enchantment. + // - enchantment iteminhand + // + // @Example + // TODO + // + // --> registerCoreMember(EnchantedRequirement.class, - "ENCHANTED", "enchanted (iteminhand)", 1); + "ENCHANTED", "enchanted [iteminhand]", 1); + // <--[requirement] + // @Name Flagged + // @Usage (-)flagged ({player}/npc/global) [([<#>])](:) + // @Required 1 + // @Stable Stable + // @Short Checks if the specified flag exists. + // + // @Description + // Checks if the specified flag exists on the specified owner, which is "player" + // by default. + // + // @Usage + // Check if a flag exists. + // - flagged FlagName + // + // @Usage + // Check if a flag has a specified value. + // - flagged FlagName:Value + // + // @Usage + // Check if a flag does not exist. + // - -flagged FlagName + // + // @Example + // TODO + // + // --> registerCoreMember(FlaggedRequirement.class, - "FLAGGED", "(-)flagged [player/npc/global] [([<#>])](:)", 0); + "FLAGGED", "(-)flagged ({player}/npc/global) [([<#>])](:)", 2); + // <--[requirement] + // @Name Holding + // @Usage holding [] (qty:<#>) (exact) + // @Required 1 + // @Stable Stable + // @Short Checks if the player is holding an item. + // + // @Description + // Checks if the player is holding a specified item. The item can be a dItem (i@itemName) + // or it can be a normal material name or ID (wood, 5, 5:1). If a quantity is given, it + // checks if the ItemStack in the player's hand hand has at least that many items. If + // "exact" is specified, it must be the exact quantity of items. + // + // @Usage + // Check if the player is holding at least 3 pieces of wood. + // - holding wood qty:3 + // + // @Example + // TODO + // + // --> registerCoreMember(HoldingRequirement.class, - "HOLDING", "holding [] [qty:<#>] [exact]", 1); + "HOLDING", "holding [] (qty:<#>) (exact)", 1); + // <--[requirement] + // @Name InGroup + // @Usage ingroup (global) [] + // @Required 1 + // @Stable Stable + // @Short Checks if the player is in a group. + // + // @Description + // Checks if the player is in the specified group in the current world, or global group if specified. + // + // @Usage + // Check if the player is in a group. + // - ingroup Builder + // + // @Usage + // Check if the player is in a global group. + // - ingroup global Admin + // + // @Example + // TODO + // + // --> registerCoreMember(InGroupRequirement.class, "INGROUP", "ingroup (global) []", 1); + // <--[requirement] + // @Name Item + // @Usage item [] (qty:<#>) + // @Required 1 + // @Stable Stable + // @Short Checks if the player has an item. + // + // @Description + // Checks if the player has the specified item and the quantity of that item in their inventory. + // + // @Usage + // Check if the player has an item. + // - item wood qty:3 + // + // @Example + // TODO + // + // --> registerCoreMember(ItemRequirement.class, "ITEM", "item [] (qty:<#>)", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(LiquidRequirement.class, "ISLIQUID", "isliquid [location:]", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example + // + // --> registerCoreMember(MoneyRequirement.class, "MONEY", "money [qty:<#>]", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(OpRequirement.class, "OP", "op", 0); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(OwnerRequirement.class, "OWNER", "owner", 0); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(PermissionRequirement.class, "PERMISSION", "permission (global) []", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(PoweredRequirement.class, "ISPOWERED", "ispowered [location:]", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(OxygenRequirement.class, "OXYGEN", "oxygen (range:below/equals/above) [qty:<#>]", 1); + // <--[requirement] + // @Name TODO + // @Usage TODO + // @Required TODO + // @Stable TODO + // @Short TODO + // + // @Description TODO + // + // + // @Usage TODO + // + // + // @Example TODO + // + // --> registerCoreMember(ProcedureRequirement.class, "PROCEDURE", "procedure [