Developers

View the Developer API for WelcomeRewards.

WelcomeRewardEvent

This event is fired when the player redeems a piggy bank.

@EventHandler
public void onPlayerWelcome(WelcomeRewardEvent e) {
    Player player = e.getPlayer();
    
    // Get player being welcomed.
    String target = e.getTarget();
    
    // Get rewards that player will receive.
    List<String> rewards = e.getRewards();
    
    // The time taken to welcome the player.
    Long timeTaken = e.getTimeTaken();
    
    // Is the event cancelled? Returns boolean.
    event.isCancelled();
    
    // Should we cancel the event?
    event.setCancelled(boolean)

}