MoveSkill (Pixelmon 1.16.5-9.1.7-pipe20926 API)

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.ServerPlayerEntity) when a player logs in.

Conversely, move skills can be unregistered by running unregister(net.minecraft.entity.player.ServerPlayerEntity) 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.

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.

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.Set<PokemonSpecification>`	`ableSpecs`
`java.util.Set<ImmutableAttack>`	`anyMoves`
`java.util.Map<MoveSkill.EnumTargetType,java.util.function.BiFunction<PixelmonEntity,java.lang.Object,java.lang.Integer>>`	`behaviours` All of the behaviours this move skill allows for different types of target.
`java.util.Set<ImmutableAttack>`	`combinationMoves`
`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.Set<PokemonSpecification>`	`intrinsicSpecs`
`static java.util.List<MoveSkill>`	`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)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`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(PixelmonEntity pixelmon, java.lang.Object data, MoveSkill.EnumTargetType targetType)`
`void`	`register(net.minecraft.entity.player.ServerPlayerEntity player)`
`MoveSkill`	`setAbleSpecs(java.util.List<PokemonSpecification> specs)`
`MoveSkill`	`setAnyMoves(java.util.List<ImmutableAttack> anyMoves)`
`MoveSkill`	`setAnyMoves(java.lang.String... anyMoves)`
`MoveSkill`	`setBehaviourBlockTarget(java.util.function.BiFunction<PixelmonEntity,net.minecraft.util.Tuple<net.minecraft.util.math.BlockPos,net.minecraft.util.Direction>,java.lang.Integer> cooldown)`
`MoveSkill`	`setBehaviourMultiTarget(java.util.function.BiFunction<PixelmonEntity,java.lang.Object,java.lang.Integer> cooldown, MoveSkill.EnumTargetType... targetTypes)`
`MoveSkill`	`setBehaviourNoTarget(java.util.function.Function<PixelmonEntity,java.lang.Integer> cooldown)`
`MoveSkill`	`setBehaviourPlayerTarget(java.util.function.BiFunction<PixelmonEntity,net.minecraft.entity.player.ServerPlayerEntity,java.lang.Integer> cooldown)`
`MoveSkill`	`setBehaviourPokemonTarget(java.util.function.BiFunction<PixelmonEntity,PixelmonEntity,java.lang.Integer> cooldown)`
`MoveSkill`	`setCombinationMoves(java.util.ArrayList<ImmutableAttack> combinationMoves)`
`MoveSkill`	`setCombinationMoves(java.lang.String... combinationMoves)`
`MoveSkill`	`setDefaultCooldownTicks(int cooldownTicks)`
`MoveSkill`	`setIcon(net.minecraft.util.ResourceLocation resourceLocation)`
`MoveSkill`	`setIntrinsicSpecs(java.util.List<PokemonSpecification> 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.ServerPlayerEntity 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.List<MoveSkill> moveSkills

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.Set<ImmutableAttack> anyMoves

combinationMoves

public java.util.Set<ImmutableAttack> combinationMoves

ableSpecs

public java.util.Set<PokemonSpecification> ableSpecs

intrinsicSpecs

public java.util.Set<PokemonSpecification> intrinsicSpecs

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<PixelmonEntity,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(PixelmonEntity pixelmon,
                   java.lang.Object data,
                   MoveSkill.EnumTargetType targetType)

applyCooldown

public void applyCooldown(Pokemon pokemon,
                          int cooldownTicks)

hasMoveSkill

public boolean hasMoveSkill(Pokemon pokemon)

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.List<ImmutableAttack> anyMoves)

setCombinationMoves

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

setCombinationMoves

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

setAbleSpecs

public MoveSkill setAbleSpecs(java.util.List<PokemonSpecification> specs)

setIntrinsicSpecs

public MoveSkill setIntrinsicSpecs(java.util.List<PokemonSpecification> specs)

setBehaviourNoTarget

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

setBehaviourPokemonTarget

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

setBehaviourBlockTarget

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

setBehaviourPlayerTarget

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

setBehaviourMultiTarget

public MoveSkill setBehaviourMultiTarget(java.util.function.BiFunction<PixelmonEntity,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.ServerPlayerEntity player)

unregister

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

Class MoveSkill

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

moveSkills

id

name

descriptions

sprite

cooldownTicks

range

anyMoves

combinationMoves

ableSpecs

intrinsicSpecs

usePP

behaviours

Constructor Detail

MoveSkill

Method Detail

isMoveSkill

getMoveSkillByID

getMoveSkills

describe

onUsed

applyCooldown

hasMoveSkill

setName

setDefaultCooldownTicks

setRange

setIcon

setAnyMoves

setAnyMoves

setCombinationMoves

setCombinationMoves

setAbleSpecs

setIntrinsicSpecs

setBehaviourNoTarget

setBehaviourPokemonTarget

setBehaviourBlockTarget

setBehaviourPlayerTarget

setBehaviourMultiTarget

setUsePP

hasTargetType

checkForPP

takePP

register

unregister