Class FormTags
java.lang.Object
com.pixelmonmod.pixelmon.api.pokemon.species.tags.FormTags
Represents a form having tags such as legendary, galar, ololan.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the regional tag for this form if it existsgetTags()
Gets an unmodifiable set of the tags for the formboolean
Checks if the pokemon has a given tagboolean
Checks if the pokemon has given tags LOGICAL ORboolean
isAlolan()
Checks if the form is alolan Short cut for {@link this#hasTag(String)} andTags.ALOLAN
boolean
Checks if the form is galarian Short cut for {@link this#hasTag(String)} andTags.GALARIAN
boolean
Checks if the form is hisuian Short cut for {@link this#hasTag(String)} andTags.HISUIAN
boolean
Checks if the form is a legend Short cut for {@link this#hasTag(String)} andTags.LEGENDARY
boolean
isLegendary
(boolean excludeMythicals) Checks if the form is a legend Short cut for {@link this#hasTag(String)} andTags.LEGENDARY
boolean
Checks if the form is a mythical Short cut for {@link this#hasTag(String)} andTags.MYTHICAL
boolean
Checks if the form is paldean Short cut for {@link this#hasTag(String)} andTags.PALDEAN
boolean
Checks if the form is temporary Short cut for {@link this#hasTag(String)} andTags.TEMPORARY
boolean
Checks if the form is an ultrabeast Short cut for {@link this#hasTag(String)} andTags.ULTRA_BEAST
-
Constructor Details
-
FormTags
Default constructor taking the tags- Parameters:
tags
- The tags for the form
-
-
Method Details
-
getTags
Gets an unmodifiable set of the tags for the form- Returns:
- All tags associated with this form
-
getRegionalTag
Gets the regional tag for this form if it exists- Returns:
- The regional tag for this form, or null if none exists
-
hasTag
Checks if the pokemon has a given tag- Parameters:
tag
- The tag being checked- Returns:
- True if they have the tag
-
hasTags
Checks if the pokemon has given tags LOGICAL OR- Parameters:
tags
- The tags being checked- Returns:
- True if they have the tag
-
isLegendary
public boolean isLegendary()Checks if the form is a legend Short cut for {@link this#hasTag(String)} andTags.LEGENDARY
- Returns:
- True if is a legend
-
isLegendary
public boolean isLegendary(boolean excludeMythicals) Checks if the form is a legend Short cut for {@link this#hasTag(String)} andTags.LEGENDARY
- Returns:
- True if is a legend
-
isMythical
public boolean isMythical()Checks if the form is a mythical Short cut for {@link this#hasTag(String)} andTags.MYTHICAL
- Returns:
- True if is a mythical
-
isUltraBeast
public boolean isUltraBeast()Checks if the form is an ultrabeast Short cut for {@link this#hasTag(String)} andTags.ULTRA_BEAST
- Returns:
- True if is an ultrabeast
-
isAlolan
public boolean isAlolan()Checks if the form is alolan Short cut for {@link this#hasTag(String)} andTags.ALOLAN
- Returns:
- True if is an alolan
-
isGalarian
public boolean isGalarian()Checks if the form is galarian Short cut for {@link this#hasTag(String)} andTags.GALARIAN
- Returns:
- True if is an galarian
-
isHisuian
public boolean isHisuian()Checks if the form is hisuian Short cut for {@link this#hasTag(String)} andTags.HISUIAN
- Returns:
- True if is a hisuian
-
isPaldean
public boolean isPaldean()Checks if the form is paldean Short cut for {@link this#hasTag(String)} andTags.PALDEAN
- Returns:
- True if is a paldean
-
isTemporary
public boolean isTemporary()Checks if the form is temporary Short cut for {@link this#hasTag(String)} andTags.TEMPORARY
- Returns:
- True if temporary
-