Package net.kyori.adventure.resource

Enum ResourcePackStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ResourcePackStatus>
    public enum ResourcePackStatus
extends java.lang.Enum<ResourcePackStatus>
    Resource pack application state.

    Each status is a phase in the status state machine. The client provides this information back to servers as it attempts to download and apply resource packs.

    Initial states are ACCEPTED, DECLINED, or INVALID_URL.

    Since:
    4.15.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCEPTED
      Indicates that the user has accepted download.
      DECLINED
      Indicates that the user has declined a pack.
      DISCARDED
      Indicates that this resource pack did not have issues, but was not applied due to a failure in another server resource pack.
      DOWNLOADED
      Indicates that the resource pack has been successfully downloaded.
      FAILED_DOWNLOAD
      Indicates that the download failed for some other reason.
      FAILED_RELOAD
      Indicates that the client's resource manager reload failed.
      INVALID_URL
      Indicates that the provided pack URL could not be parsed.
      SUCCESSFULLY_LOADED
      Indicates that the pack has successfully loaded and resource reloading is complete.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean intermediate()
      Whether, after receiving this status, further status events might occur.
      static ResourcePackStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ResourcePackStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DECLINED

        public static final ResourcePackStatus DECLINED
        Indicates that the user has declined a pack.

        Terminal state.

        Since:
        4.15.0

      • INVALID_URL

        public static final ResourcePackStatus INVALID_URL
        Indicates that the provided pack URL could not be parsed.

        Terminal state.

        Since:
        4.15.0
        Since Minecraft:
        1.20.3

      • FAILED_DOWNLOAD

        public static final ResourcePackStatus FAILED_DOWNLOAD
        Indicates that the download failed for some other reason.

        Terminal state.

        Since:
        4.15.0

      • FAILED_RELOAD

        public static final ResourcePackStatus FAILED_RELOAD
        Indicates that the client's resource manager reload failed.

        Terminal state.

        Since:
        4.15.0
        Since Minecraft:
        1.20.3

      • DISCARDED

        public static final ResourcePackStatus DISCARDED
        Indicates that this resource pack did not have issues, but was not applied due to a failure in another server resource pack.

        Terminal state.

        Since:
        4.15.0
        Since Minecraft:
        1.20.3

      • SUCCESSFULLY_LOADED

        public static final ResourcePackStatus SUCCESSFULLY_LOADED
        Indicates that the pack has successfully loaded and resource reloading is complete.

        Terminal state.

        Since:
        4.15.0

    • Method Detail

      • values

        public static ResourcePackStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ResourcePackStatus c : ResourcePackStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ResourcePackStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • intermediate

        public boolean intermediate()
        Whether, after receiving this status, further status events might occur.
        Returns:
        the intermediate status
        Since:
        4.15.0