com.bergerkiller.bukkit.tc.attachments.control

Class CartAttachmentEntity

java.lang.Object

com.bergerkiller.bukkit.tc.attachments.control.CartAttachment

com.bergerkiller.bukkit.tc.attachments.control.CartAttachmentEntity

All Implemented Interfaces:

Attachment

public class CartAttachmentEntity
extends CartAttachment

A cart attachment that is a standard Entity. This is also used for Vanilla style minecarts.

Constructor Summary

Constructors

Constructor and Description
CartAttachmentEntity()

Method Summary

Modifier and Type	Method and Description
void	applyDefaultSeatTransform(com.bergerkiller.bukkit.common.math.Matrix4x4 transform) Some attachment types, like entities, will have a default position relative to it where the player is normally seated.
boolean	containsEntityId(int entityId) Gets whether this attachment uses a particular Entity Id as part of displaying its contents in the world.
int	getMountEntityId() Gets an Entity Id of an Entity other entities can mount to mount this attachment.
static boolean	isEntityTypeSupported(org.bukkit.entity.EntityType entityType) Whether a particular entity type can be used at all in an entity attachment
void	makeHidden(org.bukkit.entity.Player viewer) Makes this attachment invisible (despawns) for a viewer.
void	makeVisible(org.bukkit.entity.Player viewer) Makes this attachment visible to a viewer for the first time.
void	onAttached() Called when the controller is attached to the real world.
void	onBlur() Called when an attachment loses focus in the editor or by other means.
void	onDetached() Called when the controller is detached from the real world.
void	onFocus() Called when an attachment is focused in the editor or by other means.
void	onMove(boolean absolute) Called every now and then to refresh the position of the attachment
void	onTick() Called every tick to update the attachment
void	onTransformChanged(com.bergerkiller.bukkit.common.math.Matrix4x4 transform) Called right after the Attachment.getTransform() has been updated.

Methods inherited from class com.bergerkiller.bukkit.tc.attachments.control.CartAttachment

getController, getInternalState, getViewers, onLoad, updateGlowColor, updateGlowColorFor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bergerkiller.bukkit.tc.attachments.api.Attachment

addAnimation, addChild, clearAnimations, findChild, getAnimations, getChildren, getConfig, getConfiguredPosition, getCurrentAnimation, getManager, getParent, getPreviousTransform, getTransform, isActive, isAttached, isFocused, isHiddenWhenInactive, playNamedAnimation, playNamedAnimation, playNamedAnimationRecursive, playNamedAnimationRecursive, setActive, setFocused, startAnimation, stopAnimation

Constructor Detail

CartAttachmentEntity

public CartAttachmentEntity()

Method Detail

onDetached

public void onDetached()

Description copied from interface: Attachment

Called when the controller is detached from the real world. After this call all stored information in the controller is invalid, until onAttached() is called again. #onSave(config) is called before this method is called, if saving is required.

Specified by:

onDetached in interface Attachment

Overrides:

onDetached in class CartAttachment

onAttached

public void onAttached()

Description copied from interface: Attachment

Called when the controller is attached to the real world. From this point onwards further initialization can be performed.

Specified by:

onAttached in interface Attachment

Overrides:

onAttached in class CartAttachment

onFocus

public void onFocus()

Description copied from interface: Attachment

Called when an attachment is focused in the editor or by other means. The attachment should try to change appearance to indicate it received focus.

onBlur

public void onBlur()

Description copied from interface: Attachment

Called when an attachment loses focus in the editor or by other means. The attachment should reset the appearance changes that were performed by Attachment.onFocus().

containsEntityId

public boolean containsEntityId(int entityId)

Description copied from interface: Attachment

Gets whether this attachment uses a particular Entity Id as part of displaying its contents in the world. This is used to identify what attachment was clicked by a player.

Specified by:

containsEntityId in interface Attachment

Overrides:

containsEntityId in class CartAttachment

Returns:

True if this attachment contains the entity Id

getMountEntityId

public int getMountEntityId()

Description copied from class: CartAttachment

Gets an Entity Id of an Entity other entities can mount to mount this attachment. Returns -1 if no mounting is possible.

Overrides:

getMountEntityId in class CartAttachment

Returns:

Mountable entity Id, or -1 if not mountable

applyDefaultSeatTransform

public void applyDefaultSeatTransform(com.bergerkiller.bukkit.common.math.Matrix4x4 transform)

Description copied from interface: Attachment

Some attachment types, like entities, will have a default position relative to it where the player is normally seated. Implement this method to specify exactly where the player sits on top of this attachment.

Parameters:

transform - to apply the transformation to. The input transform will be the current position of this attachment.

makeVisible

public void makeVisible(org.bukkit.entity.Player viewer)

Description copied from interface: Attachment

Makes this attachment visible to a viewer for the first time. This is automatically called for you after Attachment.onAttached() is called, and whenever a new viewer moves within range.

Parameters:

viewer - to make it visible to

makeHidden

public void makeHidden(org.bukkit.entity.Player viewer)

Description copied from interface: Attachment

Makes this attachment invisible (despawns) for a viewer. This is automatically called for you before Attachment.onDetached() is called, and whenever a new viewer moves out of range.

Parameters:

viewer - to hide it from

onTransformChanged

public void onTransformChanged(com.bergerkiller.bukkit.common.math.Matrix4x4 transform)

Description copied from interface: Attachment

Called right after the Attachment.getTransform() has been updated. Additional transformations can be performed here on the transformation matrix, and position information can be calculated.

Specified by:

onTransformChanged in interface Attachment

Overrides:

onTransformChanged in class CartAttachment

Parameters:

transform - (same as Attachment.getTransform() but mutable)

onMove

public void onMove(boolean absolute)

Description copied from interface: Attachment

Called every now and then to refresh the position of the attachment

Parameters:

absolute - whether this is an absolute (synchronize) movement update. If this is true, the position information should be refreshed.

onTick

public void onTick()

Description copied from interface: Attachment

Called every tick to update the attachment

isEntityTypeSupported

public static boolean isEntityTypeSupported(org.bukkit.entity.EntityType entityType)

Whether a particular entity type can be used at all in an entity attachment

Parameters:

entityType -

Returns:

True if supported