ResidentTag object meta

DenizenScript · Jan 15, 2023 · 1b74899 · 1b74899
1 parent 64efd9f
commit 1b74899
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java
@@ -25,14 +25,20 @@ public class ResidenceTag implements ObjectTag {
     // @name ResidenceTag
     // @prefix residence
     // @base ElementTag
+    // @ExampleTagBase residence[myresidence]
+    // @ExampleValues myresidence
     // @format
-    // The identity format for residences is <residence_name>
+    // The identity format for residences is just the name.
     // For example, 'residence@myresidence'.
     //
     // @plugin Depenizen, Residence
     // @description
     // A ResidenceTag represents a Residence in the world.
     //
+    // @Matchable
+    // ResidenceTag matchers, sometimes identified as "<residence>":
+    // "residence" plaintext: always matches.
+    // Residence name: matches if the residence is named matches the input, using advanced matchers.
     // -->
 
     public static ResidenceTag valueOf(String string) {