team.unnamed.creative.font

Interface Font

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed, ResourcePackPart

@ApiStatus.NonExtendable
public interface Font
extends ResourcePackPart, net.kyori.adventure.key.Keyed, net.kyori.examination.Examinable

Represents a resource-pack font.

A font is composed by a font providers, providers are the responsible for mapping characters to their respective character texture.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Font.Builder A builder for Font instances.

Field Summary

Fields

Modifier and Type	Field and Description
static net.kyori.adventure.key.Key	MINECRAFT_ALT
static net.kyori.adventure.key.Key	MINECRAFT_DEFAULT
static net.kyori.adventure.key.Key	MINECRAFT_ILLAGERALT
static net.kyori.adventure.key.Key	MINECRAFT_UNIFORM

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this font to the given resource container.
static @NotNull Font.Builder	font() Creates a new builder for Font instances.
static @NotNull Font	font(@NotNull net.kyori.adventure.key.Key key, FontProvider... providers) Creates a new Font instance from the given providers
static @NotNull Font	font(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.List<FontProvider> providers) Creates a new Font instance from the given provider list.
@NotNull net.kyori.adventure.key.Key	key() Returns the font key.
@NotNull Font	key(@NotNull net.kyori.adventure.key.Key key) Returns an updated Font instance with the given key.
static @NotNull Font	of(@NotNull net.kyori.adventure.key.Key key, FontProvider... providers) Deprecated. Use font(net.kyori.adventure.key.Key, java.util.List<team.unnamed.creative.font.FontProvider>) as it is better for static imports
static @NotNull Font	of(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.List<FontProvider> providers) Deprecated. Use font(net.kyori.adventure.key.Key, java.util.List<team.unnamed.creative.font.FontProvider>) as it is better for static imports
@NotNull java.util.List<FontProvider>	providers() Returns a list of font providers that are merged onto this font
@NotNull Font	providers(@NotNull java.util.List<FontProvider> providers) Returns an updated Font instance with the given providers.
default @NotNull Font.Builder	toBuilder() Returns a new Font.Builder instance with the same values as this font.

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

MINECRAFT_DEFAULT

static final net.kyori.adventure.key.Key MINECRAFT_DEFAULT

MINECRAFT_ALT

static final net.kyori.adventure.key.Key MINECRAFT_ALT

MINECRAFT_ILLAGERALT

static final net.kyori.adventure.key.Key MINECRAFT_ILLAGERALT

MINECRAFT_UNIFORM

static final net.kyori.adventure.key.Key MINECRAFT_UNIFORM

Method Detail

font

@NotNull
static @NotNull Font font(@NotNull
                                    @NotNull net.kyori.adventure.key.Key key,
                                    @NotNull
                                    @NotNull java.util.List<FontProvider> providers)

Creates a new Font instance from the given provider list.

Parameters:

key - The font key

providers - The font providers

Returns:

A new Font instance

Since:

1.1.0

font

@NotNull
static @NotNull Font font(@NotNull
                                    @NotNull net.kyori.adventure.key.Key key,
                                    @NotNull
                                    FontProvider... providers)

Creates a new Font instance from the given providers

Parameters:

key - The font key

providers - The font providers

Returns:

A new Font instance

Since:

1.1.0

font

@NotNull
static @NotNull Font.Builder font()

Creates a new builder for Font instances.

Returns:

The created builder

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Font of(@NotNull
                                                                                                    @NotNull net.kyori.adventure.key.Key key,
                                                                                                    @NotNull
                                                                                                    @NotNull java.util.List<FontProvider> providers)

Deprecated. Use font(net.kyori.adventure.key.Key, java.util.List<team.unnamed.creative.font.FontProvider>) as it is better for static imports

Creates a new Font instance from the given provider list

Parameters:

key - The font key

providers - The font providers

Returns:

A new Font instance

Since:

1.0.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Font of(@NotNull
                                                                                                    @NotNull net.kyori.adventure.key.Key key,
                                                                                                    @NotNull
                                                                                                    FontProvider... providers)

Deprecated. Use font(net.kyori.adventure.key.Key, java.util.List<team.unnamed.creative.font.FontProvider>) as it is better for static imports

Creates a new Font instance from the given providers

Parameters:

key - The font key

providers - The font providers

Returns:

A new Font instance

Since:

1.0.0

key

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

Returns the font key.

Specified by:

key in interface net.kyori.adventure.key.Keyed

Returns:

The font key

Since:

1.0.0

key

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

Returns an updated Font instance with the given key.

Parameters:

key - The font key

Returns:

An updated Font instance

Since:

1.1.0

providers

@NotNull
@NotNull java.util.List<FontProvider> providers()

Returns a list of font providers that are merged onto this font

Returns:

The font providers

Since:

1.0.0

providers

@Contract(value="_ -> new",
          pure=true)
 @NotNull
@NotNull Font providers(@NotNull
                                                                                      @NotNull java.util.List<FontProvider> providers)

Returns an updated Font instance with the given providers.

Parameters:

providers - The font providers

Returns:

An updated Font instance

Since:

1.1.0

toBuilder

@NotNull
default @NotNull Font.Builder toBuilder()

Returns a new Font.Builder instance with the same values as this font.

Returns:

A new Font.Builder instance

Since:

1.1.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this font to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0