com.pixelmonmod.pixelmon.api.pokemon.species.tags

Class FormTags

java.lang.Object

com.pixelmonmod.pixelmon.api.pokemon.species.tags.FormTags

public class FormTags
extends java.lang.Object

Represents a form having tags such as legendary, galar, ololan.

Constructor Summary

Constructors

Constructor and Description
FormTags(java.util.Set<java.lang.String> tags) Default constructor taking the tags

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRegionalTag() Gets the regional tag for this form if it exists
java.util.Set<java.lang.String>	getTags() Gets an unmodifiable set of the tags for the form
boolean	hasTag(java.lang.String tag) Checks if the pokemon has a given tag
boolean	hasTags(java.lang.String... tags) Checks if the pokemon has given tags LOGICAL OR
boolean	isAlolan() Checks if the form is alolan Short cut for this#hasTag(String) and Tags.ALOLAN
boolean	isGalarian() Checks if the form is galarian Short cut for this#hasTag(String) and Tags.GALARIAN
boolean	isHisuian() Checks if the form is hisuian Short cut for this#hasTag(String) and Tags.HISUIAN
boolean	isLegendary() Checks if the form is a legend Short cut for this#hasTag(String) and Tags.LEGENDARY
boolean	isLegendary(boolean excludeMythicals) Checks if the form is a legend Short cut for this#hasTag(String) and Tags.LEGENDARY
boolean	isMythical() Checks if the form is a mythical Short cut for this#hasTag(String) and Tags.MYTHICAL
boolean	isPaldean() Checks if the form is paldean Short cut for this#hasTag(String) and Tags.PALDEAN
boolean	isTemporary() Checks if the form is temporary Short cut for this#hasTag(String) and Tags.TEMPORARY
boolean	isUltraBeast() Checks if the form is an ultrabeast Short cut for this#hasTag(String) and Tags.ULTRA_BEAST

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormTags

public FormTags(java.util.Set<java.lang.String> tags)

Default constructor taking the tags

Parameters:

tags - The tags for the form

Method Detail

getTags

public java.util.Set<java.lang.String> getTags()

Gets an unmodifiable set of the tags for the form

Returns:

All tags associated with this form

getRegionalTag

public java.lang.String getRegionalTag()

Gets the regional tag for this form if it exists

Returns:

The regional tag for this form, or null if none exists

hasTag

public boolean hasTag(java.lang.String tag)

Checks if the pokemon has a given tag

Parameters:

tag - The tag being checked

Returns:

True if they have the tag

hasTags

public boolean hasTags(java.lang.String... tags)

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 this#hasTag(String) and Tags.LEGENDARY

Returns:

True if is a legend

isLegendary

public boolean isLegendary(boolean excludeMythicals)

Checks if the form is a legend Short cut for this#hasTag(String) and Tags.LEGENDARY

Returns:

True if is a legend

isMythical

public boolean isMythical()

Checks if the form is a mythical Short cut for this#hasTag(String) and Tags.MYTHICAL

Returns:

True if is a mythical

isUltraBeast

public boolean isUltraBeast()

Checks if the form is an ultrabeast Short cut for this#hasTag(String) and Tags.ULTRA_BEAST

Returns:

True if is an ultrabeast

isAlolan

public boolean isAlolan()

Checks if the form is alolan Short cut for this#hasTag(String) and Tags.ALOLAN

Returns:

True if is an alolan

isGalarian

public boolean isGalarian()

Checks if the form is galarian Short cut for this#hasTag(String) and Tags.GALARIAN

Returns:

True if is an galarian

isHisuian

public boolean isHisuian()

Checks if the form is hisuian Short cut for this#hasTag(String) and Tags.HISUIAN

Returns:

True if is a hisuian

isPaldean

public boolean isPaldean()

Checks if the form is paldean Short cut for this#hasTag(String) and Tags.PALDEAN

Returns:

True if is a paldean

isTemporary

public boolean isTemporary()

Checks if the form is temporary Short cut for this#hasTag(String) and Tags.TEMPORARY

Returns:

True if temporary