Added PlayerTradeEvent

[Amendment: Alexander <protonull@protonmail.com>]
PlayerTradeEvent is used for player purchases from villagers and wandering
traders, but not custom merchants created via Bukkit.createMerchant(). During
discussions in Discord it was decided that it'd be better to add a new event
that PlayerTradeEvent inherits from than change getVillager()'s annotation to
@Nullable, especially since that'd also infringe on the implication of the
event being about villager trades.
This commit is contained in:
Jake Potrebic 2020-07-02 16:10:10 -07:00
parent 3234f24141
commit ff36991035
2 changed files with 136 additions and 0 deletions

View file

@ -0,0 +1,104 @@
package io.papermc.paper.event.player;
import com.google.common.base.Preconditions;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.bukkit.event.player.PlayerEvent;
import org.bukkit.inventory.MerchantRecipe;
import org.jetbrains.annotations.ApiStatus;
import org.jspecify.annotations.NullMarked;
/**
* Called when a player trades with a standalone merchant GUI.
*/
@NullMarked
public class PlayerPurchaseEvent extends PlayerEvent implements Cancellable {
private static final HandlerList HANDLER_LIST = new HandlerList();
private boolean rewardExp;
private boolean increaseTradeUses;
private MerchantRecipe trade;
private boolean cancelled;
@ApiStatus.Internal
public PlayerPurchaseEvent(final Player player, final MerchantRecipe trade, final boolean rewardExp, final boolean increaseTradeUses) {
super(player);
this.trade = trade;
this.rewardExp = rewardExp;
this.increaseTradeUses = increaseTradeUses;
}
/**
* Gets the associated trade with this event
*
* @return the trade
*/
public MerchantRecipe getTrade() {
return this.trade;
}
/**
* Sets the trade. This is then used to determine the next prices
*
* @param trade the trade to use
*/
public void setTrade(final MerchantRecipe trade) {
Preconditions.checkArgument(trade != null, "Trade cannot be null!");
this.trade = trade;
}
/**
* @return will trade try to reward exp
*/
public boolean isRewardingExp() {
return this.rewardExp;
}
/**
* Sets whether the trade will try to reward exp
*
* @param rewardExp try to reward exp
*/
public void setRewardExp(final boolean rewardExp) {
this.rewardExp = rewardExp;
}
/**
* @return whether the trade will count as a use of the trade
*/
public boolean willIncreaseTradeUses() {
return this.increaseTradeUses;
}
/**
* Sets whether the trade will count as a use
*
* @param increaseTradeUses {@code true} to count, {@code false} otherwise
*/
public void setIncreaseTradeUses(final boolean increaseTradeUses) {
this.increaseTradeUses = increaseTradeUses;
}
@Override
public boolean isCancelled() {
return this.cancelled;
}
@Override
public void setCancelled(final boolean cancel) {
this.cancelled = cancel;
}
@Override
public HandlerList getHandlers() {
return HANDLER_LIST;
}
public static HandlerList getHandlerList() {
return HANDLER_LIST;
}
}

View file

@ -0,0 +1,32 @@
package io.papermc.paper.event.player;
import org.bukkit.entity.AbstractVillager;
import org.bukkit.entity.Player;
import org.bukkit.inventory.MerchantRecipe;
import org.jetbrains.annotations.ApiStatus;
import org.jspecify.annotations.NullMarked;
/**
* Called when a player trades with a villager or wandering trader
*/
@NullMarked
public class PlayerTradeEvent extends PlayerPurchaseEvent {
private final AbstractVillager villager;
@ApiStatus.Internal
public PlayerTradeEvent(final Player player, final AbstractVillager villager, final MerchantRecipe trade, final boolean rewardExp, final boolean increaseTradeUses) {
super(player, trade, rewardExp, increaseTradeUses);
this.villager = villager;
}
/**
* Gets the Villager or Wandering trader associated with this event
*
* @return the villager or wandering trader
*/
public AbstractVillager getVillager() {
return this.villager;
}
}