Add '/paper mobcaps' and '/paper playermobcaps'

Add commands to get the mobcaps for a world, as well as the mobcaps for
each player when per-player mob spawning is enabled.

Also has a hover text on each mob category listing what entity types are
in said category
This commit is contained in:
Jason Penilla
2021-08-16 01:31:54 -05:00
parent c593e8510e
commit b67ec825d2
6 changed files with 289 additions and 10 deletions

View File

@@ -40,6 +40,7 @@ public final class PaperCommand extends Command {
commands.put(Set.of("dumpplugins"), new DumpPluginsCommand());
commands.put(Set.of("syncloadinfo"), new SyncLoadInfoCommand());
commands.put(Set.of("dumpitem"), new DumpItemCommand());
commands.put(Set.of("mobcaps", "playermobcaps"), new MobcapsCommand());
return commands.entrySet().stream()
.flatMap(entry -> entry.getKey().stream().map(s -> Map.entry(s, entry.getValue())))

View File

@@ -0,0 +1,229 @@
package io.papermc.paper.command.subcommands;
import com.google.common.collect.ImmutableMap;
import io.papermc.paper.command.CommandUtil;
import io.papermc.paper.command.PaperSubcommand;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.ToIntFunction;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.ComponentLike;
import net.kyori.adventure.text.JoinConfiguration;
import net.kyori.adventure.text.TextComponent;
import net.kyori.adventure.text.format.NamedTextColor;
import net.kyori.adventure.text.format.TextColor;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.entity.MobCategory;
import net.minecraft.world.level.NaturalSpawner;
import org.bukkit.Bukkit;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.craftbukkit.CraftWorld;
import org.bukkit.craftbukkit.entity.CraftPlayer;
import org.bukkit.entity.Player;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.DefaultQualifier;
@DefaultQualifier(NonNull.class)
public final class MobcapsCommand implements PaperSubcommand {
static final Map<MobCategory, TextColor> MOB_CATEGORY_COLORS = ImmutableMap.<MobCategory, TextColor>builder()
.put(MobCategory.MONSTER, NamedTextColor.RED)
.put(MobCategory.CREATURE, NamedTextColor.GREEN)
.put(MobCategory.AMBIENT, NamedTextColor.GRAY)
.put(MobCategory.AXOLOTLS, TextColor.color(0x7324FF))
.put(MobCategory.UNDERGROUND_WATER_CREATURE, TextColor.color(0x3541E6))
.put(MobCategory.WATER_CREATURE, TextColor.color(0x006EFF))
.put(MobCategory.WATER_AMBIENT, TextColor.color(0x00B3FF))
.put(MobCategory.MISC, TextColor.color(0x636363))
.build();
@Override
public boolean execute(final CommandSender sender, final String subCommand, final String[] args) {
switch (subCommand) {
case "mobcaps" -> this.printMobcaps(sender, args);
case "playermobcaps" -> this.printPlayerMobcaps(sender, args);
}
return true;
}
@Override
public List<String> tabComplete(final CommandSender sender, final String subCommand, final String[] args) {
return switch (subCommand) {
case "mobcaps" -> CommandUtil.getListMatchingLast(sender, args, this.suggestMobcaps(args));
case "playermobcaps" -> CommandUtil.getListMatchingLast(sender, args, this.suggestPlayerMobcaps(sender, args));
default -> throw new IllegalArgumentException();
};
}
private List<String> suggestMobcaps(final String[] args) {
if (args.length == 1) {
final List<String> worlds = new ArrayList<>(Bukkit.getWorlds().stream().map(World::getName).toList());
worlds.add("*");
return worlds;
}
return Collections.emptyList();
}
private List<String> suggestPlayerMobcaps(final CommandSender sender, final String[] args) {
if (args.length == 1) {
final List<String> list = new ArrayList<>();
for (final Player player : Bukkit.getOnlinePlayers()) {
if (!(sender instanceof Player senderPlayer) || senderPlayer.canSee(player)) {
list.add(player.getName());
}
}
return list;
}
return Collections.emptyList();
}
private void printMobcaps(final CommandSender sender, final String[] args) {
final List<World> worlds;
if (args.length == 0) {
if (sender instanceof Player player) {
worlds = List.of(player.getWorld());
} else {
sender.sendMessage(Component.text("Must specify a world! ex: '/paper mobcaps world'", NamedTextColor.RED));
return;
}
} else if (args.length == 1) {
final String input = args[0];
if (input.equals("*")) {
worlds = Bukkit.getWorlds();
} else {
final @Nullable World world = Bukkit.getWorld(input);
if (world == null) {
sender.sendMessage(Component.text("'" + input + "' is not a valid world!", NamedTextColor.RED));
return;
} else {
worlds = List.of(world);
}
}
} else {
sender.sendMessage(Component.text("Too many arguments!", NamedTextColor.RED));
return;
}
for (final World world : worlds) {
final ServerLevel level = ((CraftWorld) world).getHandle();
final NaturalSpawner.@Nullable SpawnState state = level.getChunkSource().getLastSpawnState();
final int chunks;
if (state == null) {
chunks = 0;
} else {
chunks = state.getSpawnableChunkCount();
}
sender.sendMessage(Component.join(JoinConfiguration.noSeparators(),
Component.text("Mobcaps for world: "),
Component.text(world.getName(), NamedTextColor.AQUA),
Component.text(" (" + chunks + " spawnable chunks)")
));
sender.sendMessage(createMobcapsComponent(
category -> {
if (state == null) {
return 0;
} else {
return state.getMobCategoryCounts().getOrDefault(category, 0);
}
},
category -> NaturalSpawner.globalLimitForCategory(level, category, chunks)
));
}
}
private void printPlayerMobcaps(final CommandSender sender, final String[] args) {
final @Nullable Player player;
if (args.length == 0) {
if (sender instanceof Player pl) {
player = pl;
} else {
sender.sendMessage(Component.text("Must specify a player! ex: '/paper playermobcount playerName'", NamedTextColor.RED));
return;
}
} else if (args.length == 1) {
final String input = args[0];
player = Bukkit.getPlayerExact(input);
if (player == null) {
sender.sendMessage(Component.text("Could not find player named '" + input + "'", NamedTextColor.RED));
return;
}
} else {
sender.sendMessage(Component.text("Too many arguments!", NamedTextColor.RED));
return;
}
final ServerPlayer serverPlayer = ((CraftPlayer) player).getHandle();
final ServerLevel level = serverPlayer.serverLevel();
if (!level.paperConfig().entities.spawning.perPlayerMobSpawns) {
sender.sendMessage(Component.text("Use '/paper mobcaps' for worlds where per-player mob spawning is disabled.", NamedTextColor.RED));
return;
}
sender.sendMessage(Component.join(JoinConfiguration.noSeparators(), Component.text("Mobcaps for player: "), Component.text(player.getName(), NamedTextColor.GREEN)));
sender.sendMessage(createMobcapsComponent(
category -> level.chunkSource.chunkMap.getMobCountNear(serverPlayer, category),
category -> level.getWorld().getSpawnLimitUnsafe(org.bukkit.craftbukkit.util.CraftSpawnCategory.toBukkit(category))
));
}
private static Component createMobcapsComponent(final ToIntFunction<MobCategory> countGetter, final ToIntFunction<MobCategory> limitGetter) {
return MOB_CATEGORY_COLORS.entrySet().stream()
.map(entry -> {
final MobCategory category = entry.getKey();
final TextColor color = entry.getValue();
final Component categoryHover = Component.join(JoinConfiguration.noSeparators(),
Component.text("Entity types in category ", TextColor.color(0xE0E0E0)),
Component.text(category.getName(), color),
Component.text(':', NamedTextColor.GRAY),
Component.newline(),
Component.newline(),
BuiltInRegistries.ENTITY_TYPE.entrySet().stream()
.filter(it -> it.getValue().getCategory() == category)
.map(it -> Component.translatable(it.getValue().getDescriptionId()))
.collect(Component.toComponent(Component.text(", ", NamedTextColor.GRAY)))
);
final Component categoryComponent = Component.text()
.content(" " + category.getName())
.color(color)
.hoverEvent(categoryHover)
.build();
final TextComponent.Builder builder = Component.text()
.append(
categoryComponent,
Component.text(": ", NamedTextColor.GRAY)
);
final int limit = limitGetter.applyAsInt(category);
if (limit != -1) {
builder.append(
Component.text(countGetter.applyAsInt(category)),
Component.text("/", NamedTextColor.GRAY),
Component.text(limit)
);
} else {
builder.append(Component.text()
.append(
Component.text('n'),
Component.text("/", NamedTextColor.GRAY),
Component.text('a')
)
.hoverEvent(Component.text("This category does not naturally spawn.")));
}
return builder;
})
.map(ComponentLike::asComponent)
.collect(Component.toComponent(Component.newline()));
}
}