88 lines
2.2 KiB
Java
88 lines
2.2 KiB
Java
package org.bukkit.entity;
|
|
|
|
import org.bukkit.Rotation;
|
|
import org.bukkit.inventory.ItemStack;
|
|
import org.jetbrains.annotations.NotNull;
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
/**
|
|
* Represents an Item Frame
|
|
*/
|
|
public interface ItemFrame extends Hanging {
|
|
|
|
/**
|
|
* Get the item in this frame
|
|
*
|
|
* @return a defensive copy the item in this item frame
|
|
*/
|
|
@NotNull
|
|
public ItemStack getItem();
|
|
|
|
/**
|
|
* Set the item in this frame
|
|
*
|
|
* @param item the new item
|
|
*/
|
|
public void setItem(@Nullable ItemStack item);
|
|
|
|
/**
|
|
* Set the item in this frame
|
|
*
|
|
* @param item the new item
|
|
* @param playSound whether or not to play the item placement sound
|
|
*/
|
|
public void setItem(@Nullable ItemStack item, boolean playSound);
|
|
|
|
/**
|
|
* Get the rotation of the frame's item
|
|
*
|
|
* @return the direction
|
|
*/
|
|
@NotNull
|
|
public Rotation getRotation();
|
|
|
|
/**
|
|
* Set the rotation of the frame's item
|
|
*
|
|
* @param rotation the new rotation
|
|
* @throws IllegalArgumentException if rotation is null
|
|
*/
|
|
public void setRotation(@NotNull Rotation rotation) throws IllegalArgumentException;
|
|
|
|
/**
|
|
* Returns whether the item frame is be visible or not.
|
|
*
|
|
* @return whether the item frame is visible or not
|
|
*/
|
|
boolean isVisible();
|
|
|
|
/**
|
|
* Sets whether the item frame should be visible or not.
|
|
*
|
|
* @param visible whether the item frame is visible or not
|
|
*/
|
|
void setVisible(boolean visible);
|
|
|
|
/**
|
|
* Returns whether the item frame is "fixed" or not.
|
|
*
|
|
* When true it's not possible to destroy/move the frame (e.g. by damage,
|
|
* interaction, pistons, or missing supporting blocks), rotate the item or
|
|
* place/remove items.
|
|
*
|
|
* @return whether the item frame is fixed or not
|
|
*/
|
|
boolean isFixed();
|
|
|
|
/**
|
|
* Sets whether the item frame should be fixed or not.
|
|
*
|
|
* When set to true it's not possible to destroy/move the frame (e.g. by
|
|
* damage, interaction, pistons, or missing supporting blocks), rotate the
|
|
* item or place/remove items.
|
|
*
|
|
* @param visible whether the item frame is fixed or not
|
|
*/
|
|
void setFixed(boolean visible);
|
|
}
|