Skip to content

Interface: GuiBookOptions ​

Defined in: packages/minerender/src/gui/GuiHelper.ts:217

Settings passed to GuiHelper.book. Text defaults to black, unshadowed, and wrapped at 114 pixels.

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
bold?boolean-GuiTextOptions.boldpackages/minerender/src/gui/GuiText.ts:10
color?numbersRGB 0xRRGGBB; defaults to white.GuiTextOptions.colorpackages/minerender/src/gui/GuiText.ts:9
font?string | AssetKeyFont resource ID; defaults to minecraft:default.GuiTextOptions.fontpackages/minerender/src/gui/GuiText.ts:25
italic?boolean-GuiTextOptions.italicpackages/minerender/src/gui/GuiText.ts:11
lineHeight?numberDistance between line origins; defaults to 9 GUI pixels.GuiTextOptions.lineHeightpackages/minerender/src/gui/GuiText.ts:31
maxWidth?numberWrap width in GUI pixels. Long words break at glyph boundaries.GuiTextOptions.maxWidthpackages/minerender/src/gui/GuiText.ts:29
next?GuiBookButtonState--packages/minerender/src/gui/GuiHelper.ts:221
position?[number, number]Top-left position of the book background in GUI pixels. Defaults to [0, 0].-packages/minerender/src/gui/GuiHelper.ts:219
previous?GuiBookButtonState--packages/minerender/src/gui/GuiHelper.ts:220
shadow?booleanDraws a one-pixel shadow; defaults to true.GuiTextOptions.shadowpackages/minerender/src/gui/GuiText.ts:27
text?GuiTextContent for one page. The caller keeps it within the 128-pixel text height.-packages/minerender/src/gui/GuiHelper.ts:223