com.pixelmonmod.pixelmon.api.moveskills

Class MoveSkill

java.lang.Object

com.pixelmonmod.pixelmon.api.moveskills.MoveSkill

public class MoveSkill
extends java.lang.Object

Represents a usable move skill. All move skills are instances of this object.

Creating a new move skill can be done by adding it to the moveSkills list and using register(net.minecraft.entity.player.EntityPlayerMP) when a player logs in.

Conversely, move skills can be unregistered by running unregister(net.minecraft.entity.player.EntityPlayerMP) when a player logs in.

New move skills can be created without any client-side modding, but the icon selection is limited to those provided for Reforged's default move skills.

Created by Hiroku

Since:

October 6, 2019

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoveSkill.EnumTargetType The types of targets that an external move can target.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<PokemonSpec>	ableSpecs A list of PokemonSpecs that describe the Pokémon that can use this move skill.
java.util.ArrayList<java.lang.Integer>	anyMoves A list of moves such that the Pokémon only needs one of these to use the move skill.
java.util.Map<MoveSkill.EnumTargetType,java.util.function.BiFunction<EntityPixelmon,java.lang.Object,java.lang.Integer>>	behaviours All of the behaviours this move skill allows for different types of target.
java.util.ArrayList<java.lang.Integer>	combinationMoves A list of moves such that the Pokémon needs all of these to use the move skill.
int	cooldownTicks The base time for the skill to require to cooldown.
java.util.ArrayList<java.lang.String>	descriptions The description of the move skill.
java.lang.String	id
java.util.ArrayList<PokemonSpec>	intrinsicSpecs A list of PokemonSpecs that describe the Pokémon that can use this move skill regardless of moves.
static java.util.ArrayList<MoveSkill>	moveSkills A list of all the known MoveSkills.
java.lang.String	name The name of the move skill.
int	range The range at which this move skill can be used.
net.minecraft.util.ResourceLocation	sprite The sprite that will be used in the GUIs.
boolean	usePP Whether or not PP will be required and consumed by the successful use of this move skill.

Constructor Summary

Constructors

Constructor and Description
MoveSkill(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	applyCooldown(Pokemon pokemon, int cooldownTicks)
boolean	checkForPP(Pokemon pokemon)
MoveSkill	describe(java.lang.String... descriptions) Adds the given strings onto the description of the move skill.
static MoveSkill	getMoveSkillByID(java.lang.String moveSkillID) Gets the move skill that matches the given ID.
static java.util.List<MoveSkill>	getMoveSkills(Pokemon pokemon) Gets all the move skills that the given Pokémon is capable of using, ignoring cooldowns.
boolean	hasMoveSkill(Pokemon pokemon) Checks whether the given Pokémon is able to use this move skill, ignoring cooldowns.
boolean	hasTargetType(MoveSkill.EnumTargetType targetType)
static boolean	isMoveSkill(java.lang.String moveSkillID) Checks whether the given String matches a move skill's ID.
void	onUsed(EntityPixelmon pixelmon, java.lang.Object data, MoveSkill.EnumTargetType targetType)
void	register(net.minecraft.entity.player.EntityPlayerMP player) Unregisters this move skill from the given player.
MoveSkill	setAbleSpecs(java.util.ArrayList<PokemonSpec> specs)
MoveSkill	setAnyMoves(java.util.ArrayList<AttackBase> anyMoves)
MoveSkill	setAnyMoves(java.util.List<java.lang.Integer> anyMoves)
MoveSkill	setAnyMoves(java.lang.String... anyMoves)
MoveSkill	setBehaviourBlockTarget(java.util.function.BiFunction<EntityPixelmon,net.minecraft.util.Tuple<net.minecraft.util.math.BlockPos,net.minecraft.util.EnumFacing>,java.lang.Integer> cooldown)
MoveSkill	setBehaviourMultiTarget(java.util.function.BiFunction<EntityPixelmon,java.lang.Object,java.lang.Integer> cooldown, MoveSkill.EnumTargetType... targetTypes)
MoveSkill	setBehaviourNoTarget(java.util.function.Function<EntityPixelmon,java.lang.Integer> cooldown)
MoveSkill	setBehaviourPlayerTarget(java.util.function.BiFunction<EntityPixelmon,net.minecraft.entity.player.EntityPlayerMP,java.lang.Integer> cooldown)
MoveSkill	setBehaviourPokemonTarget(java.util.function.BiFunction<EntityPixelmon,EntityPixelmon,java.lang.Integer> cooldown)
MoveSkill	setCombinationMoves(java.util.ArrayList<AttackBase> combinationMoves)
MoveSkill	setCombinationMoves(java.util.List<java.lang.Integer> combinationMoves)
MoveSkill	setCombinationMoves(java.lang.String... combinationMoves)
MoveSkill	setDefaultCooldownTicks(int cooldownTicks)
MoveSkill	setIcon(net.minecraft.util.ResourceLocation resourceLocation)
MoveSkill	setIntrinsicSpecs(java.util.ArrayList<PokemonSpec> specs)
MoveSkill	setName(java.lang.String name)
MoveSkill	setRange(int range)
MoveSkill	setUsePP(boolean usePP)
void	takePP(Pokemon pokemon)
void	unregister(net.minecraft.entity.player.EntityPlayerMP player) Registers this move skill on the given player.

Methods inherited from class java.lang.Object

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

Field Detail

moveSkills

public static final java.util.ArrayList<MoveSkill> moveSkills

A list of all the known MoveSkills. Note that adding a custom entry to this list will not inform the client; using register(net.minecraft.entity.player.EntityPlayerMP) on login is the responsibility of the sidemod.

id

public java.lang.String id

name

public java.lang.String name

The name of the move skill. In Reforged cases this is just a lang key.

descriptions

public java.util.ArrayList<java.lang.String> descriptions

The description of the move skill. In Reforged cases this is just a series of lang keys.

sprite

public net.minecraft.util.ResourceLocation sprite

The sprite that will be used in the GUIs.

cooldownTicks

public int cooldownTicks

The base time for the skill to require to cooldown.

range

public int range

The range at which this move skill can be used. This only applies for non-NOTHING target types.

anyMoves

public java.util.ArrayList<java.lang.Integer> anyMoves

A list of moves such that the Pokémon only needs one of these to use the move skill.

combinationMoves

public java.util.ArrayList<java.lang.Integer> combinationMoves

A list of moves such that the Pokémon needs all of these to use the move skill.

ableSpecs

public java.util.ArrayList<PokemonSpec> ableSpecs

A list of PokemonSpecs that describe the Pokémon that can use this move skill.

intrinsicSpecs

public java.util.ArrayList<PokemonSpec> intrinsicSpecs

A list of PokemonSpecs that describe the Pokémon that can use this move skill regardless of moves.

usePP

public boolean usePP

Whether or not PP will be required and consumed by the successful use of this move skill.

behaviours

public java.util.Map<MoveSkill.EnumTargetType,java.util.function.BiFunction<EntityPixelmon,java.lang.Object,java.lang.Integer>> behaviours

All of the behaviours this move skill allows for different types of target.

Constructor Detail

MoveSkill

public MoveSkill(java.lang.String id)

Method Detail

isMoveSkill

public static boolean isMoveSkill(java.lang.String moveSkillID)

Checks whether the given String matches a move skill's ID.

getMoveSkillByID

public static MoveSkill getMoveSkillByID(java.lang.String moveSkillID)

Gets the move skill that matches the given ID. Can be null.

getMoveSkills

public static java.util.List<MoveSkill> getMoveSkills(Pokemon pokemon)

Gets all the move skills that the given Pokémon is capable of using, ignoring cooldowns.

describe

public MoveSkill describe(java.lang.String... descriptions)

Adds the given strings onto the description of the move skill.

onUsed

public void onUsed(EntityPixelmon pixelmon,
                   java.lang.Object data,
                   MoveSkill.EnumTargetType targetType)

applyCooldown

public void applyCooldown(Pokemon pokemon,
                          int cooldownTicks)

hasMoveSkill

public boolean hasMoveSkill(Pokemon pokemon)

Checks whether the given Pokémon is able to use this move skill, ignoring cooldowns.

setName

public MoveSkill setName(java.lang.String name)

setDefaultCooldownTicks

public MoveSkill setDefaultCooldownTicks(int cooldownTicks)

setRange

public MoveSkill setRange(int range)

setIcon

public MoveSkill setIcon(net.minecraft.util.ResourceLocation resourceLocation)

setAnyMoves

public MoveSkill setAnyMoves(java.lang.String... anyMoves)

setAnyMoves

public MoveSkill setAnyMoves(java.util.ArrayList<AttackBase> anyMoves)

setAnyMoves

public MoveSkill setAnyMoves(java.util.List<java.lang.Integer> anyMoves)

setCombinationMoves

public MoveSkill setCombinationMoves(java.lang.String... combinationMoves)

setCombinationMoves

public MoveSkill setCombinationMoves(java.util.ArrayList<AttackBase> combinationMoves)

setCombinationMoves

public MoveSkill setCombinationMoves(java.util.List<java.lang.Integer> combinationMoves)

setAbleSpecs

public MoveSkill setAbleSpecs(java.util.ArrayList<PokemonSpec> specs)

setIntrinsicSpecs

public MoveSkill setIntrinsicSpecs(java.util.ArrayList<PokemonSpec> specs)

setBehaviourNoTarget

public MoveSkill setBehaviourNoTarget(java.util.function.Function<EntityPixelmon,java.lang.Integer> cooldown)

setBehaviourPokemonTarget

public MoveSkill setBehaviourPokemonTarget(java.util.function.BiFunction<EntityPixelmon,EntityPixelmon,java.lang.Integer> cooldown)

setBehaviourBlockTarget

public MoveSkill setBehaviourBlockTarget(java.util.function.BiFunction<EntityPixelmon,net.minecraft.util.Tuple<net.minecraft.util.math.BlockPos,net.minecraft.util.EnumFacing>,java.lang.Integer> cooldown)

setBehaviourPlayerTarget

public MoveSkill setBehaviourPlayerTarget(java.util.function.BiFunction<EntityPixelmon,net.minecraft.entity.player.EntityPlayerMP,java.lang.Integer> cooldown)

setBehaviourMultiTarget

public MoveSkill setBehaviourMultiTarget(java.util.function.BiFunction<EntityPixelmon,java.lang.Object,java.lang.Integer> cooldown,
                                         MoveSkill.EnumTargetType... targetTypes)

setUsePP

public MoveSkill setUsePP(boolean usePP)

hasTargetType

public boolean hasTargetType(MoveSkill.EnumTargetType targetType)

checkForPP

public boolean checkForPP(Pokemon pokemon)

takePP

public void takePP(Pokemon pokemon)

register

public void register(net.minecraft.entity.player.EntityPlayerMP player)

Unregisters this move skill from the given player. This prevents it from appearing in the move skill GUI.

unregister

public void unregister(net.minecraft.entity.player.EntityPlayerMP player)

Registers this move skill on the given player. If it's already registered, its information is updated.