com.bergerkiller.bukkit.common.entity

Class CommonEntity<T extends org.bukkit.entity.Entity>

java.lang.Object

com.bergerkiller.bukkit.common.bases.ExtendedEntity<T>

com.bergerkiller.bukkit.common.entity.CommonEntity<T>

Type Parameters:

T - - type of Entity

Direct Known Subclasses:

CommonItem, CommonLivingEntity, CommonMinecart

public class CommonEntity<T extends org.bukkit.entity.Entity>
extends ExtendedEntity<T>

Wrapper class for additional methods Bukkit can't or doesn't provide.

Field Summary

Fields inherited from class com.bergerkiller.bukkit.common.bases.ExtendedEntity

entity, handle, last, loc, MIN_MOVE_SPEED, vel

Constructor Summary

Constructors

Constructor and Description
CommonEntity(T entity)

Method Summary

Modifier and Type	Method and Description
static void	clearControllers(org.bukkit.entity.Entity entity) Clears possible network or Entity controllers from the Entity.
static CommonEntity	create(org.bukkit.entity.EntityType entityType, org.bukkit.Location location) Creates a new Entity instance by calling its default World constructor, and initialized position.
static CommonEntity	createNull(org.bukkit.entity.EntityType entityType) Creates a new Entity instance without validly constructing it.
void	doPostTick() Performs all the logic normally performed after ticking a single Entity.
static CommonItem	get(org.bukkit.entity.Item item) Obtains a (new) CommonItem instance providing additional methods for the Item specified.
static CommonPlayer	get(org.bukkit.entity.Player player) Obtains a (new) CommonPlayer instance providing additional methods for the Player specified.
static <T extends org.bukkit.entity.Entity> CommonEntity<T>	get(T entity) Obtains a (new) CommonEntity instance providing additional methods for the Entity specified.
static <T extends org.bukkit.entity.LivingEntity,C extends CommonLivingEntity<? extends T>> C	get(T livingEntity) Obtains a (new) CommonLivingEntity instance providing additional methods for the Living Entity specified.
static <T extends org.bukkit.entity.Entity,C extends CommonEntity<? extends T>> C	get(T entity, Class<C> type) Obtains a (new) CommonEntity instance providing additional methods for the Entity specified.
EntityController<CommonEntity<T>>	getController() Gets the Entity Controller currently assigned to this Entity.
<C extends EntityController<?>> C	getController(Class<? extends C> controllerType) Gets the Entity Controller currently assigned to this Entity, checking to make sure the controller is of a certain Class type.
EntityNetworkController<CommonEntity<T>>	getNetworkController() Gets the Entity Network Controller currently assigned to this Entity.
boolean	hasControllerSupport() Checks whether this particular Entity supports the use of Entity Controllers.
protected boolean	isHooked() Checks whether the Entity is a BKCommonLib hook
protected void	prepareHook() Replaces the current entity, if needed, with the BKCommonLib Hook entity type
void	setController(EntityController controller) Sets an Entity Controller for this Entity.
void	setNetworkController(EntityNetworkController controller) Sets an Entity Network Controller for this Entity.
static CommonEntity	spawn(org.bukkit.entity.EntityType entityType, org.bukkit.Location location, EntityController controller, EntityNetworkController networkController) Creates a new Entity and spawns it at the Location and using the controllers specified.
boolean	teleport(org.bukkit.Location location, org.bukkit.event.player.PlayerTeleportEvent.TeleportCause cause)

Methods inherited from class com.bergerkiller.bukkit.common.bases.ExtendedEntity

addPassenger, eject, equals, getAllowTeleportation, getChunk, getChunkX, getChunkY, getChunkZ, getDataItem, getDataWatcher, getEntity, getEntityId, getFallDistance, getFireTicks, getHandle, getHandle, getHeadRotation, getHeight, getLastDamageCause, getLastLocation, getLastLocation, getLeashHolder, getLength, getLocation, getLocation, getMaxFireTicks, getMetaData, getMetadata, getMovedDistance, getMovedDistanceSquared, getMovedX, getMovedXZDistance, getMovedXZDistanceSquared, getMovedY, getMovedZ, getNearbyEntities, getNearbyEntities, getPassenger, getPassengers, getPlayerPassenger, getPlayerPassengers, getPortalCooldown, getPortalCooldownMaximum, getRandom, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, getWrappedHandle, hashCode, hasMetadata, hasMoved, hasMovedHorizontally, hasMovedVertically, hasPassenger, hasPlayerPassenger, isDead, isEmpty, isInLoadedChunk, isInsideVehicle, isInWater, isInWater, isMovementImpaired, isMoving, isMovingHorizontally, isMovingVertically, isOnGround, isPassenger, isPositionChanged, isPreventBlockPlace, isSpawned, isValid, isVehicle, isVelocityChanged, leaveVehicle, makeRandomSound, makeRandomSound, makeSound, makeSound, makeSound, makeStepSound, makeStepSound, playEffect, read, remove, removeMetadata, removePassenger, sendPacketNearby, setAllowTeleportation, setChunkX, setChunkY, setChunkZ, setDead, setEntity, setFallDistance, setFireTicks, setFootLocation, setLastDamageCause, setLocation, setMetadata, setMovementImpaired, setOnGround, setPassenger, setPassengerSilent, setPassengersSilent, setPortalCooldown, setPosition, setPositionChanged, setPreventBlockPlace, setRotation, setSize, setTicksLived, setVelocity, setVelocity, setVelocityChanged, setWorld, spawnItemDrop, spawnItemDrop, teleport, teleport, teleport, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommonEntity

public CommonEntity(T entity)

Method Detail

getNetworkController

public EntityNetworkController<CommonEntity<T>> getNetworkController()

Gets the Entity Network Controller currently assigned to this Entity. If none is available, this method returns Null. If no custom network controller is set, this method returns a new DefaultEntityNetworkController instance.

Returns:

Entity Network Controller, or null if not available

setNetworkController

public void setNetworkController(EntityNetworkController controller)

Sets an Entity Network Controller for this Entity. To stop tracking this minecart, pass in Null. To default back to the net.minecraft.server implementation, pass in a new DefaultEntityNetworkController instance.

This method only works if the Entity world has previously been set.

Parameters:

controller - to set to

getController

public <C extends EntityController<?>> C getController(Class<? extends C> controllerType)

Gets the Entity Controller currently assigned to this Entity, checking to make sure the controller is of a certain Class type. When no custom controller is set, or the current controller can not be assigned to the type specified, null is returned instead.

This method offers performance benefits over getController() by not instantiating a new default controller when no controller is set.

Parameters:

controllerType - to get

Returns:

the controller of controllerType, or null if not found

getController

public EntityController<CommonEntity<T>> getController()

Gets the Entity Controller currently assigned to this Entity. If no custom controller is set, this method returns a new DefaultEntityController instance.

Returns:

Entity Controller

setController

public void setController(EntityController controller)

Sets an Entity Controller for this Entity. This method throws an Exception if this kind of Entity is not supported.

Parameters:

controller - to set to

hasControllerSupport

public boolean hasControllerSupport()

Checks whether this particular Entity supports the use of Entity Controllers. If this method returns True, setController(EntityController) can be used.

Note that Entity Network Controllers are always supported.

Returns:

True if Entity Controllers are supported, False if not

isHooked

protected boolean isHooked()

Checks whether the Entity is a BKCommonLib hook

Returns:

True if hooked, False if not

prepareHook

protected void prepareHook()

Replaces the current entity, if needed, with the BKCommonLib Hook entity type

doPostTick

public void doPostTick()

Performs all the logic normally performed after ticking a single Entity. If onTick is managed externally, this method keeps it compatible. Calling this method results in the entity properly moved between chunks, and other logic.

teleport

public boolean teleport(org.bukkit.Location location,
                        org.bukkit.event.player.PlayerTeleportEvent.TeleportCause cause)

Overrides:

teleport in class ExtendedEntity<T extends org.bukkit.entity.Entity>

spawn

public static final CommonEntity spawn(org.bukkit.entity.EntityType entityType,
                                       org.bukkit.Location location,
                                       EntityController controller,
                                       EntityNetworkController networkController)

Creates a new Entity and spawns it at the Location and using the controllers specified.

Parameters:

entityType - to spawn

location - to spawn at

controller - to assign to the Entity after spawning

networkController - to assign to the Entity after spawning

Returns:

True if spawning occurred, False if not

See Also:

#spawn(Location)

create

public static final CommonEntity create(org.bukkit.entity.EntityType entityType,
                                        org.bukkit.Location location)

Creates a new Entity instance by calling its default World constructor, and initialized position. Unlike #spawn() this does not spawn the entity in the world, and it will stay detached.

Parameters:

entityType - to create

location - of the entity

Returns:

created entity

createNull

public static final CommonEntity createNull(org.bukkit.entity.EntityType entityType)

Creates a new Entity instance without validly constructing it. Please avoid using this as it will cause serious bugs when spawned into a world.

Parameters:

entityType - type to create

Returns:

CommonEntity

get

public static CommonItem get(org.bukkit.entity.Item item)

Obtains a (new) CommonItem instance providing additional methods for the Item specified. This method never returns null, unless the input Entity is null.

Parameters:

item - to get a CommonItem for

Returns:

a (new) CommonItem instance for the Item

get

public static CommonPlayer get(org.bukkit.entity.Player player)

Obtains a (new) CommonPlayer instance providing additional methods for the Player specified. This method never returns null, unless the input Entity is null.

Parameters:

player - to get a CommonPlayer for

Returns:

a (new) CommonPlayer instance for the Player

get

public static <T extends org.bukkit.entity.LivingEntity,C extends CommonLivingEntity<? extends T>> C get(T livingEntity)

Obtains a (new) CommonLivingEntity instance providing additional methods for the Living Entity specified. This method never returns null, unless the input Entity is null.

Parameters:

livingEntity - to get a CommonLivingEntity for

Returns:

a (new) CommonLivingEntity instance for the Living Entity

get

public static <T extends org.bukkit.entity.Entity,C extends CommonEntity<? extends T>> C get(T entity,
                                                                                             Class<C> type)

Obtains a (new) CommonEntity instance providing additional methods for the Entity specified. A specific CommonEntity extension that best fits the input Entity can be requested using this method. This method never returns null, unless the input Entity is null.

Parameters:

entity - to get a CommonEntity for

type - of CommonEntity to get

Returns:

a (new) CommonEntity type requested, or null if casting failed/entity is invalid

get

public static <T extends org.bukkit.entity.Entity> CommonEntity<T> get(T entity)

Obtains a (new) CommonEntity instance providing additional methods for the Entity specified. This method never returns null, unless the input Entity is null.

Parameters:

entity - to get a CommonEntity for

Returns:

a (new) CommonEntity instance for the Entity

clearControllers

public static void clearControllers(org.bukkit.entity.Entity entity)

Clears possible network or Entity controllers from the Entity. This should be called when a specific Entity should default back to all default behaviours.

Parameters:

entity - to clear the controllers of