Class SceneAnnotation

java.lang.Object
guideme.scene.annotation.SceneAnnotation
All Implemented Interfaces:
ExportableResourceProvider
Direct Known Subclasses:
InWorldAnnotation, OverlayAnnotation
public abstract class SceneAnnotation extends Object implements ExportableResourceProvider
An annotation to show additional information to the user about content in a GuidebookScene.

  • Constructor Details

    • SceneAnnotation

      public SceneAnnotation()

  • Method Details

    • getTooltip

      @Nullable public @Nullable GuideTooltip getTooltip()

    • setTooltip

      public void setTooltip(@Nullable @Nullable GuideTooltip tooltip)

    • setTooltipContent

      public void setTooltipContent(LytBlock block)

    • setTooltipContent

      public void setTooltipContent(net.minecraft.network.chat.Component component)

    • hasTooltip

      public boolean hasTooltip()

    • getSourceNode

      @Nullable public @Nullable guideme.libs.mdast.model.MdAstNode getSourceNode()
      Returns the element of the page this annotation was compiled from, if known. For annotations created by a template (i.e. <BlockAnnotationTemplate>), this is the element inside the template.
      Returns:
      the element of the page this annotation was compiled from, if known

    • setSourceNode

      public void setSourceNode(@Nullable @Nullable guideme.libs.mdast.model.MdAstNode sourceNode)

    • isHovered

      public boolean isHovered()

    • setHovered

      public void setHovered(boolean hovered)

    • exportResources

      public void exportResources(ResourceExporter exporter)
      Specified by:
      exportResources in interface ExportableResourceProvider