PlayerParticipant (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.battles.controller.participants.BattleParticipant
- - com.pixelmonmod.pixelmon.battles.controller.participants.PlayerParticipant

public class PlayerParticipant
extends BattleParticipant

A battle participant representing a player.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`hasAmuletCoin` Whether an Amulet Coin will double prize money.
`boolean`	`hasHappyHour` Whether Happy Hour will double prize money.
`PlayerPartyStorage`	`party` The player's Pokémon.
`int`	`payDay` The amount of money earned from Pay Day after the battle ends.
`net.minecraft.entity.player.ServerPlayerEntity`	`player` The player that this participant is representing.

Fields inherited from class com.pixelmonmod.pixelmon.battles.controller.participants.BattleParticipant
allPokemon, ashNinja, bc, controlledPokemon, dynamax, evolution, faintedLastTurn, isDefeated, lastFailedCapture, lastMoveTime, numControlledPokemon, startedBattle, switchingIn, switchingOut, team, totalFainted, ultraBurst, usedZ, wait

Constructor Summary

Constructors
Constructor and Description
`PlayerParticipant(boolean raid, net.minecraft.entity.player.ServerPlayerEntity p, PixelmonEntity... startingPixelmon)` Deprecated.
`PlayerParticipant(boolean raid, net.minecraft.entity.player.ServerPlayerEntity p, Pokemon... startingPixelmon)` Initializes the player participant for a raid.
`PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p, java.util.List<Pokemon> teamSelection, int numControlledPokemon)` Initializes the player participant.
`PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p, PixelmonEntity... startingPixelmon)` Deprecated.
`PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p, Pokemon... startingPixelmon)` Initializes the player participant.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canDynamax()` Checks if the participant is allowed to Dynamax Pokémon.
`boolean`	`canGainXP()` Checks if the participant's Pokémon can give experience.
`boolean`	`canMegaEvolve()` Checks if the participant is allowed to Mega Evolve Pokémon.
`void`	`checkPlayerItems()` Increments orbs in the player's inventory upon defeating a Pokémon.
`boolean`	`checkPokemon()` Checks if the participant's Pokémon are in a valid state.
`void`	`endBattle(BattleEndCause cause)` Ends the battle the participant is in.
`java.util.ArrayList<PixelmonWrapper>`	`getAllyData()` Gets data about the player's allied Pokémon.
`int`	`getAmuletCoinMultiplier()`
`BattleMusicType`	`getBattleMusicType()`
`java.lang.String`	`getDisplayName()` Returns the name of the entity the participant is representing.
`net.minecraft.entity.LivingEntity`	`getEntity()` Gets the entity that this participant is representing.
`int`	`getHappyHourMultiplier()`
`int`	`getHighestLevel()` Gets the pokemonLevel of the highest-leveled Pokémon in the player's party.
`MoveChoice`	`getMove(PixelmonWrapper pokemon)` Gets the move to be used by the specified Pokémon.
`net.minecraft.util.text.TextComponent`	`getName()` Gets the name of the participant.
`void`	`getNextPokemon(int position)` Sends out the next unfainted Pokémon in the participant's party.
`java.util.UUID`	`getNextPokemonUUID()` Gets the UUID of the next Pokémon in the participant's party that can battle;
`PixelmonClientData[]`	`getOpponentData()` Gets data about the player's opponents.
`int`	`getPrizeMoneyMultiplier()` Gets the multiplier for end-of-battle prize money awarded.
`PlayerPartyStorage`	`getStorage()` Returns the Pokémon storage of the participant.
`java.util.ArrayList<PixelmonWrapper>`	`getTeamPokemonList()` Finds all Pokémon in the battle allied with the player.
`ParticipantType`	`getType()` Gets the type of participant that this participant is.
`void`	`givePlayerExp(PixelmonWrapper pixelmon)` Awards experience to the player when a Pokémon faints.
`boolean`	`hasMorePokemonReserve()` For use with switching in new Pokémon.
`void`	`openGui()` Opens the battle GUI if it didn't just get opened already.
`void`	`resetPayDay()`
`void`	`selectAction()` Chooses an action for the participant's Pokémon.
`void`	`sendDamagePacket(PixelmonWrapper user, int damage)` Updates the client when a Pokémon takes damage.
`void`	`sendHealPacket(PixelmonWrapper target, int amount)` Updates the client when a Pokémon heals.
`void`	`sendMessage(PixelmonPacket message)` Sends a packet to this participant, wont do anything if its not a player.
`void`	`setAmuletCoinMultiplier(int multiplier)`
`void`	`setHappyHourMultiplier(int multiplier)`
`void`	`startBattle()` Adds the participant to a battle.
`PixelmonWrapper`	`switchPokemon(PixelmonWrapper pw, java.util.UUID newPixelmonUUID)` Switches the participant's Pokémon for another one.
`void`	`tick()` Updates the participant every tick.
`void`	`updateOpponentPokemon()` Updates the player's opponents client-side.
`void`	`updateOtherPokemon()` Updates the opponent's Pokémon client-side.
`void`	`updatePokemon(PixelmonWrapper pw)` Updates the specified Pokémon client-side.
`void`	`updatePokemonHealth()` Updates the health of Pokémon on the opposing side of the battle.

Methods inherited from class com.pixelmonmod.pixelmon.battles.controller.participants.BattleParticipant
addSwitchingOut, animateDynamax, canSwitch, clearTurnVariables, countAblePokemon, countHealthPercent, countTeam, getActiveUnfaintedPokemon, getAllies, getBattleAI, getCurrentTime, getFaintedPokemon, getOpponentPokemon, getOpponents, getPartyPosition, getPokemonFromParty, getPokemonFromParty, getPokemonFromUUID, getRandomPartyPokemon, getTeamPokemon, getTotalFainted, getTurnTimeSeconds, getWait, getWorld, hasMorePokemon, hasRemainingPokemon, incrementFaintCount, loadParty, loadParty, loadSingle, onAddStatus, onEndTurn, onHit, onOpponentKO, onSwitchIn, onTakeTurn, onTargeted, onUseAttack, onUseAttackOther, onUseAttackPost, resetMoveTimer, setBattleAI, setNumControlledPokemon, switchAllFainted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - player
```
public net.minecraft.entity.player.ServerPlayerEntity player
```
    The player that this participant is representing.
  - party
```
public PlayerPartyStorage party
```
    The player's Pokémon.
  - hasAmuletCoin
```
public boolean hasAmuletCoin
```
    Whether an Amulet Coin will double prize money.
  - hasHappyHour
```
public boolean hasHappyHour
```
    Whether Happy Hour will double prize money.
  - payDay
```
public int payDay
```
    The amount of money earned from Pay Day after the battle ends.
- Constructor Detail
  - PlayerParticipant
```
@Deprecated
public PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p,
                                     PixelmonEntity... startingPixelmon)
```
    Deprecated.
    
    Initializes the player participant.
    
    Parameters:
    
    p - The player.
    
    startingPixelmon - The Pokémon to send out at the start of the battle.
  - PlayerParticipant
```
public PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p,
                         Pokemon... startingPixelmon)
```
    Initializes the player participant.
    
    Parameters:
    
    p - The player.
    
    startingPixelmon - The Pokémon to send out at the start of the battle.
  - PlayerParticipant
```
@Deprecated
public PlayerParticipant(boolean raid,
                                     net.minecraft.entity.player.ServerPlayerEntity p,
                                     PixelmonEntity... startingPixelmon)
```
    Deprecated.
    
    Initializes the player participant for a raid.
    
    Parameters:
    
    raid - Whether this participant is in a raid.
    
    p - The player.
    
    startingPixelmon - The Pokémon to send out at the start of the battle.
  - PlayerParticipant
```
public PlayerParticipant(boolean raid,
                         net.minecraft.entity.player.ServerPlayerEntity p,
                         Pokemon... startingPixelmon)
```
    Initializes the player participant for a raid.
    
    Parameters:
    
    raid - Whether this participant is in a raid.
    
    p - The player.
    
    startingPixelmon - The Pokémon to send out at the start of the battle.
  - PlayerParticipant
```
public PlayerParticipant(net.minecraft.entity.player.ServerPlayerEntity p,
                         java.util.List<Pokemon> teamSelection,
                         int numControlledPokemon)
```
    Initializes the player participant.
    
    Parameters:
    
    p - The player.
    
    teamSelection - The Pokémon that the player has selected for battle.
    
    numControlledPokemon - The number of active Pokémon that the participant has at once.
- Method Detail
  - getType
```
public ParticipantType getType()
```
    Description copied from class: BattleParticipant
    
    Gets the type of participant that this participant is.
    
    Specified by:
    
    getType in class BattleParticipant
    
    Returns:
    
    The type of participant that this participant is.
  - canGainXP
```
public boolean canGainXP()
```
    Description copied from class: BattleParticipant
    
    Checks if the participant's Pokémon can give experience.
    
    Specified by:
    
    canGainXP in class BattleParticipant
    
    Returns:
    
    Whether the participant's Pokémon can give experience.
  - hasMorePokemonReserve
```
public boolean hasMorePokemonReserve()
```
    Description copied from class: BattleParticipant
    
    For use with switching in new Pokémon. Checks if they have Pokémon in reserve. Normally calls countablePokemon.
    
    Specified by:
    
    hasMorePokemonReserve in class BattleParticipant
    
    Returns:
    
    True if the player has a Pokémon in reserve.
  - startBattle
```
public void startBattle()
```
    Description copied from class: BattleParticipant
    
    Adds the participant to a battle.
    
    Overrides:
    
    startBattle in class BattleParticipant
  - getTeamPokemonList
```
public java.util.ArrayList<PixelmonWrapper> getTeamPokemonList()
```
    Finds all Pokémon in the battle allied with the player.
    
    Returns:
    
    An array of Pokémon allied with the player.
  - endBattle
```
public void endBattle(BattleEndCause cause)
```
    Description copied from class: BattleParticipant
    
    Ends the battle the participant is in.
    
    Specified by:
    
    endBattle in class BattleParticipant
  - getNextPokemon
```
public void getNextPokemon(int position)
```
    Description copied from class: BattleParticipant
    
    Sends out the next unfainted Pokémon in the participant's party.
    
    Specified by:
    
    getNextPokemon in class BattleParticipant
    
    Parameters:
    
    position - The position to send out the Pokémon at.
  - getPrizeMoneyMultiplier
```
public int getPrizeMoneyMultiplier()
```
    Gets the multiplier for end-of-battle prize money awarded.
    
    Returns:
    
    The multiplier for end-of-battle prize money awarded.
  - getNextPokemonUUID
```
public java.util.UUID getNextPokemonUUID()
```
    Description copied from class: BattleParticipant
    
    Gets the UUID of the next Pokémon in the participant's party that can battle;
    
    Specified by:
    
    getNextPokemonUUID in class BattleParticipant
    
    Returns:
    
    the UUID of the next Pokémon in the participant's party that can battle, or null if there aren't any.
  - getName
```
public net.minecraft.util.text.TextComponent getName()
```
    Description copied from class: BattleParticipant
    
    Gets the name of the participant.
    
    Specified by:
    
    getName in class BattleParticipant
    
    Returns:
    
    The name of the participant.
  - selectAction
```
public void selectAction()
```
    Description copied from class: BattleParticipant
    
    Chooses an action for the participant's Pokémon.
    
    Overrides:
    
    selectAction in class BattleParticipant
  - getMove
```
public MoveChoice getMove(PixelmonWrapper pokemon)
```
    Description copied from class: BattleParticipant
    
    Gets the move to be used by the specified Pokémon.
    
    Specified by:
    
    getMove in class BattleParticipant
    
    Parameters:
    
    pokemon - The Pokémon to get a move for.
    
    Returns:
    
    The move to be used by the specified Pokémon.
  - switchPokemon
```
public PixelmonWrapper switchPokemon(PixelmonWrapper pw,
                                     java.util.UUID newPixelmonUUID)
```
    Description copied from class: BattleParticipant
    
    Switches the participant's Pokémon for another one.
    
    Specified by:
    
    switchPokemon in class BattleParticipant
    
    Parameters:
    
    pw - The Pokémon to switch out.
    
    newPixelmonUUID - The UUID of the Pokémon's to switch in.
    
    Returns:
    
    The Pokémon who switched in.
  - checkPokemon
```
public boolean checkPokemon()
```
    Description copied from class: BattleParticipant
    
    Checks if the participant's Pokémon are in a valid state.
    
    Specified by:
    
    checkPokemon in class BattleParticipant
    
    Returns:
    
    Whether the participant's Pokémon are in a valid state.
  - updatePokemon
```
public void updatePokemon(PixelmonWrapper pw)
```
    Description copied from class: BattleParticipant
    
    Updates the specified Pokémon client-side.
    
    Specified by:
    
    updatePokemon in class BattleParticipant
    
    Parameters:
    
    pw - The Pokémon to update.
  - getEntity
```
public net.minecraft.entity.LivingEntity getEntity()
```
    Description copied from class: BattleParticipant
    
    Gets the entity that this participant is representing.
    
    Specified by:
    
    getEntity in class BattleParticipant
    
    Returns:
    
    The entity that this participant is representing.
  - updateOtherPokemon
```
public void updateOtherPokemon()
```
    Description copied from class: BattleParticipant
    
    Updates the opponent's Pokémon client-side.
    
    Specified by:
    
    updateOtherPokemon in class BattleParticipant
  - getAllyData
```
public java.util.ArrayList<PixelmonWrapper> getAllyData()
```
    Gets data about the player's allied Pokémon.
    
    Returns:
    
    Data about the player's allied Pokémon.
  - getOpponentData
```
public PixelmonClientData[] getOpponentData()
```
    Gets data about the player's opponents.
    
    Returns:
    
    Data about the player's opponents.
  - updateOpponentPokemon
```
public void updateOpponentPokemon()
```
    Updates the player's opponents client-side.
  - updatePokemonHealth
```
public void updatePokemonHealth()
```
    Updates the health of Pokémon on the opposing side of the battle. If a Pokémon is fainted, award experience to the player.
  - checkPlayerItems
```
public void checkPlayerItems()
```
    Increments orbs in the player's inventory upon defeating a Pokémon.
  - getHighestLevel
```
public int getHighestLevel()
```
    Gets the pokemonLevel of the highest-leveled Pokémon in the player's party.
    
    Returns:
    
    The pokemonLevel of the highest-leveled Pokémon in the player's party
  - tick
```
public void tick()
```
    Description copied from class: BattleParticipant
    
    Updates the participant every tick.
    
    Overrides:
    
    tick in class BattleParticipant
  - givePlayerExp
```
public void givePlayerExp(PixelmonWrapper pixelmon)
```
    Awards experience to the player when a Pokémon faints. Experience is based on the pokemonLevel of the Pokémon that fainted.
    
    Parameters:
    
    pixelmon - The Pokémon that fainted.
  - openGui
```
public void openGui()
```
    Opens the battle GUI if it didn't just get opened already.
  - getBattleMusicType
```
public BattleMusicType getBattleMusicType()
```
  - sendDamagePacket
```
public void sendDamagePacket(PixelmonWrapper user,
                             int damage)
```
    Description copied from class: BattleParticipant
    
    Updates the client when a Pokémon takes damage.
    
    Overrides:
    
    sendDamagePacket in class BattleParticipant
    
    Parameters:
    
    user - The Pokémon who took damage.
    
    damage - The amount of damage dealt.
  - sendHealPacket
```
public void sendHealPacket(PixelmonWrapper target,
                           int amount)
```
    Description copied from class: BattleParticipant
    
    Updates the client when a Pokémon heals.
    
    Overrides:
    
    sendHealPacket in class BattleParticipant
    
    Parameters:
    
    target - The Pokémon who healed.
    
    amount - The amount of hp healed.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from class: BattleParticipant
    
    Returns the name of the entity the participant is representing.
    
    Overrides:
    
    getDisplayName in class BattleParticipant
    
    Returns:
    
    The name of the entity the participant is representing.
  - getStorage
```
public PlayerPartyStorage getStorage()
```
    Description copied from class: BattleParticipant
    
    Returns the Pokémon storage of the participant.
    
    Overrides:
    
    getStorage in class BattleParticipant
    
    Returns:
    
    The Pokémon storage of the participant.
  - canMegaEvolve
```
public boolean canMegaEvolve()
```
    Description copied from class: BattleParticipant
    
    Checks if the participant is allowed to Mega Evolve Pokémon.
    
    Overrides:
    
    canMegaEvolve in class BattleParticipant
    
    Returns:
    
    Whether the participant is allowed to Mega Evolve Pokémon.
  - canDynamax
```
public boolean canDynamax()
```
    Description copied from class: BattleParticipant
    
    Checks if the participant is allowed to Dynamax Pokémon.
    
    Overrides:
    
    canDynamax in class BattleParticipant
    
    Returns:
    
    Whether the participant is allowed to Dynamax Pokémon.
  - sendMessage
```
public void sendMessage(PixelmonPacket message)
```
    Description copied from class: BattleParticipant
    
    Sends a packet to this participant, wont do anything if its not a player.
    
    Overrides:
    
    sendMessage in class BattleParticipant
    
    Parameters:
    
    message - The packet to send to this player
  - getAmuletCoinMultiplier
```
public int getAmuletCoinMultiplier()
```
  - setAmuletCoinMultiplier
```
public void setAmuletCoinMultiplier(int multiplier)
```
  - getHappyHourMultiplier
```
public int getHappyHourMultiplier()
```
  - setHappyHourMultiplier
```
public void setHappyHourMultiplier(int multiplier)
```
  - resetPayDay
```
public void resetPayDay()
```

Class PlayerParticipant

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.battles.controller.participants.BattleParticipant

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.battles.controller.participants.BattleParticipant

Methods inherited from class java.lang.Object

Field Detail

player

party

hasAmuletCoin

hasHappyHour

payDay

Constructor Detail

PlayerParticipant

PlayerParticipant

PlayerParticipant

PlayerParticipant

PlayerParticipant

Method Detail

getType

canGainXP

hasMorePokemonReserve

startBattle

getTeamPokemonList

endBattle

getNextPokemon

getPrizeMoneyMultiplier

getNextPokemonUUID

getName

selectAction

getMove

switchPokemon

checkPokemon

updatePokemon

getEntity

updateOtherPokemon

getAllyData

getOpponentData

updateOpponentPokemon

updatePokemonHealth

checkPlayerItems

getHighestLevel

tick

givePlayerExp

openGui

getBattleMusicType

sendDamagePacket

sendHealPacket

getDisplayName

getStorage

canMegaEvolve

canDynamax

sendMessage

getAmuletCoinMultiplier

setAmuletCoinMultiplier

getHappyHourMultiplier

setHappyHourMultiplier

resetPayDay