Class ScreenExtensionView

java.lang.Object
com.render.api.gui.ScreenExtensionView
Direct Known Subclasses:
VirtualMenuSession
public abstract class ScreenExtensionView extends Object
Retained UI host mounted into an existing Minecraft screen.

Injected views use GuiUiMode.MODERN by default. Call uiMode(GuiUiMode) with GuiUiMode.LEGACY for explicit compatibility with the original retained runtime.

  • Constructor Details

    • ScreenExtensionView

      protected ScreenExtensionView()

  • Method Details

    • context

      public final ScreenExtensionContext context()

    • attached

      public final boolean attached()

    • uiMode

      public final ScreenExtensionView uiMode(GuiUiMode uiMode)
      Selects the retained runtime mode for this injected view.
      Parameters:
      uiMode - runtime mode
      Returns:
      this view

    • styleSheet

      public final ScreenExtensionView styleSheet(GuiStyleSheet styleSheet)
      Appends a typed stylesheet to this injected view.
      Parameters:
      styleSheet - stylesheet
      Returns:
      this view

    • tick

      public final void tick()

    • onClose

      public final void onClose()

    • build

      protected abstract void build(ScreenExtensionContext context)

    • tick

      protected void tick(ScreenExtensionContext context)

    • onAttached

      protected void onAttached(ScreenExtensionContext context)

    • onDetached

      protected void onDetached(ScreenExtensionContext context)

    • onHostScreenChanged

      protected void onHostScreenChanged(ScreenExtensionContext previous, ScreenExtensionContext next)

    • buildHost

      protected final void buildHost()

    • updateContext

      public final void updateContext(ScreenExtensionContext nextContext)

    • detach

      public final void detach()

    • root

      public final ContainerComponent root()

    • findById

      public final Optional<GuiComponent<?>> findById(String id)
      Finds a uniquely identified component across the retained content and managed overlay trees.

      This is the stable cross-class access point for updating a component without retaining the concrete field that originally created it. Duplicate IDs are rejected.

      Parameters:
      id - component identifier
      Returns:
      matching component, when present

    • findById

      public final <C extends GuiComponent<?>> Optional<C> findById(String id, Class<C> componentType)
      Finds and type-checks a uniquely identified component across this view.
      Type Parameters:
      C - component type
      Parameters:
      id - component identifier
      componentType - required component type
      Returns:
      matching typed component, when present

    • viewTransition

      public final GuiViewTransition viewTransition()
      Returns this host's single retained view-transition controller.
      Returns:
      view-transition controller

    • devtoolsEnabled

      public com.render.api.gui.GuiHostView devtoolsEnabled(boolean devtoolsEnabled)

    • devtoolsEnabled

      public final boolean devtoolsEnabled()

    • renderCompatibilityReport

      public final GuiRenderCompatibilityReport renderCompatibilityReport()
      Returns capabilities and fallbacks for the most recently compiled GUI render graph.
      Returns:
      current GUI render compatibility report

    • renderStats

      public final GuiRenderStats renderStats()
      Returns statistics for the most recently compiled GUI render graph.
      Returns:
      current GUI render statistics

    • fontPolicy

      public com.render.api.gui.GuiHostView fontPolicy(GuiFontPolicy policy)
      Selects the external-font authorization policy for this view.
      Parameters:
      policy - font policy
      Returns:
      this host

    • fontPolicy

      public final GuiFontPolicy fontPolicy()
      Returns this view's external-font authorization policy.
      Returns:
      font policy

    • motionPreference

      public com.render.api.gui.GuiHostView motionPreference(GuiMotionPreference preference)
      Selects how this view responds to reduced-motion preferences.
      Parameters:
      preference - motion preference
      Returns:
      this host

    • motionPreference

      public final GuiMotionPreference motionPreference()
      Returns this view's effective motion preference policy.
      Returns:
      motion preference

    • uiMode

      public final GuiUiMode uiMode()
      Returns the selected retained runtime mode.
      Returns:
      runtime mode

    • removeStyleSheet

      public final boolean removeStyleSheet(GuiStyleSheet styleSheet)
      Removes an attached stylesheet.
      Parameters:
      styleSheet - stylesheet
      Returns:
      whether it was attached

    • clearStyleSheets

      public final void clearStyleSheets()
      Clears every attached stylesheet.

    • styleSheets

      public final List<GuiStyleSheet> styleSheets()
      Returns attached stylesheets in cascade order.
      Returns:
      immutable stylesheet list

    • showDialog

      public final void showDialog(DialogModalComponent dialog)

    • closeDialog

      public final void closeDialog(DialogModalComponent dialog)

    • showToast

      public final ToastHandle showToast(ToastComponent toast)

    • clearToasts

      public final void clearToasts()

    • ensureBuilt

      public final void ensureBuilt()