com.bergerkiller.bukkit.common.map

Class MapFont<K>

java.lang.Object

com.bergerkiller.bukkit.common.map.MapFont<K>

Type Parameters:

K - key type

Direct Known Subclasses:

MapTinyFont

public abstract class MapFont<K>
extends Object

A generic Map Font type that binds sprite characters to value keys. For text, the bound key would be a Character. This also enables fonts mapped to, for example, materials or other tokens such as player names.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapFont.Alignment The alignment of the characters when drawn on a canvas

Field Summary

Fields

Modifier and Type	Field and Description
static MapFont<Character>	MINECRAFT Standard Minecraft font (5x7), only supports standard ASCII characters
static MapFont<Character>	TINY Tiny font (3x5), only supports standard ASCII characters

Constructor Summary

Constructors

Constructor and Description
MapFont()

Method Summary

Modifier and Type	Method and Description
static MapFont<Character>	fromBukkitFont(org.bukkit.map.MapFont font) Creates a new font from a bukkit map font
static MapFont<Character>	fromJavaFont(Font font) Creates a new font from a system Java AWT font
static MapFont<Character>	fromJavaFont(String name, int size) Creates a new font from a system Java AWT font from a family name and size.
static MapFont<Character>	fromJavaFont(String name, int style, int size) Creates a new font from a system Java AWT font from a family name, font style and size.
MapTexture	getSprite(K key) Retrieves the sprite texture mapped to a certain key
boolean	isNewline(K key) Gets whether a particular key acts as a newline character.
protected MapTexture	loadNullSprite() Loads the sprite texture for null keys.
protected abstract MapTexture	loadSprite(K key) Loads the sprite texture for a given key.
void	reload() Resets the sprite cache, requiring a reload of all sprites upon first use

Methods inherited from class java.lang.Object

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

Field Detail

MINECRAFT

public static final MapFont<Character> MINECRAFT

Standard Minecraft font (5x7), only supports standard ASCII characters

TINY

public static final MapFont<Character> TINY

Tiny font (3x5), only supports standard ASCII characters

Constructor Detail

MapFont

public MapFont()

Method Detail

loadSprite

protected abstract MapTexture loadSprite(K key)

Loads the sprite texture for a given key. Called only once upon the first time of use. The key is guaranteed to never be null.

Parameters:

key - to get the sprite for

Returns:

texture

loadNullSprite

protected MapTexture loadNullSprite()

Loads the sprite texture for null keys. Called only once upon the first time of use. Default implementation returns an empty texture.

Returns:

Null texture sprite.

getSprite

public final MapTexture getSprite(K key)

Retrieves the sprite texture mapped to a certain key

Parameters:

key - texture is bound to

Returns:

texture

isNewline

public boolean isNewline(K key)

Gets whether a particular key acts as a newline character. Newline character are now drawn, and instead bump the y coordinate down by the height of the previous line.

Parameters:

key - to check

Returns:

True if the key acts as a newline character

reload

public void reload()

Resets the sprite cache, requiring a reload of all sprites upon first use

fromBukkitFont

public static MapFont<Character> fromBukkitFont(org.bukkit.map.MapFont font)

Creates a new font from a bukkit map font

Parameters:

font - to convert

Returns:

font

fromJavaFont

public static MapFont<Character> fromJavaFont(Font font)

Creates a new font from a system Java AWT font

Parameters:

font - to convert

Returns:

font

fromJavaFont

public static MapFont<Character> fromJavaFont(String name,
                                              int style,
                                              int size)

Creates a new font from a system Java AWT font from a family name, font style and size.

Parameters:

name - of the font

style - of the font

size - of the font

Returns:

font

fromJavaFont

public static MapFont<Character> fromJavaFont(String name,
                                              int size)

Creates a new font from a system Java AWT font from a family name and size. Standard font style is used.

Parameters:

name - of the font

size - of the font

Returns:

font