All Classes and Interfaces
Class
Description
Indexes all anchors within a page to allow faster navigation to them.
Handles tags like
<BlockImage id="mod:blockid" /> and renders a 3D block image in its place.Compiler base-class for tag compilers that compile block content but allow the block content to be used in flow
context by wrapping it in an inline block.
Compiles a
<AnnotationBox tag into InWorldBoxAnnotation.Pages can declare to be part of multiple categories using the categories frontmatter.
A
GuideTooltip that renders a LytBlock as the tooltip content.The base interface for all other classes and interfaces acting as extensions.
A collection of extensions registered to modify the guidebook.
An extension point is offered by the guidebook to plug in additional functionality.
Compiler base-class for tag compilers that compile flow content but allow the flow content to be used in block
context by wrapping it in a paragraph.
Inserts a page into the navigation tree.
Asset management
A version of
LightTexture which is independent of the current client level.Constructs new guides.
Button found in the toolbar at the top of
GuideScreen.Configuration settings for the automatically generated guide item.
A texture that is used in the context of a single guide page and is automatically cleared from texture memory when
the guide page it was last used on is closed.
Global registry of GuideME guides.
Helper to resolve shorthand and relative IDs found in markdown pages.
Provides a way to generate a
SceneAnnotation on the fly if no explicit annotation could be found under the
mouse.Imports a structure into the scene.
How an inline block element is supposed to be aligned within the flow layout.
A
SceneAnnotation that renders in-world.An index of Minecraft items to the main guidebook page describing it.
Applies a function to an existing color that makes it lighter or darker by a given percentage.
Compiles a
<AnnotationBox tag into InWorldBoxAnnotation.Standalone block in-line with other content.
The only purpose of this vertex consumer proxy is to transform vertex positions emitted by the
LiquidBlockRenderer into absolute coordinates.A box that just aligns its content along the vertical or horizontal axis.
Layout document.
Zero-Width Flow-Content that can be referred to by links.
Line-Break that also clears floats.
Attaches properties to a span of
LytFlowContent, such as links or formatting.Shows a pseudo-in-world scene within the guidebook.
Lays out its children vertically.
Shows items in a grid-like fashion, i.e.
Renders a standard Minecraft GUI slot.
A cell in a
LytTables LytTableRow.A row in
LytTable.An inline span that allows a tooltip to be shown on hover.
Lays out its children vertically.
Wraps an
AbstractWidget for use within the guidebook layout tree.Serializes the MdAst nodes to JSON.
utilities for dealing with attributes of
MdxJsxElementFields.A convenient index base-class for indices that map keys to multiple pages.
A helper for mutating color values.
A
SceneAnnotation that renders as part of the user-interface, overlaid on top of the in-world scene.Points to a guidebook page with an optional anchor within that page.
A page index is an index over all guidebook pages that will be automatically built when the guidebook is reloaded,
and when individual pages change.
Camera pre-sets to easily change the orientation of a scene.
Shows a Recipe-Book-Like representation of the recipe needed to craft a given item.
Allows mods to register mappings between recipe type and their custom recipe blocks for use in
<RecipeFor/>
and similar tags.Represents the styling of text for rendering.
An annotation to show additional information to the user about content in a
GuidebookScene.Contributed by
DefaultExtensions.Exports a game scene 3d rendering to a custom 3d format for rendering it using WebGL in the browser.
Interface implemented on layout elements that can be styled and inherit styling from their parents.
Symbolic colors can be overridden more easily in styles and define both a light- and dark-themed color variant.
Tag compilers handle HTML-like tags found in Markdown content, such as
<Image /> and similar.A text style that only contains a subset of properties found in
ResolvedTextStyle.Maintains an index for any given page using a mapping function for keys and values of the index.
See https://developer.mozilla.org/en-US/docs/Web/CSS/white-space