io.github.bananapuncher714.radioboard

Class BoardFrame

java.lang.Object

io.github.bananapuncher714.radioboard.BoardFrame

public class BoardFrame
extends java.lang.Object

A Minecraft-world wall of maps for virtual displays

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
BoardFrame(org.bukkit.entity.ItemFrame frame, int id) Given an item frame and a map id, construct a new board

Method Summary

Modifier and Type	Method and Description
org.bukkit.block.BlockFace	getFace() Gets the inverse face of the board
java.util.List<java.util.UUID>	getFrames() Gets a list of all the item frames in this board
int	getHeight() Gets the height in map lengths of this board
int	getId() Gets the map id of the top left frame
org.bukkit.entity.ItemFrame	getItemFrameAt(org.bukkit.Location location) Get an item frame at a given location
org.bukkit.Location	getTopLeftCorner() Gets the location of the top left item frame
int	getWidth() Gets the width in map lengths of this board
boolean	isPartOfBoard(org.bukkit.Location location) Tests whether a location is within the rectangle of the board
void	terminate() Remove all the item frames of this board

Methods inherited from class java.lang.Object

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

Constructor Detail

BoardFrame

public BoardFrame(org.bukkit.entity.ItemFrame frame,
                  int id)

Given an item frame and a map id, construct a new board

Parameters:

frame - Any frame on a wall with the same material behind it

id - The id of the top left map

Method Detail

getFace

public org.bukkit.block.BlockFace getFace()

Gets the inverse face of the board

Returns:

getTopLeftCorner

public org.bukkit.Location getTopLeftCorner()

Gets the location of the top left item frame

Returns:

getId

public int getId()

Gets the map id of the top left frame

Returns:

getWidth

public int getWidth()

Gets the width in map lengths of this board

Returns:

getHeight

public int getHeight()

Gets the height in map lengths of this board

Returns:

getFrames

public java.util.List<java.util.UUID> getFrames()

Gets a list of all the item frames in this board

Returns:

getItemFrameAt

public org.bukkit.entity.ItemFrame getItemFrameAt(org.bukkit.Location location)

Get an item frame at a given location

Parameters:

location - The location should be part of the board

Returns:

A frame that belongs to this board, or null

isPartOfBoard

public boolean isPartOfBoard(org.bukkit.Location location)

Tests whether a location is within the rectangle of the board

Parameters:

location - Location to test

Returns:

If it falls within the edges of the board

terminate

public void terminate()

Remove all the item frames of this board