com.bergerkiller.bukkit.common.wrappers

Class EntityTracker

java.lang.Object

com.bergerkiller.bukkit.common.wrappers.BasicWrapper<EntityTrackerHandle>

com.bergerkiller.bukkit.common.wrappers.EntityTracker

public class EntityTracker
extends BasicWrapper<EntityTrackerHandle>

Wrapper class for the Entity Tracker

Field Summary

Fields inherited from class com.bergerkiller.bukkit.common.wrappers.BasicWrapper

handle

Constructor Summary

Constructors

Constructor and Description
EntityTracker(Object entityTrackerHandle)

Method Summary

Modifier and Type	Method and Description
boolean	containsEntry(EntityTrackerEntryHandle entityTrackerEntry) Checks whether a certain entry is contained and managed by this tracker
EntityTrackerEntryHandle	getEntry(org.bukkit.entity.Entity entity) Gets the entity tracker entry of an entity
EntityTrackerEntryHandle	getEntry(int entityId) Gets the entity tracker entry of an entity Id
void	removeViewer(org.bukkit.entity.Player player) Removes a player viewer, resulting in all entities being removed for the viewer.
void	sendPacket(org.bukkit.entity.Entity entity, CommonPacket packet) Sends a packet to all nearby players (and self if it is a player)
void	sendPacket(org.bukkit.entity.Entity entity, Object packet) Sends a packet to all nearby players (and self if it is a player)
EntityTrackerEntryHandle	setEntry(org.bukkit.entity.Entity entity, EntityTrackerEntryHandle entityTrackerEntry) Sets the entity tracker entry for an entity
void	startTracking(org.bukkit.entity.Entity entity) Adds an entity to this entity tracker, creating a new entity tracker entry if needed
void	stopTracking(org.bukkit.entity.Entity entity) Removes an entity from this entity tracker.
void	updateViewer(org.bukkit.entity.Player player) Informs all entities of a new player viewer, sending possible spawn packets

Methods inherited from class com.bergerkiller.bukkit.common.wrappers.BasicWrapper

equals, getBackingHandle, getHandle, getHandle, getRawHandle, getRawHandle, setHandle, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityTracker

public EntityTracker(Object entityTrackerHandle)

Method Detail

sendPacket

public void sendPacket(org.bukkit.entity.Entity entity,
                       CommonPacket packet)

Sends a packet to all nearby players (and self if it is a player)

Parameters:

entity - near which viewers should be sent

packet - to send

sendPacket

public void sendPacket(org.bukkit.entity.Entity entity,
                       Object packet)

Sends a packet to all nearby players (and self if it is a player)

Parameters:

entity - near which viewers should be sent

packet - to send

removeViewer

public void removeViewer(org.bukkit.entity.Player player)

Removes a player viewer, resulting in all entities being removed for the viewer. If the player is still referenced in the entity tracker in some way, the entities will be re-sent at a later time automatically. This method acts as a 'total respawn' system for that reason.

Parameters:

player - to remove from this Entity Tracker

updateViewer

public void updateViewer(org.bukkit.entity.Player player)

Informs all entities of a new player viewer, sending possible spawn packets

Parameters:

player - to update

startTracking

public void startTracking(org.bukkit.entity.Entity entity)

Adds an entity to this entity tracker, creating a new entity tracker entry if needed

Parameters:

entity - to start tracking

stopTracking

public void stopTracking(org.bukkit.entity.Entity entity)

Removes an entity from this entity tracker. This call will result in entity destroy packets being sent to nearby players.

Parameters:

entity - to remove

setEntry

public EntityTrackerEntryHandle setEntry(org.bukkit.entity.Entity entity,
                                         EntityTrackerEntryHandle entityTrackerEntry)

Sets the entity tracker entry for an entity

Parameters:

entity - to set the tracker entry for

entityTrackerEntry - to set to

Returns:

previously set entity tracker entry, null if there was none

getEntry

public EntityTrackerEntryHandle getEntry(org.bukkit.entity.Entity entity)

Gets the entity tracker entry of an entity

Parameters:

entity - to get the entry of

Returns:

entity tracker entry

getEntry

public EntityTrackerEntryHandle getEntry(int entityId)

Gets the entity tracker entry of an entity Id

Parameters:

entityId - of the entity to get the entry of

Returns:

entity tracker entry

containsEntry

public boolean containsEntry(EntityTrackerEntryHandle entityTrackerEntry)

Checks whether a certain entry is contained and managed by this tracker

Parameters:

entityTrackerEntry -

Returns:

True if the entity tracker entry is contained