com.bergerkiller.bukkit.tc.attachments.control

Class CartAttachment

java.lang.Object

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

All Implemented Interfaces:

Attachment

Direct Known Subclasses:

CartAttachmentEmpty, CartAttachmentEntity, CartAttachmentItem, CartAttachmentLight, CartAttachmentModel, CartAttachmentPlatform, CartAttachmentPlatformOriginal, CartAttachmentSeat, CartAttachmentText

public abstract class CartAttachment
extends Object
implements Attachment

Constructor Summary

Constructors

Constructor and Description
CartAttachment()

Method Summary

Modifier and Type	Method and Description
boolean	containsEntityId(int entityId) Gets whether this attachment uses a particular Entity Id as part of displaying its contents in the world.
MinecartMemberNetwork	getController() Gets the network controller that owns and manages this attachment
AttachmentInternalState	getInternalState() Gets controller internal state information.
int	getMountEntityId() Gets an Entity Id of an Entity other entities can mount to mount this attachment.
Collection<org.bukkit.entity.Player>	getViewers() Gets all the viewers of this attachment
void	onAttached() Called when the controller is attached to the real world.
void	onDetached() Called when the controller is detached from the real world.
void	onLoad(com.bergerkiller.bukkit.common.config.ConfigurationNode config) Called when the attachment need to (re)load the configuration.
void	onTransformChanged(com.bergerkiller.bukkit.common.math.Matrix4x4 transform) Called right after the Attachment.getTransform() has been updated.
static void	registerDefaultAttachments() Register all default TrainCarts attachment types
protected void	updateGlowColor(UUID entityUUID, org.bukkit.ChatColor color)
protected void	updateGlowColorFor(UUID entityUUID, org.bukkit.ChatColor color, org.bukkit.entity.Player viewer)

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, applyDefaultSeatTransform, clearAnimations, findChild, getAnimations, getChildren, getConfig, getConfiguredPosition, getCurrentAnimation, getManager, getParent, getPreviousTransform, getTransform, isActive, isAttached, isFocused, isHiddenWhenInactive, makeHidden, makeVisible, onBlur, onFocus, onMove, onTick, playNamedAnimation, playNamedAnimation, playNamedAnimationRecursive, playNamedAnimationRecursive, setActive, setFocused, startAnimation, stopAnimation

Constructor Detail

CartAttachment

public CartAttachment()

Method Detail

getInternalState

public AttachmentInternalState getInternalState()

Description copied from interface: Attachment

Gets controller internal state information. Should return the same instance all the time. Internal use only.

Specified by:

getInternalState in interface Attachment

Returns:

state information

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

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

onLoad

public void onLoad(com.bergerkiller.bukkit.common.config.ConfigurationNode config)

Description copied from interface: Attachment

Called when the attachment need to (re)load the configuration. This method is called after Attachment.onAttached() is called for the first time, and when configuration is reloaded while the attachment remains attached. A guarantee is made that the attachment will be attached when this method is called.

Specified by:

onLoad in interface Attachment

Parameters:

config - The configuration of the attachment

getViewers

public Collection<org.bukkit.entity.Player> getViewers()

Description copied from interface: Attachment

Gets all the viewers of this attachment

Specified by:

getViewers in interface Attachment

Returns:

viewers

getController

public MinecartMemberNetwork getController()

Gets the network controller that owns and manages this attachment

Returns:

controller

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

Returns:

True if this attachment contains the entity Id

getMountEntityId

public int getMountEntityId()

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

Returns:

Mountable entity Id, or -1 if not mountable

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

Parameters:

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

updateGlowColorFor

protected void updateGlowColorFor(UUID entityUUID,
                                  org.bukkit.ChatColor color,
                                  org.bukkit.entity.Player viewer)

updateGlowColor

protected void updateGlowColor(UUID entityUUID,
                               org.bukkit.ChatColor color)

registerDefaultAttachments

public static void registerDefaultAttachments()

Register all default TrainCarts attachment types