team.unnamed.creative.font

Class TrueTypeFontProvider

java.lang.Object

team.unnamed.creative.font.TrueTypeFontProvider

All Implemented Interfaces:

net.kyori.examination.Examinable, FontProvider

public class TrueTypeFontProvider
extends java.lang.Object
implements FontProvider

A FontProvider implementation that uses fonts with the True Type Font format

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrueTypeFontProvider.Builder Mutable and fluent-style builder for TrueTypeFontProvider instances

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_OVERSAMPLE
static float	DEFAULT_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TrueTypeFontProvider(net.kyori.adventure.key.Key file, Vector2Float shift, float size, float oversample, java.util.List<java.lang.String> skip)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
net.kyori.adventure.key.Key	file() Returns the resource location of the TrueType font file within assets/<namespace>/font
int	hashCode()
float	oversample() Returns the resolution to render at
Vector2Float	shift() Returns the distance by which the characters of this provider are shifted.
float	size() Returns the font size to render at
@Unmodifiable java.util.List<java.lang.String>	skip() Returns an unmodifiable list of strings to exclude
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, examine

Field Detail

DEFAULT_SIZE

public static final float DEFAULT_SIZE

See Also:

Constant Field Values

DEFAULT_OVERSAMPLE

public static final float DEFAULT_OVERSAMPLE

See Also:

Constant Field Values

Constructor Detail

TrueTypeFontProvider

protected TrueTypeFontProvider(net.kyori.adventure.key.Key file,
                               Vector2Float shift,
                               float size,
                               float oversample,
                               java.util.List<java.lang.String> skip)

Method Detail

file

public net.kyori.adventure.key.Key file()

Returns the resource location of the TrueType font file within assets/<namespace>/font

Returns:

The True Type Font file location

shift

public Vector2Float shift()

Returns the distance by which the characters of this provider are shifted. X: Left shift, Y: Downwards shift

Returns:

The characters shift

size

public float size()

Returns the font size to render at

Returns:

The font size

oversample

public float oversample()

Returns the resolution to render at

Returns:

The font resolution

skip

public @Unmodifiable java.util.List<java.lang.String> skip()

Returns an unmodifiable list of strings to exclude

Returns:

The excluded characters

examinableProperties

@NotNull
public @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object