Module net.kyori.adventure.text.minimessage
Package net.kyori.adventure.text.minimessage.internal.serializer

Interface ClaimConsumer

public interface ClaimConsumer
A consumer of serialization claims.
Since:
4.10.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    component(Emitable componentClaim)
    Submit a component claim for the active component.
    boolean
    componentClaimed()
    Get whether a component has been claimed yet.
    void
    style(String claimKey, Emitable styleClaim)
    Submit a style claim for the active component.
    boolean
    styleClaimed(String claimId)
    Get whether a style element has been claimed yet.

  • Method Details

    • style

      void style(String claimKey, Emitable styleClaim)
      Submit a style claim for the active component.

      Style claims are additive, but any single style element can only be claimed once.

      Parameters:
      claimKey - an identifier for the style element being claimed
      styleClaim - the claim of a style
      Since:
      4.10.0

    • component

      boolean component(Emitable componentClaim)
      Submit a component claim for the active component.

      Only one component claim can be in effect. We use the first component claim.

      Parameters:
      componentClaim - the claim of a component
      Returns:
      whether the claim was successful
      Since:
      4.10.0

    • styleClaimed

      boolean styleClaimed(String claimId)
      Get whether a style element has been claimed yet.
      Parameters:
      claimId - the id for this style elemnt being tested
      Returns:
      whether style is claimed
      Since:
      4.10.0

    • componentClaimed

      boolean componentClaimed()
      Get whether a component has been claimed yet.
      Returns:
      whether a component has been claimed yet
      Since:
      4.10.0