Add Option for Automatic Exception on Empty EntitySelectorArgument Lists

[learliet]

Description

There should be an option available when utilizing the EntitySelectorArgument to trigger an exception automatically when the resulting list is empty. This behavior mirrors the default implementation where argument.entity.notfound.entity or argument.entity.notfound.player is respectively returned.

Expected code

val myCommand = CommandAPICommand("myCommand")
  .withArguments(EntitySelectorArgument.ManyPlayers("players", false)) // allowEmpty flag
  .executes(CommandExecutor { sender, args ->
      // automatically returns "argument.entity.notfound.player" if empty
      val players = args[0] as List<Player> 
      // [...]
  })

Extra details

No response

[Jorel Ali]

I like this idea, and it should be fairly trivial to implement. In our existing multiple entity selector code, we have this:

CommandAPI/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-nms/commandapi-bukkit-1.20/src/main/java/dev/jorel/commandapi/nms/NMS_1_20_R1.java

Lines 353 to 372 in 38a1a76

 case ENTITYSELECTOR_MANY_ENTITIES: 
 	try { 
 		List<org.bukkit.entity.Entity> result = new ArrayList<>(); 
 		for (Entity entity : argument.findEntities(cmdCtx.getSource())) { 
 			result.add(entity.getBukkitEntity()); 
 		} 
 		yield result; 
 	} catch (CommandSyntaxException e) { 
 		yield new ArrayList<org.bukkit.entity.Entity>(); 
 	} 
 case ENTITYSELECTOR_MANY_PLAYERS: 
 	try { 
 		List<Player> result = new ArrayList<>(); 
 		for (ServerPlayer player : argument.findPlayers(cmdCtx.getSource())) { 
 			result.add(player.getBukkitEntity()); 
 		} 
 		yield result; 
 	} catch (CommandSyntaxException e) { 
 		yield new ArrayList<Player>(); 
 	} 

In this implementation, we catch the exception when the list of entities would be empty and instead return an empty array. Adding a parameter to allow this exception to bubble up should be available as an option.

It would be nice to get this implemented for our next release given how simple this is to implement.

[Jorel Ali]

Implemented in version 9.4.0.