com.pixelmonmod.pixelmon.api.pokemon.species.gender

Enum Gender

java.lang.Object

java.lang.Enum<Gender>

com.pixelmonmod.pixelmon.api.pokemon.species.gender.Gender

All Implemented Interfaces:

ITranslatable, java.io.Serializable, java.lang.Comparable<Gender>

public enum Gender
extends java.lang.Enum<Gender>
implements ITranslatable

Represents all supported Gender types

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE
MALE
NONE

Method Summary

Modifier and Type	Method and Description
static Gender	getGender(short ord) Gets a gender from its enum ordinal.
static Gender	getGender(java.lang.String name) Gets the gender associated with the given name, case insensitively, if it exists
static Gender	getRandomGender(Stats baseStats) Gets a random gender for a Pokémon.
java.lang.String	getTranslationKey()
boolean	hasPalette(Stats stats, java.lang.String palette) Checks if the gender of a given form has the palette
boolean	isCompatible(Gender otherGender) Checks if the gender is compatible with another gender for relationship purposes.
static Gender	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Gender[]	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

Methods inherited from interface com.pixelmonmod.pixelmon.api.util.ITranslatable

getLocalizedName, getTranslatedName

Enum Constant Detail

MALE

public static final Gender MALE

FEMALE

public static final Gender FEMALE

NONE

public static final Gender NONE

Method Detail

values

public static Gender[] 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 (Gender c : Gender.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Gender 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

hasPalette

public boolean hasPalette(Stats stats,
                          java.lang.String palette)

Checks if the gender of a given form has the palette

Parameters:

stats - The form

palette - The palette

Returns:

True if found

getTranslationKey

public java.lang.String getTranslationKey()

Specified by:

getTranslationKey in interface ITranslatable

isCompatible

public boolean isCompatible(Gender otherGender)

Checks if the gender is compatible with another gender for relationship purposes.

Parameters:

otherGender - The gender to check against this gender.

Returns:

Whether the gender is compatible with another gender for relationship purposes.

getGender

public static Gender getGender(short ord)

Gets a gender from its enum ordinal.

Parameters:

ord - The ordinal of the enum.

Returns:

The gender corresponding to the ordinal, or male if the ordinal is out of bounds.

getGender

public static Gender getGender(java.lang.String name)

Gets the gender associated with the given name, case insensitively, if it exists

Parameters:

name - - The case insensitive name of the gender

Returns:

- The associated Gender if one exists

getRandomGender

public static Gender getRandomGender(Stats baseStats)

Gets a random gender for a Pokémon.

Parameters:

baseStats - The base stats to get the gender ratio from.

Returns:

A random gender for a Pokémon.