More docs, better perm managing

Author: samolego

common/src/main/java/org/samo_lego/taterzens/api/professions/DefaultProfession.java

@@ -82,12 +82,12 @@ public TaterzenProfession create(TaterzenNPC taterzen) {
      * You can create a local inventory in the profession and save it there.
      * Taterzen needs to have {@link TaterzenNPC#canPickUpLoot()} enabled.
      *
-     * @param stack stack to be picked up
+     * @param groundStack stack to be picked up
      *
      * @return true if item should be picked up, otherwise false.
      */
     @Override
-    public boolean tryPickupItem(ItemStack stack) {
+    public boolean tryPickupItem(ItemStack groundStack) {
         return false;
     }
 }

common/src/main/java/org/samo_lego/taterzens/api/professions/TaterzenProfession.java

@@ -77,8 +77,8 @@ default ActionResult interactAt(PlayerEntity player, Vec3d pos, Hand hand) {
      * You can create a local inventory in the profession and save it there.
      * Taterzen needs to have {@link TaterzenNPC#canPickUpLoot()} enabled.
      *
-     * @param stack stack to be picked up
+     * @param groundStack stack to be picked up
      * @return true if item should be picked up, otherwise false.
      */
-    boolean tryPickupItem(ItemStack stack);
+    boolean tryPickupItem(ItemStack groundStack);
 }

common/src/main/java/org/samo_lego/taterzens/commands/NpcCommand.java

@@ -60,7 +60,7 @@ public class NpcCommand {
 
     public static void register(CommandDispatcher<ServerCommandSource> dispatcher, boolean dedicated) {
         dispatcher.register(literal("npc")
-                .requires(serverCommandSource -> serverCommandSource.hasPermissionLevel(4) || LUCKPERMS_ENABLED)
+                .requires(serverCommandSource -> serverCommandSource.hasPermissionLevel(config.perms.npcCommandPermissionLevel) || LUCKPERMS_ENABLED)
                 .then(literal("create")
                         .then(argument("name", message())
                                 .suggests((context, builder) -> CommandSource.suggestMatching(getOnlinePlayers(context), builder))
@@ -354,20 +354,25 @@ private static int listTaterzenCommands(CommandContext<ServerCommandSource> cont
     }
 
     private static int setPermissionLevel(CommandContext<ServerCommandSource> context) throws CommandSyntaxException {
-        if(LUCKPERMS_ENABLED && !permissions$checkPermission(context.getSource(), PERMISSIONS.npc_edit_commands_setPermissionLevel)) {
-            context.getSource().sendError(new TranslatableText("commands.help.failed").formatted(Formatting.RED));
+        ServerCommandSource source = context.getSource();
+        if(LUCKPERMS_ENABLED && !permissions$checkPermission(source, PERMISSIONS.npc_edit_commands_setPermissionLevel)) {
+            source.sendError(new TranslatableText("commands.help.failed").formatted(Formatting.RED));
             return -1;
         }
 
-        ServerPlayerEntity player = context.getSource().getPlayer();
+        ServerPlayerEntity player = source.getPlayer();
         TaterzenNPC taterzen = ((TaterzenEditor) player).getNpc();
         if(taterzen != null) {
             int newPermLevel = IntegerArgumentType.getInteger(context, "level");
-            player.sendMessage(successText(lang.success.updatedPermissionLevel, new LiteralText(String.valueOf(newPermLevel))), false);
+            if(!config.perms.allowSettingHigherPermissionLevel && !source.hasPermissionLevel(newPermLevel)) {
+                source.sendError(errorText(lang.error.cannotSetPermissionLevel, new LiteralText(String.valueOf(newPermLevel))));
+                return -1;
+            }
+            source.sendFeedback(successText(lang.success.updatedPermissionLevel, new LiteralText(String.valueOf(newPermLevel))), false);
             taterzen.setPermissionLevel(newPermLevel);
 
         } else
-            context.getSource().sendError(noSelectedTaterzenError());
+            source.sendError(noSelectedTaterzenError());
 
         return 0;
     }

common/src/main/java/org/samo_lego/taterzens/commands/TaterzensCommand.java

@@ -21,7 +21,7 @@
 public class TaterzensCommand {
     public static void register(CommandDispatcher<ServerCommandSource> dispatcher, boolean dedicated) {
         dispatcher.register(literal("taterzens")
-                .requires(serverCommandSource -> serverCommandSource.hasPermissionLevel(4))
+                .requires(serverCommandSource -> serverCommandSource.hasPermissionLevel(config.perms.taterzensCommandPermissionLevel))
                 .then(literal("config")
                         .then(literal("reload")
                                 .executes(TaterzensCommand::reloadConfig)

common/src/main/java/org/samo_lego/taterzens/mixin/ServerPlayInteractionManagerMixin.java

@@ -26,16 +26,15 @@ public class ServerPlayInteractionManagerMixin {
      *
      * @param blockPos position of the broken block
      * @param playerAction action the player is trying to do
-     * @param direction
-     * @param i
-     * @param ci
+     * @param direction direction
+     * @param worldHeight world height
      */
     @Inject(
             method = "processBlockBreakingAction(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/network/packet/c2s/play/PlayerActionC2SPacket$Action;Lnet/minecraft/util/math/Direction;I)V",
             at = @At("HEAD"),
             cancellable = true
     )
-    private void onAttackBlock(BlockPos blockPos, PlayerActionC2SPacket.Action playerAction, Direction direction, int i, CallbackInfo ci) {
+    private void onAttackBlock(BlockPos blockPos, PlayerActionC2SPacket.Action playerAction, Direction direction, int worldHeight, CallbackInfo ci) {
         if (playerAction == PlayerActionC2SPacket.Action.START_DESTROY_BLOCK) {
             TaterzenEditor player = (TaterzenEditor) this.player;
             if(player.getNpc() != null && player.inPathEditMode()) {

common/src/main/java/org/samo_lego/taterzens/mixin/ServerPlayNetworkHandlerMixin_MsgEditor.java

@@ -28,8 +28,7 @@ public class ServerPlayNetworkHandlerMixin_MsgEditor {
      * message edit mode, messages sent to chat
      * will be saved to taterzen instead.
      *
-     * @param msg
-     * @param ci
+     * @param msg message sent by player
      */
     @Inject(
             method = "method_31286(Ljava/lang/String;)V",
@@ -56,7 +55,7 @@ private void onMessage(String msg, CallbackInfo ci) {
                 }
             } else {
                 Text text;
-                if(msg.startsWith("{") && msg.endsWith("}")) {
+                if((msg.startsWith("{") && msg.endsWith("}") || (msg.startsWith("[") && msg.endsWith("]")))) {
                     // NBT tellraw message structure, try parse it
                     try {
                         text = Text.Serializer.fromJson(new StringReader(msg));

common/src/main/java/org/samo_lego/taterzens/mixin/ThreadedAnvilChunkStorageMixin_TaterzenList.java

@@ -16,7 +16,6 @@ public class ThreadedAnvilChunkStorageMixin_TaterzenList {
     /**
      * Sets Taterzen to {@link org.samo_lego.taterzens.Taterzens#TATERZEN_NPCS NPC list}.
      * @param entity entity being loaded
-     * @param ci
      */
     @Inject(method = "loadEntity(Lnet/minecraft/entity/Entity;)V", at = @At("TAIL"))
     private void onEntityLoad(Entity entity, CallbackInfo ci) {
@@ -27,7 +26,6 @@ private void onEntityLoad(Entity entity, CallbackInfo ci) {
     /**
      * Unloads Taterzen from {@link org.samo_lego.taterzens.Taterzens#TATERZEN_NPCS NPC list}.
      * @param entity entity being unloaded
-     * @param ci
      */
     @Inject(method = "unloadEntity(Lnet/minecraft/entity/Entity;)V", at = @At("TAIL"))
     private void onEntityUnload(Entity entity, CallbackInfo ci) {

common/src/main/java/org/samo_lego/taterzens/npc/NPCData.java

@@ -4,29 +4,65 @@
 import net.minecraft.entity.player.PlayerEntity;
 import net.minecraft.text.Text;
 import net.minecraft.util.math.BlockPos;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 
 import static org.samo_lego.taterzens.Taterzens.config;
 
 /**
  * Deafult NPC data.
+ * Used for taterzen attributes.
  */
 public class NPCData {
     /**
-     * Used for taterzen attributes.
+     * Whether Taterzen should be able to be put on a lead..
      */
-    public boolean hostile = false;
     public boolean leashable = config.defaults.leashable;
+    /**
+     * Current equipment editor for Taterzen.
+     */
+    @Nullable
     public PlayerEntity equipmentEditor = null;
+    /**
+     * Default Taterzen movement.
+     */
     public Movement movement = Movement.NONE;
+    /**
+     * Path nodes, used when movement
+     * is set to {@link NPCData.Movement#FORCED_PATH}
+     * or {@link NPCData.Movement#PATH}.
+     */
     public ArrayList<BlockPos> pathTargets = new ArrayList<>();
+    /**
+     * Current index position
+     * in {@link NPCData#pathTargets}.
+     */
     public int currentMoveTarget = 0;
+    /**
+     * Whether Taterzen should be pushable.
+     */
     public boolean pushable = config.defaults.pushable;
+    /**
+     * Messages of Taterzen.
+     * Saved as &lt;Message Text, Delay&gt;
+     */
     public ArrayList<Pair<Text, Integer>> messages = new ArrayList<>();
+    /**
+     * Permission level of Taterzen.
+     */
     public int permissionLevel = config.defaults.commandPermissionLevel;
+    /**
+     * Commands to be executed on right click.
+     */
     public ArrayList<String> commands = new ArrayList<>();
+    /**
+     * Default behaviour of Taterzen.
+     */
     public Behaviour behaviour = Behaviour.PASSIVE;
+    /**
+     * Whether to allow dropping equipment on death.
+     */
     public boolean allowEquipmentDrops = false;
 
     /**
@@ -61,6 +97,9 @@ public enum Movement {
         FREE
     }
 
+    /**
+     * Behaviour types.
+     */
     public enum Behaviour {
         /**
          * Doesn't attack. What's a weapon?

common/src/main/java/org/samo_lego/taterzens/storage/TaterConfig.java

@@ -25,12 +25,24 @@ public class TaterConfig {
      */
     public String language = "en_us";
 
-    public final String _comment_disableRegistrySync = "// Whether to disable Fabric's registry sync. Leave this to true if you'd like to keep the mod server-sided.";
+    public final String _comment_disableRegistrySync1 = "// Whether to remove Taterzens from Fabric's registry sync. Safe to be true.";
+    public final String _comment_disableRegistrySync2 = "// If using Forge, this will remove WHOLE registry sync. Proceed with caution.";
+    /**
+     * Whether to disable Fabric's / Forge's registry sync.
+     * This marks mod as serverside.
+     *
+     * If using Fabric, Taterzen NPC type is just removed from sync packet.
+     * If using Forge, the whole thing is not synced. Use carefully!
+     */
     @SerializedName("disable_registry_sync")
     public boolean disableRegistrySync = true;
 
     public final String _comment_taterzenTablistTimeout1 = "// After how many ticks Taterzens should be cleared from tablist.";
     public final String _comment_taterzenTablistTimeout2 = "// Some delay is needed, otherwise clients don't fetch their skins.";
+    /**
+     * After how many ticks Taterzens should be cleared from tablist.
+     * Some delay is needed, otherwise clients don't fetch their skins.
+     */
     @SerializedName("taterzen_tablist_timeout")
     public int taterzenTablistTimeout = 30;
 
@@ -48,43 +60,116 @@ public class TaterConfig {
     public Defaults defaults = new Defaults();
     public Path path = new Path();
     public Messages messages = new Messages();
+    public Permissions perms = new Permissions();
+
+    /**
+     * Some permission stuff.
+     * If you are looking for permission nodes,
+     * see the generated permission.json file.
+     *
+     * (You must have LuckPerms installed.)
+     */
+    public static class Permissions {
+        public final String _comment_npcCommandPermissionLevel1 = "// Permission level required to execute /npc command.";
+        public final String _comment_npcCommandPermissionLevel2 = "// Valid only if LuckPerms isn't present.";
+        /**
+         * Permission level required to execute /npc command.
+         * Valid only if LuckPerms isn't present.
+         */
+        @SerializedName("npc_command_permission_level")
+        public int npcCommandPermissionLevel = 2;
+
+
+        public final String _comment_taterzensCommandPermissionLevel1 = "// Permission level required to execute /taterzens command.";
+        public final String _comment_taterzensCommandPermissionLevel2 = "// Valid only if LuckPerms isn't present.";
+        /**
+         * Permission level required to execute /taterzens command.
+         * Valid only if LuckPerms isn't present.
+         */
+        @SerializedName("npc_command_permission_level")
+        public int taterzensCommandPermissionLevel = 4;
+
+        public final String _comment_allowSettingHigherPermissionLevel1 = "// Whether to allow players to set the permission level";
+        public final String _comment_allowSettingHigherPermissionLevel2 = "// of Taterzen higher than their own. Careful! This could";
+        public final String _comment_allowSettingHigherPermissionLevel3 = "// enable players to bypass their permission level with NPC.";
+        @SerializedName("allow_setting_higher_perm_level")
+        public boolean allowSettingHigherPermissionLevel = false;
+    }
 
     /**
      * Default {@link org.samo_lego.taterzens.npc.TaterzenNPC} settings.
      */
     public static class Defaults {
         public final String _comment_name = "// Default settings for new Taterzens.";
+        /**
+         * Default Taterzen name
+         */
         public String name = "Taterzen";
+        /**
+         * Whether Taterzens should be leashable.
+         */
         public boolean leashable = false;
         public boolean pushable = false;
 
-        public final String _comment_commandPermissionLevel = "// Default command permission level of Taterzen";
+        public final String _comment_commandPermissionLevel = "// Default command permission level of Taterzen.";
+        /**
+         * Default command permission level of Taterzen.
+         */
         @SerializedName("command_permission_level")
         public int commandPermissionLevel = 4;
 
         public final String _comment_sounds = "// Default sounds for Taterzens. Set to null to mute them.";
+        /**
+         * Default Taterzen death sound.
+         * Can be null to not produce any sounds.
+         */
         @SerializedName("death_sound")
         public String deathSound = "entity.player.death";
+        /**
+         * Default Taterzen hurt / hit sound.
+         * Can be null to not produce any sounds.
+         */
         @SerializedName("hurt_sound")
         public String hurtSound = "entity.player.hurt";
+        /**
+         * Default Taterzen ambient sound.
+         * Can be null to not produce any sounds.
+         */
         @SerializedName("ambient_sound")
         public String ambientSound = "entity.player.breath";
+        /**
+         * Whether Taterzen is invulnerable by default.
+         */
         public boolean invulnerable = true;
     }
 
+    /**
+     * Settings for Taterzen's messages
+     */
     public static class Messages {
         public final String _comment_messageDelay = "// Default delay between each message, in ticks.";
+        /**
+         * Default delay between each message, in ticks.
+         */
+        @SerializedName("message_delay")
         public int messageDelay = 100;
         public final String _comment_exitEditorAfterMsgEdit = "// Whether to exit message editor mode after editing a message.";
+        /**
+         * Whether to exit message editor mode after editing a message.
+         */
         @SerializedName("exit_editor_after_msg_edit")
         public boolean exitEditorAfterMsgEdit = true;
     }
 
 
+    /**
+     * Settings for path visualisation.
+     */
     public static class Path {
         public Path.Color color = new Path.Color();
         /**
          * Color of particles used in path editor.
+         * Accepts RGB values (0 - 255).
          */
         public static class Color {
             public final String _comment = "// Which color of particles to use in path editor. Use RGB values ( 0 - 255 ).";

common/src/main/java/org/samo_lego/taterzens/storage/TaterLang.java

@@ -81,6 +81,7 @@ public static class Error {
         public String noCommandFound = "No commands with id %s were found.";
         public String disguiseLibRequired = "DisguiseLib mod is required for this action.";
         public String noProfessionFound = "No professions with id %s were found.";
+        public String cannotSetPermissionLevel = "Permission level %s is higher than your permission level.";
     }