Package me.gamercoder215.starcosmetics.api.cosmetics.pet

Interface Pet

public interface Pet
Represents an active StarCosmetics Pet.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PET_TAG
    The Scoreboard Tag for a StarCosmetics Pet.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ArmorStand
    getEntity()
    Fetches the Pet's Bukkit Entity.
    default @NotNull PetInfo
    getInfo()
    Fetches the Pet's Information.
    @NotNull Player
    getOwner()
    Fetches the Pet's Owner.
    default @NotNull String
    getPetName()
    Fetches the Pet's Display Name based on getOwner().
    @NotNull PetType
    getPetType()
    Fetches this Pet's PetType.
    default @NotNull Rarity
    getRarity()
    Fetches the Pet's Rarity.

  • Field Details

  • Method Details

    • getEntity

      @NotNull @NotNull ArmorStand getEntity()
      Fetches the Pet's Bukkit Entity.
      Returns:
      Entity Type

    • getRarity

      @NotNull default @NotNull Rarity getRarity()
      Fetches the Pet's Rarity.
      Returns:
      Pet Rarity

    • getInfo

      @NotNull default @NotNull PetInfo getInfo()
      Fetches the Pet's Information.
      Returns:
      Pet Info

    • getOwner

      @NotNull @NotNull Player getOwner()
      Fetches the Pet's Owner.
      Returns:
      Pet Owner

    • getPetName

      @NotNull default @NotNull String getPetName()
      Fetches the Pet's Display Name based on getOwner().
      Returns:
      Pet Display Name with Owner

    • getPetType

      @NotNull @NotNull PetType getPetType()
      Fetches this Pet's PetType.
      Returns:
      Pet Type