team.unnamed.creative.font

Interface BitMapFontProvider

All Superinterfaces:

net.kyori.examination.Examinable, FontProvider

@ApiStatus.NonExtendable
public interface BitMapFontProvider
extends FontProvider

Represents a bitmap font (font that uses a set of string characters and PNG images to render) for Minecraft resource packs

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BitMapFontProvider.Builder Mutable and fluent-style builder for BitMapFontProvider instances

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Default bitmap font height

Method Summary

Modifier and Type	Method and Description
int	ascent() Returns the font characters ascent, measured in pixels, this value as a vertical shift to displayed result
@NotNull BitMapFontProvider	ascent(int ascent) Returns a new bitmap font with the given ascent
@Unmodifiable @NotNull java.util.List<java.lang.String>	characters() Returns a list of strings containing the characters replaced by this provider, as well as their order within the texture.
@NotNull BitMapFontProvider	characters(@NotNull java.util.List<java.lang.String> characters) Returns a new bitmap font with the given characters
@NotNull net.kyori.adventure.key.Key	file() Returns the texture location of this bitmap font, must be a PNG image
@NotNull BitMapFontProvider	file(@NotNull net.kyori.adventure.key.Key file) Returns a new bitmap font with the given texture location
int	height() Returns the height of the character, measured in pixels.
@NotNull BitMapFontProvider	height(int height) Returns a new bitmap font with the given height
default BitMapFontProvider.Builder	toBuilder() Converts this BitMapFontProvider instance to a BitMapFontProvider.Builder instance with the same values as this font provider.

Methods inherited from interface team.unnamed.creative.font.FontProvider

bitMap, bitMap, legacyUnicode, reference, reference, space, space, trueType, unihex, unihex

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT

Default bitmap font height

See Also:

Constant Field Values

Method Detail

file

@NotNull
@NotNull net.kyori.adventure.key.Key file()

Returns the texture location of this bitmap font, must be a PNG image

Returns:

The font texture

Since:

1.0.0

file

@Contract(value="_ -> new",
          pure=true)
 @NotNull
@NotNull BitMapFontProvider file(@NotNull
                                                                                               @NotNull net.kyori.adventure.key.Key file)

Returns a new bitmap font with the given texture location

Parameters:

file - The new texture location

Returns:

A new bitmap font

Since:

1.0.0

height

int height()

Returns the height of the character, measured in pixels. Can be negative. This tag is separate from the area used in the source texture and just rescales the displayed result

Returns:

The font characters height

Since:

1.0.0

height

@Contract(value="_ -> new",
          pure=true)
 @NotNull
@NotNull BitMapFontProvider height(int height)

Returns a new bitmap font with the given height

Parameters:

height - The new height

Returns:

A new bitmap font

Since:

1.0.0

ascent

int ascent()

Returns the font characters ascent, measured in pixels, this value as a vertical shift to displayed result

Returns:

The font characters ascent

Since:

1.0.0

ascent

@Contract(value="_ -> new",
          pure=true)
 @NotNull
@NotNull BitMapFontProvider ascent(int ascent)

Returns a new bitmap font with the given ascent

Parameters:

ascent - The new ascent

Returns:

A new bitmap font

Since:

1.0.0

characters

@NotNull
@Unmodifiable @NotNull java.util.List<java.lang.String> characters()

Returns a list of strings containing the characters replaced by this provider, as well as their order within the texture. All elements must describe the same number of characters. The texture is split into one equally sized row for each element of this list. Each row is split into one equally sized character for each character within one list element.

Returns:

The font characters

Since:

1.0.0

characters

@Contract(value="_ -> new",
          pure=true)
 @NotNull
@NotNull BitMapFontProvider characters(@NotNull
                                                                                                     @NotNull java.util.List<java.lang.String> characters)

Returns a new bitmap font with the given characters

Parameters:

characters - The new characters

Returns:

A new bitmap font

Since:

1.0.0

toBuilder

@Contract(value="-> new")
 @NotNull
default BitMapFontProvider.Builder toBuilder()

Converts this BitMapFontProvider instance to a BitMapFontProvider.Builder instance with the same values as this font provider.

Returns:

A new builder with the same values as this font provider

Since:

1.0.0