Vanish API 2.0

[gabizou]

SpongeAPI | Sponge

This introduces a new form of Vanish as an API. With 1.17+ adding more possible customization chances for Vanish, I felt it necessary to introduce a possible option for how vanish can be customized further out of the box. In hindsight, the added Keys just made for worse experience using the API, so I bring VanishState, which has some relatively simple methods by itself, and it is in itself immutable.

The intended use is simply:

// Vanish entirely
player.offer(Keys.VANISH_STATE, VanishState.vanished());

// Vanish with collisions
player.offer(Keys.VANISH_STATE, VanishState.vanished().ignoreCollisions(false));

// Vanish with targeting
player.offer(Keys.VANISH_STATE, VanishState.vanished().untargetable(false));

// Unvanish (visible)
player.offer(Keys.VANISH_STATE, VanishState.unvanished());

And pulling from the VanishTest test plugin:

@Plugin("vanish-test")
public class VanishTest {

    private final PluginContainer plugin;

    @Inject
    public VanishTest(PluginContainer plugin) {
        this.plugin = plugin;
    }

    @Listener
    public void onRegisterSpongeCommand(final RegisterCommandEvent<Command.Parameterized> event) {
        final Parameter.Value<Entity> entityKey = Parameter.entity()
            .key("entity")
            .usage(key -> "any entity")
            .optional()
            .build();
        final Flag collisionsFlag = Flag.builder()
            .setParameter(entityKey)
            .alias("c")
            .build();
        final Flag targetingFlag = Flag.builder()
            .setParameter(entityKey)
            .alias("t")
            .build();
        event.register(
            this.plugin,
            Command.builder()
                .addParameter(entityKey)
                .addFlag(collisionsFlag)
                .addFlag(targetingFlag)
                .executor(ctx -> {
                    ctx.all(entityKey).forEach(entity -> entity.offer(Keys.VANISH_STATE, VanishState.vanished()
                        .untargetable(ctx.hasFlag(targetingFlag))
                        .ignoreCollisions(ctx.hasFlag(collisionsFlag))));
                    ctx.sendMessage(Identity.nil(), Component.text("Vanished!", NamedTextColor.DARK_AQUA));
                    return CommandResult.success();
                })
                .build(),
            "vanish"
        );
        event.register(
            this.plugin,
            Command.builder()
                .addParameter(entityKey)
                .executor(ctx -> {
                    ctx.all(entityKey).forEach(entity -> entity.offer(Keys.VANISH_STATE, VanishState.unvanished()));
                    ctx.sendMessage(Identity.nil(), Component.text("Unvanished! Huzzah!", NamedTextColor.AQUA));
                    return CommandResult.success();
                })
                .build(),
            "unvanish"
        );
    }

}