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

Class BattleClause

java.lang.Object

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

All Implemented Interfaces:

IEncodeable, java.lang.Comparable<BattleClause>

Direct Known Subclasses:

AbilityClause, ItemPreventClause, LogicalAndBattleClause, LogicalOrBattleClause, MaximumOneBatonPass, MoveClause, MultipleSpeciesClause, NoDuplicateItemClause, PokemonBanClause, SkyBattleClause, SpeedPassClause, Tier

public class BattleClause
extends java.lang.Object
implements java.lang.Comparable<BattleClause>, IEncodeable

A clause that imposes restrictions on a battle. The unique ID of the battle clause. Should not be the same as another clause ID, and should not be a reserved keyword ("e", "f", "n"). The description of the clause, if not using the default lang key. If this is null, the description will use the lang key at "gui.battlerules.description.".

Constructor Summary

Constructors

Constructor and Description
BattleClause(java.lang.String id) Initializes a battle clause definition.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BattleClause o)
void	decodeInto(net.minecraft.network.PacketBuffer buffer) Decodes the object from a buffer.
void	encodeInto(net.minecraft.network.PacketBuffer buffer) Encodes the object into a buffer.
boolean	equals(java.lang.Object other)
java.lang.String	getDescription() Gets a description of the battle clause.
java.lang.String	getID() Gets the unique ID of the battle clause.
java.lang.String	getLocalizedName() Gets the translated name of the battle clause.
static java.lang.String	getLocalizedName(java.lang.String clauseID) Gets the translated name of the battle clause.
int	hashCode()
BattleClause	setDescription(java.lang.String description) Sets a non-default description for the clause.
java.lang.String	toString()
boolean	validateSingle(Pokemon pokemon) Checks if the rule allows a Pokémon to be chosen for battle.
boolean	validateTeam(java.util.List<Pokemon> team) Checks if the rule allows a list of Pokémon to be chosen for battle.

Methods inherited from class java.lang.Object

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

Constructor Detail

BattleClause

public BattleClause(java.lang.String id)

Initializes a battle clause definition.

Parameters:

id - The unique ID of the battle clause.

Method Detail

setDescription

public BattleClause setDescription(java.lang.String description)

Sets a non-default description for the clause.

Parameters:

description - The description of the clause.

Returns:

The battle clause instance.

getID

public java.lang.String getID()

Gets the unique ID of the battle clause.

Returns:

The unique ID of the battle clause.

getDescription

public java.lang.String getDescription()

Gets a description of the battle clause.

Returns:

A description of the battle clause.

getLocalizedName

public java.lang.String getLocalizedName()

Gets the translated name of the battle clause.

Returns:

The translated name of the battle clause.

getLocalizedName

public static java.lang.String getLocalizedName(java.lang.String clauseID)

Gets the translated name of the battle clause.

Parameters:

clauseID - The ID of the clause to translate.

Returns:

The translated name of the battle clause.

validateSingle

public boolean validateSingle(Pokemon pokemon)

Checks if the rule allows a Pokémon to be chosen for battle.

Parameters:

pokemon - The Pokémon to check.

Returns:

Whether the rule allows the given Pokémon to be chosen for battle.

validateTeam

public boolean validateTeam(java.util.List<Pokemon> team)

Checks if the rule allows a list of Pokémon to be chosen for battle.

Parameters:

team - The Pokémon to check.

Returns:

Whether the rule allows the given team to be chosen for battle.

encodeInto

public void encodeInto(net.minecraft.network.PacketBuffer buffer)

Description copied from interface: IEncodeable

Encodes the object into a buffer.

Specified by:

encodeInto in interface IEncodeable

Parameters:

buffer - The buffer to encode the object into.

decodeInto

public void decodeInto(net.minecraft.network.PacketBuffer buffer)

Description copied from interface: IEncodeable

Decodes the object from a buffer.

Specified by:

decodeInto in interface IEncodeable

Parameters:

buffer - The buffer to decode the object from.

compareTo

public int compareTo(BattleClause o)

Specified by:

compareTo in interface java.lang.Comparable<BattleClause>

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object