org.bukkit.entity.Painting Maven / Gradle / Ivy

Go to download
package org.bukkit.entity;

import org.bukkit.Art;
import org.bukkit.event.painting.PaintingBreakEvent;

/**
 * Represents a Painting.
 */
public interface Painting extends Hanging {

  /**
   * Get the art on this painting
   *
   * @return The art
   */
  Art getArt();

  /**
   * Set the art on this painting
   *
   * @param art The new art
   * @return False if the new art won't fit at the painting's current
   * location
   */
  boolean setArt(Art art);

  /**
   * Set the art on this painting
   *
   * @param art   The new art
   * @param force If true, force the new art regardless of whether it fits
   *              at the current location. Note that forcing it where it can't fit
   *              normally causes it to drop as an item unless you override this by
   *              catching the {@link PaintingBreakEvent}.
   * @return False if force was false and the new art won't fit at the
   * painting's current location
   */
  boolean setArt(Art art, boolean force);
}