com.pixelmonmod.pixelmon.api.pokemon

Class SpecFlag

java.lang.Object

com.pixelmonmod.pixelmon.api.pokemon.SpecValue<java.lang.Boolean>

com.pixelmonmod.pixelmon.api.pokemon.SpecFlag

All Implemented Interfaces:

ISpecType

public class SpecFlag
extends SpecValue<java.lang.Boolean>
implements ISpecType

A simple flag value for PokemonSpecs. This is a simple switch which can either be not present, off, or on. Example: untradeable

Since:

May 27, 2018

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<java.lang.String>	aliases

Fields inherited from class com.pixelmonmod.pixelmon.api.pokemon.SpecValue

key, value

Constructor Summary

Constructors

Constructor and Description
SpecFlag(java.lang.String... aliases)
SpecFlag(java.lang.String key, boolean value)

Method Summary

Modifier and Type	Method and Description
void	apply(EntityPixelmon pixelmon) Applies the spec to an EntityPixelmon.
void	apply(Pokemon pokemon) Applies the spec to a Pokemon.
SpecValue<java.lang.Boolean>	clone() Clones the data of this spec into a new one, to break references.
java.util.List<java.lang.String>	getKeys() All the acceptable keys for this spec type.
java.lang.Class<? extends SpecValue<?>>	getSpecClass() The SpecValue class that this will create.
java.lang.Class<java.lang.Boolean>	getValueClass() Gets the class for the generic T defining this SpecValue.
SpecValue<java.lang.Boolean>	make(boolean value)
boolean	matches(EntityPixelmon pixelmon) Returns true if the given EntityPixelmon has this spec.
boolean	matches(Pokemon pokemon) Returns true if the given Pokemon has this spec.
SpecValue<java.lang.Boolean>	parse(java.lang.String arg) Attempts to parse a spec of this type from a String argument.
SpecValue<?>	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt) Reads this type of spec value from NBT.
boolean	sentToClient() Whether or not the client is informed about this spec.
java.lang.String	toParameterForm(SpecValue<?> value) Restores it to the form used in commands.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt, SpecValue<?> value) Writes this type of spec value to NBT.

Methods inherited from class com.pixelmonmod.pixelmon.api.pokemon.SpecValue

apply, matches

Methods inherited from class java.lang.Object

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

Field Detail

aliases

public transient java.util.ArrayList<java.lang.String> aliases

Constructor Detail

SpecFlag

public SpecFlag(java.lang.String... aliases)

SpecFlag

public SpecFlag(java.lang.String key,
                boolean value)

Method Detail

getKeys

public java.util.List<java.lang.String> getKeys()

Description copied from interface: ISpecType

All the acceptable keys for this spec type. The first is that used for JSON serialization. Effectively aliases.

Specified by:

getKeys in interface ISpecType

make

public SpecValue<java.lang.Boolean> make(boolean value)

parse

public SpecValue<java.lang.Boolean> parse(java.lang.String arg)

Description copied from interface: ISpecType

Attempts to parse a spec of this type from a String argument. The argument may be null, and is how key-only specs work.

Specified by:

parse in interface ISpecType

readFromNBT

public SpecValue<?> readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: ISpecType

Reads this type of spec value from NBT.

Specified by:

readFromNBT in interface ISpecType

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt,
                       SpecValue<?> value)

Description copied from interface: ISpecType

Writes this type of spec value to NBT.

Specified by:

writeToNBT in interface ISpecType

getSpecClass

public java.lang.Class<? extends SpecValue<?>> getSpecClass()

Description copied from interface: ISpecType

The SpecValue class that this will create. This is needed for JSON deserialization.

Specified by:

getSpecClass in interface ISpecType

toParameterForm

public java.lang.String toParameterForm(SpecValue<?> value)

Description copied from interface: ISpecType

Restores it to the form used in commands.

Specified by:

toParameterForm in interface ISpecType

getValueClass

public java.lang.Class<java.lang.Boolean> getValueClass()

Description copied from class: SpecValue

Gets the class for the generic T defining this SpecValue. Needed for JSON deserialization.

Specified by:

getValueClass in class SpecValue<java.lang.Boolean>

apply

public void apply(EntityPixelmon pixelmon)

Description copied from class: SpecValue

Applies the spec to an EntityPixelmon.

Specified by:

apply in class SpecValue<java.lang.Boolean>

apply

public void apply(Pokemon pokemon)

Description copied from class: SpecValue

Applies the spec to a Pokemon.

Specified by:

apply in class SpecValue<java.lang.Boolean>

matches

public boolean matches(EntityPixelmon pixelmon)

Description copied from class: SpecValue

Returns true if the given EntityPixelmon has this spec.

Specified by:

matches in class SpecValue<java.lang.Boolean>

matches

public boolean matches(Pokemon pokemon)

Description copied from class: SpecValue

Returns true if the given Pokemon has this spec.

Specified by:

matches in class SpecValue<java.lang.Boolean>

clone

public SpecValue<java.lang.Boolean> clone()

Description copied from class: SpecValue

Clones the data of this spec into a new one, to break references.

Specified by:

clone in class SpecValue<java.lang.Boolean>

sentToClient

public boolean sentToClient()

Whether or not the client is informed about this spec. If this isn't a custom spec then you can't do anything about it without hax.