Tutorial [Tutorial] Spawning a custom wolf

For my custom KitPvP plugin, I wanted certain items to have "magical" abilities attached to them. One of these abilities was to spawn a custom wolf with a specified owner and properties.

This tutorial covers how to spawn a wolf, set it's owner, name, collar color and more.

1. Making the Ability Class. You can edit this class to your liking because it has a lot of methods that aren't required (Ex: I have a check to make sure the player's item in hand is a bone).

Code:java

import java.util.Random;
 
import org.bukkit.ChatColor;
import org.bukkit.DyeColor;
import org.bukkit.Material;
import org.bukkit.entity.EntityType;
import org.bukkit.entity.Player;
import org.bukkit.entity.Wolf;
import org.bukkit.inventory.ItemStack;
 
/**
* @author Anand
*
*/
public class AbilitySummon
{
    public static void summonWolf(Player p) {
        if (!isBone(p))
            return;
 
        // Spawn anywhere between 1 and 4 wolves.
                Random rand = new Random();
        int amount = rand.nextInt(4) + 1;
        for (int i = 0; i < amount; i++) {
            spawnWolf(p);
        }
 
        // Remove the bone.
        p.getInventory().removeItem(new ItemStack[] {new ItemStack(Material.BONE, 1)});
    }
 
    public static void spawnWolf(Player p) {
        Wolf wolf = (Wolf) p.getWorld().spawnEntity(p.getLocation(), EntityType.WOLF);
 
        // Just to make sure it's a normal wolf.
        wolf.setAdult();
        wolf.setTamed(true);
        wolf.setOwner(p);
 
        // We don't want extra wolves.
        wolf.setBreed(false);
 
        // Clarify the owner.
        wolf.setCustomName(ChatColor.YELLOW + p.getName() + "'s Wolf");
        wolf.setCustomNameVisible(true);
 
        // Let's have a little bit of variation
        wolf.setCollarColor(randomizeColor());
 
        // Misc.
        wolf.setHealth(wolf.getMaxHealth());
        wolf.setCanPickupItems(false);
    }
 
    // Check if the player's item is a bone.
    public static boolean isBone(Player p) {
        return (p.getItemInHand().getType() == Material.BONE);
    }
 
    // Getting the data is deprecated.
    @SuppressWarnings("deprecation")
    /*
    * Each Dyecolor (Black, Blue, Red, etc..) has it's own byte attached to it.
    */
    public static DyeColor randomizeColor() {
        Random random = new Random();
        int color = random.nextInt(16);
 
        for (int i = 0; i < 16; i++) {
            if (i == color)
                return DyeColor.getByData((byte) i);
            continue;
        }
        return null;
    }
}

2. Making the PlayerInteractEvent which will spawn the Wolf. I am not going to be doing any checks because your summonWolf(Player p) {} method does this already. Also, I will not be covering event registration because that is basic knowledge that you are expected to know.

Code:java

@EventHandler
public void onPlayerInteract(PlayerInteractEvent e) {
    Player p = e.getPlayer();
    AbilitySummon.summonWolf(p);
}

I hope this tutorial helped you! (Ignore the scoreboard in picture)
I just showed one way of customizing your wolves, but there are so many options! You can add potion effects, set the age, and more!

 

Cool!

 

ItsLeoFTW
Thanks!

 

AoH_Ruthless
Question....
What is the class AbilityUtil?

 

jusjus112
That's a good question. It's just a util class I made for all abilities I have in my KitPvP plugin. For that class, it just sets a random. I'll edit it to reflect what I'm actually giving. Thanks

 

never knew you could customize doggy collars xD

 

Rainy37
You learn something new every day!

 

haha thanks ^-^ This will help a lot in customizing mobs in my upcoming plugin

 

Just a couple pieces of advice:

1. In the DyeColor picker, you don't need the 'continue' in the for loop; it automatically continues by itself in your case.

2. You can actually make your DyeColor picker a LOT shorter and make it always return an actual DyeColor (never null) like this:

Code:

public static DyeColor getRandomDyeColor() {
    Random rand = new Random();
    return DyeColor.values()[rand.nextInt(DyeColor.values().length)];
}

That same method can be adjusted to pick a random value from any enumeration (enum) that has at least 1 value. I use it a lot myself actually.

3. Here's something else I use that helps repeat the same code. The first method is a cast of the second method, which picks a random from a generic enum (for easy implementation of two or more random pickers):

Code:

private static final Random rand = new Random();
 
public static DyeColor getRandomDyeColor() {
    return (DyeColor)getRandomEnum(DyeColor.class);
}
 
private static <E extends Enum<E>> Object getRandomEnum(Class<E> c) {
    return c.getEnumConstants()[rand.nextInt(c.getEnumConstants().length)];
}
 
//you would then use this to call the method (Utils is the name of the class that contains the above code)
wolf.setCollarColor(Utils.getRandomDyeColor());

Just a couple suggestions to make your life easier down the road.

Have fun!

 

Scizzr
I had just figured put last night that looping through is unnecessary but #laziness...

That is some nice advice for getting a random enum!