team.unnamed.creative.font

Interface FontProvider

All Superinterfaces:

net.kyori.examination.Examinable

All Known Subinterfaces:

BitMapFontProvider, ReferenceFontProvider, UnihexFontProvider

All Known Implementing Classes:

LegacyUnicodeFontProvider, SpaceFontProvider, TrueTypeFontProvider

public interface FontProvider
extends net.kyori.examination.Examinable

Represents a Minecraft Resource Pack Font provider, a part of a Font

Since:

1.0.0

See Also:

Font

Method Summary

Modifier and Type	Method and Description
static BitMapFontProvider.Builder	bitMap() Static factory method for BitMapFontProvider builder implementation
static @NotNull BitMapFontProvider	bitMap(@NotNull net.kyori.adventure.key.Key file, int height, int ascent, @NotNull java.util.List<java.lang.String> characters) Creates a new bit-map font from the provided values
static LegacyUnicodeFontProvider	legacyUnicode(net.kyori.adventure.key.Key sizes, java.lang.String template) Deprecated. Removed on Minecraft 1.20
static @NotNull ReferenceFontProvider	reference(@NotNull Font font) Creates a new ReferenceFontProvider instance that references another font specified by the given font.
static @NotNull ReferenceFontProvider	reference(@NotNull net.kyori.adventure.key.Key id) Creates a new ReferenceFontProvider instance that references another font specified by the given id, which is the font key.
static SpaceFontProvider.Builder	space() Creates a new SpaceFontProvider builder This font provider consists of a map of codepoints (characters) and integers (how many pixels to shift by) If a character is used in a space font provider, it is not rendered, and is instead used as spacing.
static SpaceFontProvider	space(java.util.Map<java.lang.String,java.lang.Integer> advances) Creates a new SpaceFontProvider instance from provided arguments This font provider consists of a map of codepoints (characters) and integers (how many pixels to shift by) If a character is used in a space font provider, it is not rendered, and is instead used as spacing.
static TrueTypeFontProvider.Builder	trueType() Static factory method for TrueTypeFontProvider builder implementation
static UnihexFontProvider.Builder	unihex() Creates a new builder for UnihexFontProvider instances
static @NotNull UnihexFontProvider	unihex(@NotNull net.kyori.adventure.key.Key file, @NotNull java.util.List<UnihexFontProvider.SizeOverride> sizes) Creates a new instance of UnihexFontProvider

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

bitMap

@Contract(value="_, _, _, _ -> new")
 @NotNull
static @NotNull BitMapFontProvider bitMap(@NotNull
                                                                                           @NotNull net.kyori.adventure.key.Key file,
                                                                                           int height,
                                                                                           int ascent,
                                                                                           @NotNull
                                                                                           @NotNull java.util.List<java.lang.String> characters)

Creates a new bit-map font from the provided values

Parameters:

file - The bit-map texture location in PNG format

height - The characters height

ascent - The characters ascent

characters - The characters string

Returns:

A new bit-map font

Since:

1.0.0

bitMap

@Contract(value="-> new")
static BitMapFontProvider.Builder bitMap()

Static factory method for BitMapFontProvider builder implementation

Returns:

A new builder for BitMapFontProvider instances

Since:

1.0.0

legacyUnicode

@Deprecated
static LegacyUnicodeFontProvider legacyUnicode(net.kyori.adventure.key.Key sizes,
                                                            java.lang.String template)

Deprecated. Removed on Minecraft 1.20

Creates a new legacy unicode font from the provided values, this font type should not be used since it is deprecated (now removed since Minecraft 1.20) and is only prioritized when the "Force Unicode Font" option is turned on

Parameters:

sizes - Location to the file that specifies the character sizes

template - Location of the file that specifies the character textures, it is a string template and MUST contain a single '%s' that will be replaced by the unicode page

Returns:

A new LegacyUnicodeFontProvider font

Since:

1.0.0

space

static SpaceFontProvider.Builder space()

Creates a new SpaceFontProvider builder This font provider consists of a map of codepoints (characters) and integers (how many pixels to shift by) If a character is used in a space font provider, it is not rendered, and is instead used as spacing. You can not shift vertically with this font provider, for vertical offsets use BitMapFontProvider

Returns:

the newly created builder

Since Resource-Pack Format:

9

space

static SpaceFontProvider space(java.util.Map<java.lang.String,java.lang.Integer> advances)

Creates a new SpaceFontProvider instance from provided arguments This font provider consists of a map of codepoints (characters) and integers (how many pixels to shift by) If a character is used in a space font provider, it is not rendered, and is instead used as spacing. You can not shift vertically with this font provider, for vertical offsets use BitMapFontProvider

Returns:

the newly created builder

Since Resource-Pack Format:

9

trueType

static TrueTypeFontProvider.Builder trueType()

Static factory method for TrueTypeFontProvider builder implementation

Returns:

A new builder for TrueTypeFontProvider instances

Since:

1.0.0

reference

@NotNull
static @NotNull ReferenceFontProvider reference(@NotNull
                                                          @NotNull net.kyori.adventure.key.Key id)

Creates a new ReferenceFontProvider instance that references another font specified by the given id, which is the font key.

Parameters:

id - The referenced font key

Returns:

A new instance of ReferenceFontProvider

Since:

1.0.0

Since Minecraft:

1.20

Since Resource-Pack Format:

15

reference

@NotNull
static @NotNull ReferenceFontProvider reference(@NotNull
                                                          @NotNull Font font)

Creates a new ReferenceFontProvider instance that references another font specified by the given font.

Parameters:

font - The referenced font

Returns:

A new instance of ReferenceFontProvider

Since:

1.2.0

Since Minecraft:

1.20

Since Resource-Pack Format:

15

unihex

@Contract(value="_, _ -> new")
 @NotNull
static @NotNull UnihexFontProvider unihex(@NotNull
                                                                                     @NotNull net.kyori.adventure.key.Key file,
                                                                                     @NotNull
                                                                                     @NotNull java.util.List<UnihexFontProvider.SizeOverride> sizes)

Creates a new instance of UnihexFontProvider

Parameters:

file - The zip file containing the HEX files

sizes - The size overrides

Returns:

A new font provider instance

Since:

1.0.0

Since Minecraft:

1.20

Since Resource-Pack Format:

15

unihex

@Contract(value="-> new")
 @NotNull
static UnihexFontProvider.Builder unihex()

Creates a new builder for UnihexFontProvider instances

Returns:

A new builder instance

Since:

1.0.0

Since Minecraft:

1.20

Since Resource-Pack Format:

15