Package com.pixelmonmod.api.pokemon.requirement.impl

Class RandomSpeciesRequirement

java.lang.Object

com.pixelmonmod.api.pokemon.requirement.impl.RandomSpeciesRequirement

All Implemented Interfaces:

Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

public class RandomSpeciesRequirement
extends Object
implements Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Field Summary

Fields

Modifier and Type	Field	Description
protected PokemonSpecification	spec

Constructor Summary

Constructors

Constructor	Description
RandomSpeciesRequirement()
RandomSpeciesRequirement(PokemonSpecification spec)

Method Summary

Modifier and Type	Method	Description
void	applyData(Pokemon pokemon)	Applies the parsed requirement to the data
void	applyMinecraft(PixelmonEntity pixelmonEntity)	Applis the parsed requirement to the minecraft data
ParseAttempt<List<Requirement<Pokemon,PixelmonEntity,?>>>	create(String spec)	Creates a list of requirements from the spec being parsed
ParseAttempt<Requirement<Pokemon,PixelmonEntity,PokemonSpecification>>	createInstance(PokemonSpecification value)	Creates a new instance of the requirement with the given value
boolean	fits(String spec)	Checks if the given fits for this requirement
List<String>	getAliases()	The aliases of the requirement that it can match against
int	getPriority()	Gets the order priority of the requirement.
PokemonSpecification	getValue()	Gets the internal value of the requirement
boolean	isDataMatch(Pokemon pixelmon)	If the data type matches the parsed requirement
boolean	isMinecraftMatch(PixelmonEntity entity)	If the minecraft type matches the parsed requirement
boolean	shouldContinue()	If the spec should continue processing the results after applying this requirement.

Methods inherited from class java.lang.Object

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

Field Details

spec

protected PokemonSpecification spec

Constructor Details

RandomSpeciesRequirement

public RandomSpeciesRequirement()

RandomSpeciesRequirement

public RandomSpeciesRequirement(PokemonSpecification spec)

Method Details

createInstance

public ParseAttempt<Requirement<Pokemon,PixelmonEntity,PokemonSpecification>> createInstance(PokemonSpecification value)

Description copied from interface: Requirement

Creates a new instance of the requirement with the given value

Specified by:

createInstance in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

value - The value

Returns:

The new requirement instance

getPriority

public int getPriority()

Description copied from interface: Requirement

Gets the order priority of the requirement. Higher number = higher priority (i.e. it is applied first)

Specified by:

getPriority in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Returns:

The priority

shouldContinue

public boolean shouldContinue()

Description copied from interface: Requirement

If the spec should continue processing the results after applying this requirement.
For example, for a logical AND this would return false as it handles the processing of the remaining requirements

Specified by:

shouldContinue in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Returns:

True if it should continue processing

getAliases

public List<String> getAliases()

Description copied from interface: Requirement

The aliases of the requirement that it can match against

Specified by:

getAliases in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Returns:

The aliases

fits

public boolean fits(String spec)

Description copied from interface: Requirement

Checks if the given fits for this requirement

Specified by:

fits in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

spec - The parsed spec

Returns:

True if this requirement is found in the parameter

create

public ParseAttempt<List<Requirement<Pokemon,PixelmonEntity,?>>> create(String spec)

Description copied from interface: Requirement

Creates a list of requirements from the spec being parsed

Specified by:

create in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

spec - The spec being parsed

Returns:

The new list of requirements

isMinecraftMatch

public boolean isMinecraftMatch(PixelmonEntity entity)

Description copied from interface: Requirement

If the minecraft type matches the parsed requirement

Specified by:

isMinecraftMatch in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

entity - The minecraft data to check against

Returns:

True if a match

isDataMatch

public boolean isDataMatch(Pokemon pixelmon)

Description copied from interface: Requirement

If the data type matches the parsed requirement

Specified by:

isDataMatch in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

pixelmon - The data to check against

Returns:

True if a match

applyMinecraft

public void applyMinecraft(PixelmonEntity pixelmonEntity)

Description copied from interface: Requirement

Applis the parsed requirement to the minecraft data

Specified by:

applyMinecraft in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

pixelmonEntity - The minecraft data

getValue

public PokemonSpecification getValue()

Description copied from interface: Requirement

Gets the internal value of the requirement

Specified by:

getValue in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Returns:

The value stored

applyData

public void applyData(Pokemon pokemon)

Description copied from interface: Requirement

Applies the parsed requirement to the data

Specified by:

applyData in interface Requirement<Pokemon,PixelmonEntity,PokemonSpecification>

Parameters:

pokemon - The data