com.pixelmonmod.pixelmon.battles.api.rules.clauses.tiers

Class Tier

java.lang.Object

com.pixelmonmod.pixelmon.battles.api.rules.clauses.BattleClause

com.pixelmonmod.pixelmon.battles.api.rules.clauses.tiers.Tier

All Implemented Interfaces:

IEncodeable, java.lang.Comparable<BattleClause>

Direct Known Subclasses:

HierarchicalTier

public class Tier
extends BattleClause

A type of battle rule that restricts the Pokémon that can be used based on a set of PokemonSpecification

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ban
protected java.util.Set<PokemonSpecification>	specs

Constructor Summary

Constructors

Constructor and Description
Tier(java.lang.String id, boolean ban, PokemonSpecification... spec) Initializes a new tier

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTierDescription() Gets a description of the tier for use in /tiershow.
boolean	validateSingle(Pokemon pokemon) The logic executed here is - When ban is true: if a single spec matches return false (i.e.

Methods inherited from class com.pixelmonmod.pixelmon.battles.api.rules.clauses.BattleClause

compareTo, decodeInto, encodeInto, equals, getDescription, getID, getLocalizedName, getLocalizedName, hashCode, setDescription, toString, validateTeam

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

specs

protected final java.util.Set<PokemonSpecification> specs

ban

protected final boolean ban

Constructor Detail

Tier

public Tier(java.lang.String id,
            boolean ban,
            PokemonSpecification... spec)

Initializes a new tier

Parameters:

id - The id of the tier/battle clause

ban - If the tier is a ban list

spec - The specs checked for this ban list

Method Detail

validateSingle

public boolean validateSingle(Pokemon pokemon)

The logic executed here is - When ban is true: if a single spec matches return false (i.e. isn't valid as it matches a banned spec) However, if no spec match then return true When ban is false: if all specs match return true (i.e. all the specs match the given pokemon) If a single spec doesn't match return false (doesn't meet requirements)

Overrides:

validateSingle in class BattleClause

Parameters:

pokemon - The Pokémon to check.

Returns:

True if a valid single pokemon

getTierDescription

public java.lang.String getTierDescription()

Gets a description of the tier for use in /tiershow.