Attachment (TrainCarts 1.15.2-v2-SNAPSHOT API)

All Known Implementing Classes:

CartAttachment, CartAttachmentEmpty, CartAttachmentEntity, CartAttachmentItem, CartAttachmentLight, CartAttachmentModel, CartAttachmentPlatform, CartAttachmentPlatformOriginal, CartAttachmentSeat, CartAttachmentText
```
public interface Attachment
```
Controller object for attachments. This is added to the minecart and is updated regularly.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addAnimation(Animation animation)` Adds a new animation to this attachment, which can then be played again when specifying the name of the animation in the animation options.
`default void`	`addChild(Attachment child)` Adds a controller as a child of this one, which will have positions relative to this one.
`default 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.
`default void`	`clearAnimations()` Clears all animations stored for this attachment
`default boolean`	`containsEntityId(int entityId)` Gets whether this attachment uses a particular Entity Id as part of displaying its contents in the world.
`default Attachment`	`findChild(int[] targetPath)` Traverses down this tree of attachments based on the target path indices specified.
`default Collection<Animation>`	`getAnimations()` Gets a read-only collection of animations stored using `addAnimation(Animation)`.
`default List<Attachment>`	`getChildren()` Gets a list of children of this controller.
`default com.bergerkiller.bukkit.common.config.ConfigurationNode`	`getConfig()` Gets the configuration of this attachment.
`default ObjectPosition`	`getConfiguredPosition()` Gets the configured parent-relative object position of this attachment.
`default Animation`	`getCurrentAnimation()` Gets the animation that is currently playing.
`AttachmentInternalState`	`getInternalState()` Gets controller internal state information.
`default AttachmentManager`	`getManager()` Gets the attachment manager instance that initialized this attachment and oversees its interaction with the outside environment.
`default Attachment`	`getParent()` Gets the parent controller of this controller, if one is available.
`default com.bergerkiller.bukkit.common.math.Matrix4x4`	`getPreviousTransform()` Gets the transformation matrix that was applied to the entity in the previous tick (update).
`default com.bergerkiller.bukkit.common.math.Matrix4x4`	`getTransform()` Gets the transformation matrix that is currently applied to obtain the absolute world-coordinates position and rotation of this attachment.
`Collection<org.bukkit.entity.Player>`	`getViewers()` Gets all the viewers of this attachment
`default boolean`	`isActive()` Gets whether or not this attachment is active.
`default boolean`	`isAttached()` Gets whether this attachment has been attached.
`default boolean`	`isFocused()` Gets whether this attachment is focused.
`default boolean`	`isHiddenWhenInactive()` Gets whether this attachment is hidden ( `makeHidden(Player)` ) when the attachment or a parent attachment is inactive.
`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.
`default 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.
`default void`	`onFocus()` Called when an attachment is focused in the editor or by other means.
`void`	`onLoad(com.bergerkiller.bukkit.common.config.ConfigurationNode config)` Called when the attachment need to (re)load the configuration.
`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 `getTransform()` has been updated.
`default boolean`	`playNamedAnimation(AnimationOptions options)` Starts an animation for this attachment.
`default boolean`	`playNamedAnimation(String name)` Starts an animation for this attachment.
`default boolean`	`playNamedAnimationRecursive(AnimationOptions options)` Starts an animation for this attachment and all child attachments recursively.
`default boolean`	`playNamedAnimationRecursive(String name)` Starts a named animation for this attachment and all child attachments recursively.
`default void`	`setActive(boolean active)` Sets whether this attachment is active.
`default void`	`setFocused(boolean focused)` Sets whether this attachment is focused.
`default void`	`startAnimation(Animation animation)` Starts playing an animation for this attachment.
`default void`	`stopAnimation()` Stops the playback of any animations playing or queued right now.

- Method Detail
  - getInternalState
```
AttachmentInternalState getInternalState()
```
    Gets controller internal state information. Should return the same instance all the time. Internal use only.
    
    Returns:
    
    state information
  - getManager
```
default AttachmentManager getManager()
```
    Gets the attachment manager instance that initialized this attachment and oversees its interaction with the outside environment.
    
    Returns:
    
    attachment manager
  - getConfig
```
default com.bergerkiller.bukkit.common.config.ConfigurationNode getConfig()
```
    Gets the configuration of this attachment. This is automatically populated with the attachment's configuration before onAttached() is called. The configuration is mutable, and when properties of the attachment are changed, they should be updated in the configuration before or during onDetached().
    
    Returns:
    
    configuration
  - onAttached
```
void onAttached()
```
    Called when the controller is attached to the real world. From this point onwards further initialization can be performed.
  - onDetached
```
void onDetached()
```
    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.
  - onLoad
```
void onLoad(com.bergerkiller.bukkit.common.config.ConfigurationNode config)
```
    Called when the attachment need to (re)load the configuration. This method is called after 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.
    
    Parameters:
    
    config - The configuration of the attachment
  - onTick
```
void onTick()
```
    Called every tick to update the attachment
  - onTransformChanged
```
void onTransformChanged(com.bergerkiller.bukkit.common.math.Matrix4x4 transform)
```
    Called right after the getTransform() has been updated. Additional transformations can be performed here on the transformation matrix, and position information can be calculated.
    
    Parameters:
    
    transform - (same as getTransform() but mutable)
  - onMove
```
void onMove(boolean absolute)
```
    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.
  - isAttached
```
default boolean isAttached()
```
    Gets whether this attachment has been attached. This returns true if onAttached() was last called. It returns false if this was never called, or onDetached() was last called.
    
    Returns:
    
    True if this attachment has been attached
  - isFocused
```
default boolean isFocused()
```
    Gets whether this attachment is focused. This returns true if onFocus() was last called. It returns false if this was never called, or onBlur() was last called.
    
    Returns:
    
    True if this attachment receives focus
  - setFocused
```
default void setFocused(boolean focused)
```
    Sets whether this attachment is focused. This changes the isFocused() state, as well call the onFocus() or onBlur() callbacks as required.
    
    Parameters:
    
    focused - state to set to
  - onFocus
```
default void onFocus()
```
    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
```
default void onBlur()
```
    Called when an attachment loses focus in the editor or by other means. The attachment should reset the appearance changes that were performed by onFocus().
  - makeVisible
```
void makeVisible(org.bukkit.entity.Player viewer)
```
    Makes this attachment visible to a viewer for the first time. This is automatically called for you after onAttached() is called, and whenever a new viewer moves within range.
    
    Parameters:
    
    viewer - to make it visible to
  - makeHidden
```
void makeHidden(org.bukkit.entity.Player viewer)
```
    Makes this attachment invisible (despawns) for a viewer. This is automatically called for you before onDetached() is called, and whenever a new viewer moves out of range.
    
    Parameters:
    
    viewer - to hide it from
  - getConfiguredPosition
```
default ObjectPosition getConfiguredPosition()
```
    Gets the configured parent-relative object position of this attachment.
    
    Returns:
    
    object position
  - getPreviousTransform
```
default com.bergerkiller.bukkit.common.math.Matrix4x4 getPreviousTransform()
```
    Gets the transformation matrix that was applied to the entity in the previous tick (update). See getTransform().
    
    Returns:
    
    previous tick transformation matrix
  - getTransform
```
default com.bergerkiller.bukkit.common.math.Matrix4x4 getTransform()
```
    Gets the transformation matrix that is currently applied to obtain the absolute world-coordinates position and rotation of this attachment.
    
    Returns:
    
    transformation matrix
  - addChild
```
default void addChild(Attachment child)
```
    Adds a controller as a child of this one, which will have positions relative to this one.
    
    Parameters:
    
    child - controller to add
  - getChildren
```
default List<Attachment> getChildren()
```
    Gets a list of children of this controller. The order should stay unique when children are added.
    
    Returns:
    
    children
  - getParent
```
default Attachment getParent()
```
    Gets the parent controller of this controller, if one is available.
    
    Returns:
    
    parent controller
  - getViewers
```
Collection<org.bukkit.entity.Player> getViewers()
```
    Gets all the viewers of this attachment
    
    Returns:
    
    viewers
  - isHiddenWhenInactive
```
default boolean isHiddenWhenInactive()
```
    Gets whether this attachment is hidden ( makeHidden(Player) ) when the attachment or a parent attachment is inactive.
    
    Returns:
    
    True if hidden when inactive, False if not
  - isActive
```
default boolean isActive()
```
    Gets whether or not this attachment is active. See setActive(boolean).
    
    Returns:
    
    True if active, False if not.
  - setActive
```
default void setActive(boolean active)
```
    Sets whether this attachment is active. If active, it is displayed and updated to the players. If it is inactive, the attachment and all child attachments are hidden.
    
    Parameters:
    
    active - state
  - applyDefaultSeatTransform
```
default 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. 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.
  - addAnimation
```
default void addAnimation(Animation animation)
```
    Adds a new animation to this attachment, which can then be played again when specifying the name of the animation in the animation options.
    
    Parameters:
    
    animation - to add
  - getAnimations
```
default Collection<Animation> getAnimations()
```
    Gets a read-only collection of animations stored using addAnimation(Animation).
    
    Returns:
    
    animations stored
  - clearAnimations
```
default void clearAnimations()
```
    Clears all animations stored for this attachment
  - getCurrentAnimation
```
default Animation getCurrentAnimation()
```
    Gets the animation that is currently playing. Null if no animation is playing.
    
    Returns:
    
    current animation
  - stopAnimation
```
default void stopAnimation()
```
    Stops the playback of any animations playing or queued right now.
  - startAnimation
```
default void startAnimation(Animation animation)
```
    Starts playing an animation for this attachment. The child attachments are not affected. If the animation is already playing, this function does nothing. To force a reset, call stopAnimation() prior.
    
    Parameters:
    
    animation - to start
  - containsEntityId
```
default boolean containsEntityId(int entityId)
```
    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.
    
    Parameters:
    
    entityId -
    
    Returns:
    
    True if this attachment contains the entity Id
  - playNamedAnimationRecursive
```
default boolean playNamedAnimationRecursive(String name)
```
    Starts a named animation for this attachment and all child attachments recursively. If the animation exists in this attachments or one of its nested children, then the animation will play there and this method will return true.
    
    Parameters:
    
    name - of the animation
    
    Returns:
    
    True if an animation was found and started
  - playNamedAnimationRecursive
```
default boolean playNamedAnimationRecursive(AnimationOptions options)
```
    Starts an animation for this attachment and all child attachments recursively. If the animation exists in this attachments or one of its nested children, then the animation will play there and this method will return true.
    
    Parameters:
    
    options - that specify the animation and animation configuration
    
    Returns:
    
    True if an animation was found and started
  - playNamedAnimation
```
default boolean playNamedAnimation(String name)
```
    Starts an animation for this attachment. Only if the animation exists for this attachment, will it be played.
    
    Parameters:
    
    name - of the animation
    
    Returns:
    
    True if an animation was found and started
  - playNamedAnimation
```
default boolean playNamedAnimation(AnimationOptions options)
```
    Starts an animation for this attachment. Only if the animation exists for this attachment, will it be played.
    
    Parameters:
    
    options - that specify the animation and animation configuration
    
    Returns:
    
    True if an animation was found and started
  - findChild
```
default Attachment findChild(int[] targetPath)
```
    Traverses down this tree of attachments based on the target path indices specified. If the attachment at this path exists, it is returned, otherwise this method returns null.
    
    Parameters:
    
    targetPath -
    
    Returns:
    
    attachment at targetPath, null if not found.

Interface Attachment

Method Summary

Method Detail

getInternalState

getManager

getConfig

onAttached

onDetached

onLoad

onTick

onTransformChanged

onMove

isAttached

isFocused

setFocused

onFocus

onBlur

makeVisible

makeHidden

getConfiguredPosition

getPreviousTransform

getTransform

addChild

getChildren

getParent

getViewers

isHiddenWhenInactive

isActive

setActive

applyDefaultSeatTransform

addAnimation

getAnimations

clearAnimations

getCurrentAnimation

stopAnimation

startAnimation

containsEntityId

playNamedAnimationRecursive

playNamedAnimationRecursive

playNamedAnimation

playNamedAnimation

findChild