Files
Bukkit/src/main/java/org/bukkit/entity/Tameable.java
Wesley Wolfe 8a1dbc38da Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here.
2013-12-15 01:09:18 -05:00

45 lines
1.2 KiB
Java

package org.bukkit.entity;
public interface Tameable {
/**
* Check if this is tamed
* <p>
* If something is tamed then a player can not tame it through normal
* methods, even if it does not belong to anyone in particular.
*
* @return true if this has been tamed
*/
public boolean isTamed();
/**
* Sets if this has been tamed. Not necessary if the method setOwner has
* been used, as it tames automatically.
* <p>
* If something is tamed then a player can not tame it through normal
* methods, even if it does not belong to anyone in particular.
*
* @param tame true if tame
*/
public void setTamed(boolean tame);
/**
* Gets the current owning AnimalTamer
*
* @return the owning AnimalTamer, or null if not owned
*/
public AnimalTamer getOwner();
/**
* Set this to be owned by given AnimalTamer.
* <p>
* If the owner is not null, this will be tamed and will have any current
* path it is following removed. If the owner is set to null, this will be
* untamed, and the current owner removed.
*
* @param tamer the AnimalTamer who should own this
*/
public void setOwner(AnimalTamer tamer);
}