Package me.gamercoder215.starcosmetics.api.cosmetics

Interface CosmeticRegistry

public interface CosmeticRegistry
Represents the registry for all StarCosmetics Cosmetics.

  • Method Details

    • getAllFor

      @NotNull @NotNull List<CosmeticLocation<?>> getAllFor(@Nullable @Nullable Class<? extends Cosmetic> parentClass)
      Fetches a list of Locations for a specific Cosmetic.
      Parameters:
      parentClass - Parent Cosmetic Class
      Returns:
      List of Cosmetic Locations

    • getAllFor

      @NotNull default @NotNull List<CosmeticLocation<?>> getAllFor(@Nullable @Nullable Cosmetic parent)
      Fetches a list of Locations for a specific Cosmetic.
      Parameters:
      parent - Parent Cosmetic
      Returns:
      List of Cosmetic Locations

    • getAllCosmetics

      @NotNull default @NotNull List<CosmeticLocation<?>> getAllCosmetics()
      Fetches a list of all registered CosmeticLocations.
      Returns:
      List of Cosmetic Locations

    • getByFullKey

      @Nullable default @Nullable CosmeticLocation<?> getByFullKey(@Nullable @Nullable String key)
      Fetches a CosmeticLocation by its full key.
      Parameters:
      key - Full Key
      Returns:
      Cosmetic Location found, or null if not found

    • getAllParents

      @NotNull @NotNull List<Cosmetic> getAllParents()
      Fetches a list of all registered Cosmetic Parents.
      Returns:
      List of Registered Cosmetic Parents

    • getByNamespace

      @Nullable @Nullable Cosmetic getByNamespace(@NotNull @NotNull String key)
      Fetches a Cosmetic by its namespace.
      Parameters:
      key - Cosmetic Namespace
      Returns:
      Cosmetic Parent

    • getAvailableStructures

      @NotNull @NotNull Set<StructureInfo> getAvailableStructures()
      Fetches a set of all structures available for use.
      Returns:
      Set of Structures

    • addStructure

      default void addStructure(@NotNull @NotNull File file) throws IllegalArgumentException
      Adds a Structure to the registry.
      Parameters:
      file - Structure File
      Throws:
      IllegalArgumentException - If the file is not a valid Structure File

    • addStructure

      void addStructure(@NotNull @NotNull InputStream stream)
      Adds a Structure to the registry.
      Parameters:
      stream - Structure InputStream

    • getAllPets

      @NotNull @NotNull Map<PetType,PetInfo> getAllPets()
      Fetches a Map of all Pet Types to their information.
      Returns:
      Pet Information Map

    • getPetInfo

      @Nullable default @Nullable PetInfo getPetInfo(@Nullable @Nullable PetType type)
      Fetches a PetInfo by its PetType.
      Parameters:
      type - Pet Type
      Returns:
      Pet Information