Module io.github.miniplaceholders.api
Package io.github.miniplaceholders.api

Interface Expansion

public interface Expansion
Expansion that contains placeholders

Usage Example:

  Player player = event.getPlayer();
  Expansion.Builder builder = Expansion.builder("player")
      .audiencePlaceholder("name", (p, queue, ctx) -> Tag.selfClosingInserting(Component.text(((Player)p).getUsername()))
      .build();
  Expansion expansion = builder.build();
  // You can also call the register() method to register
  // the Expansion in the MiniPlaceholders global Extensions and
  // use it in MiniPlaceholders.getAudiencePlaceholders(Audience) e.g.
  TagResolver resolver = expansion.audiencePlaceholder(player);
  player.sendMessage(MiniMessage.miniMessage().deserialize("Hello <luckperms_prefix> <player_name>", resolver));
Since:
1.0.0

  • Method Details

    • name

      @NotNull @NotNull String name()
      Get the expansion name
      Returns:
      the expansion name
      Since:
      1.0.0

    • audiencePlaceholders

      @NotNull @NotNull TagResolver audiencePlaceholders(@NotNull @NotNull Audience audience)
      Get the TagResolver of the desired Audience
      Parameters:
      audience - the audience
      Returns:
      A TagResolver with variable placeholders of an Audience
      Since:
      1.0.0

    • relationalPlaceholders

      @NotNull @NotNull TagResolver relationalPlaceholders(@NotNull @NotNull Audience audience, @NotNull @NotNull Audience otherAudience)
      Get the relational placeholders based on two audiences

      The resulting TagResolver will give results according to the 2 Audience provided and when called at any time will retrieve the required values

      Parameters:
      audience - the main audience
      otherAudience - the secondary audience
      Returns:
      A TagResolver with variable placeholders between 2 Audiences
      Since:
      1.0.0

    • globalPlaceholders

      @NotNull @NotNull TagResolver globalPlaceholders()
      Get global placeholders
      Returns:
      the global placeholders
      Since:
      1.0.0

    • register

      void register()
      Register this expansion
      Throws:
      IllegalStateException - if the expansion you are trying to register is already registered
      Since:
      1.0.0
      See Also:

    • unregister

      void unregister()
      Unregisters this expansion
      Throws:
      IllegalStateException - if the expansion you are trying to unregister is not registered
      Since:
      2.1.0
      See Also:

    • registered

      boolean registered()
      Get the registration status of this expansion
      Returns:
      true if the expansion is registered, otherwise false
      Since:
      2.1.0

    • builder

      @NotNull static Expansion.Builder builder(@NotNull @NotNull String name)
      Creates a new Expansion Builder
      Parameters:
      name - the expansion name
      Returns:
      a new expansion builder
      Since:
      1.0.0