easel.utils

Class BitmapFontBuilder

java.lang.Object

easel.utils.BitmapFontBuilder

public class BitmapFontBuilder
extends java.lang.Object

A builder for making font creation a bit more convenient. The default settings attempt to mimic the tipBodyFont from the base game, and you can alter individual pieces of it without needing to worry about changing the entire thing. Fonts should be built in a post-initialize hook from BaseMod and then stored statically somewhere for access. Easel comes built with a few custom fonts already, e.g. EaselFonts.SMALLER_TIP_BODY, whose constructions use this builder if you're looking for examples of use.

Constructor Summary

Constructors

Constructor and Description
BitmapFontBuilder()

Method Summary

Modifier and Type	Method and Description
com.badlogic.gdx.graphics.g2d.BitmapFont	build() Constructs the final bitmap font after setting all the parameters with the builder methods.
BitmapFontBuilder	withBorder(com.badlogic.gdx.graphics.Color borderColor, float borderWidth)
BitmapFontBuilder	withBorder(com.badlogic.gdx.graphics.Color borderColor, float borderWidth, float borderGamma)
BitmapFontBuilder	withItalic()
BitmapFontBuilder	withKreonBold()
BitmapFontBuilder	withKreonRegular()
BitmapFontBuilder	withLinearFiltering(boolean linearFiltering) Use for large font sizes.
BitmapFontBuilder	withShadow(com.badlogic.gdx.graphics.Color shadowColor)
BitmapFontBuilder	withShadow(com.badlogic.gdx.graphics.Color shadowColor, int unscaledOffsetX, int unscaledOffsetY)
BitmapFontBuilder	withSize(float fontSize)
BitmapFontBuilder	withSize(float fontSize, boolean linearFiltering)

Methods inherited from class java.lang.Object

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

Constructor Detail

BitmapFontBuilder

public BitmapFontBuilder()

Method Detail

withSize

public BitmapFontBuilder withSize(float fontSize)

withSize

public BitmapFontBuilder withSize(float fontSize,
                                  boolean linearFiltering)

withKreonRegular

public BitmapFontBuilder withKreonRegular()

withKreonBold

public BitmapFontBuilder withKreonBold()

withItalic

public BitmapFontBuilder withItalic()

withLinearFiltering

public BitmapFontBuilder withLinearFiltering(boolean linearFiltering)

Use for large font sizes. Base game seems like it uses linear filtering for fonts of size 30 and above, so it's probably a good idea to copy that practice. To be completely honest, I don't know what this does but you can try and change it and report back your results if you understand it.

Parameters:

linearFiltering - whether to use linear filtering

Returns:

this builder

withShadow

public BitmapFontBuilder withShadow(com.badlogic.gdx.graphics.Color shadowColor)

withShadow

public BitmapFontBuilder withShadow(com.badlogic.gdx.graphics.Color shadowColor,
                                    int unscaledOffsetX,
                                    int unscaledOffsetY)

withBorder

public BitmapFontBuilder withBorder(com.badlogic.gdx.graphics.Color borderColor,
                                    float borderWidth)

withBorder

public BitmapFontBuilder withBorder(com.badlogic.gdx.graphics.Color borderColor,
                                    float borderWidth,
                                    float borderGamma)

build

public com.badlogic.gdx.graphics.g2d.BitmapFont build()

Constructs the final bitmap font after setting all the parameters with the builder methods.

Returns:

the constructed font