com.bergerkiller.bukkit.common.controller

Class EntityController<T extends CommonEntity<?>>

java.lang.Object

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

com.bergerkiller.bukkit.common.controller.EntityController<T>

All Implemented Interfaces:

Tickable

Direct Known Subclasses:

DefaultEntityController

public abstract class EntityController<T extends CommonEntity<?>>
extends CommonEntityController<T>

Field Summary

Fields inherited from class com.bergerkiller.bukkit.common.entity.CommonEntityController

entity

Constructor Summary

Constructors

Constructor and Description
EntityController()

Method Summary

Modifier and Type	Method and Description
void	bind(CommonEntity<?> entity, boolean handleAttachment) Binds this Entity Controller to an Entity.
String	getLocalizedName() Gets the localized name of this Entity.
boolean	isPlayerTakable() Gets whether this Entity Controller allows players to take this Entity with them.
boolean	onBlockCollision(org.bukkit.block.Block block, org.bukkit.block.BlockFace hitFace) Handles the collision of this minecart with a Block
void	onBurnDamage(double damage) Fired when the entity is getting burned by something
boolean	onDamage(DamageSource damageSource, double damage) Called when the entity is damaged by something
void	onDie() Called when this Entity dies (could be called more than one time)
boolean	onEntityCollision(org.bukkit.entity.Entity e) Handles the collision of this minecart with another Entity
boolean	onInteractBy(org.bukkit.entity.HumanEntity interacter, HumanHand hand) Called when the entity is interacted by something
void	onItemSet(int index, org.bukkit.inventory.ItemStack item) Called when an item in the inventory changes, if the entity has an inventory
void	onMove(MoveType moveType, double dx, double dy, double dz) Performs Entity movement logic, to move the Entity and handle collisions
void	onPush(double dx, double dy, double dz)
void	onTick() Called every tick to update the entity
void	setBlockCollisionBounds(org.bukkit.util.Vector bounds) Sets custom axis-aligned bounding box x/y/z size dimensions when handling block collisions.
void	setBlockCollisionEnabled(boolean enabled) Sets whether block collisions are handled during movement of the entity.
void	setEntityCollisionEnabled(boolean enabled) Sets whether entity collisions are handled during movement of the entity.

Methods inherited from class com.bergerkiller.bukkit.common.entity.CommonEntityController

getEntity, onAttached, onDetached

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityController

public EntityController()

Method Detail

bind

public final void bind(CommonEntity<?> entity,
                       boolean handleAttachment)

Binds this Entity Controller to an Entity. This is called from elsewhere, and should be ignored entirely.

Parameters:

entity - to bind with

handleAttachment - whether to fire CommonEntityController.onAttached()

onDie

public void onDie()

Called when this Entity dies (could be called more than one time)

onTick

public void onTick()

Called every tick to update the entity

Specified by:

onTick in interface Tickable

Overrides:

onTick in class CommonEntityController<T extends CommonEntity<?>>

onInteractBy

public boolean onInteractBy(org.bukkit.entity.HumanEntity interacter,
                            HumanHand hand)

Called when the entity is interacted by something

Parameters:

interacter - that interacted

hand - that is used

Returns:

True if interaction occurred, False if not

onDamage

public boolean onDamage(DamageSource damageSource,
                        double damage)

Called when the entity is damaged by something

Parameters:

damageSource - of the damage

damage - amount

onEntityCollision

public boolean onEntityCollision(org.bukkit.entity.Entity e)

Handles the collision of this minecart with another Entity

Parameters:

e - entity with which is collided

Returns:

True if collision is allowed, False if it is ignored

onBlockCollision

public boolean onBlockCollision(org.bukkit.block.Block block,
                                org.bukkit.block.BlockFace hitFace)

Handles the collision of this minecart with a Block

Parameters:

block - with which this minecart collided

hitFace - of the block that the minecart hit

Returns:

True if collision is allowed, False if it is ignored

onBurnDamage

public void onBurnDamage(double damage)

Fired when the entity is getting burned by something

Parameters:

damage - dealt

isPlayerTakable

public boolean isPlayerTakable()

Gets whether this Entity Controller allows players to take this Entity with them. With this enabled, players take the vehicle with them. To disable this default behavior, override this method.

Returns:

True if players can take the entity with them, False if not

getLocalizedName

public String getLocalizedName()

Gets the localized name of this Entity. Override this method to change the name.

Returns:

Localized name

onPush

public void onPush(double dx,
                   double dy,
                   double dz)

onMove

public void onMove(MoveType moveType,
                   double dx,
                   double dy,
                   double dz)

Performs Entity movement logic, to move the Entity and handle collisions

Parameters:

moveType - mode of moving

dx - offset to move

dy - offset to move

dz - offset to move

onItemSet

public void onItemSet(int index,
                      org.bukkit.inventory.ItemStack item)

Called when an item in the inventory changes, if the entity has an inventory

Parameters:

index - of the item

item - it was set to

setBlockCollisionEnabled

public void setBlockCollisionEnabled(boolean enabled)

Sets whether block collisions are handled during movement of the entity. Disabling block collisions causes entities to fall through the floor, but may result in a significant boost in performance.

Parameters:

enabled -

setEntityCollisionEnabled

public void setEntityCollisionEnabled(boolean enabled)

Sets whether entity collisions are handled during movement of the entity. Disabling entity collisions causes entities to go right through other entities without being affected, and may result in a significant boost in performance.

Parameters:

enabled -

setBlockCollisionBounds

public void setBlockCollisionBounds(org.bukkit.util.Vector bounds)

Sets custom axis-aligned bounding box x/y/z size dimensions when handling block collisions. If using a larger bounding box, changing the block collision bounding box helps fixing significant stress on the server handling a lot more block collision events than usual.

Parameters:

bounds - size vector to set to, null for defaults