Module technology.sola.engine
Package technology.sola.engine.core

Class SolaPlatform

java.lang.Object
technology.sola.engine.core.SolaPlatform
@NullMarked public abstract class SolaPlatform extends Object
SolaPlatform defines the API for a platform to run Sola.

  • Field Details

  • Constructor Details

  • Method Details

    • play

      public void play(Sola sola)
      Main entry point for starting a Sola.
      Parameters:
      sola - the Sola to start

    • getRenderer

      public Renderer getRenderer()
      Returns:
      the platform's Renderer

    • getViewport

      public Viewport getViewport()
      Returns:
      the platform's Viewport

    • getSocketClient

      public SocketClient getSocketClient()
      Returns:
      the platform's SocketClient

    • getRestClient

      public RestClient getRestClient()
      Returns:
      the platform's RestClient

    • getSaveStorage

      public SaveStorage getSaveStorage()
      Returns:
      the platform's SaveStorage

    • getIdentifier

      public abstract SolaPlatformIdentifier getIdentifier()
      Returns:
      the platform's identifier

    • onKeyPressed

      public abstract Subscription onKeyPressed(Consumer<KeyEvent> keyEventConsumer)
      Registers an on key pressed listener.
      Parameters:
      keyEventConsumer - the method called when key is pressed
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onKeyReleased

      public abstract Subscription onKeyReleased(Consumer<KeyEvent> keyEventConsumer)
      Registers an on key released listener.
      Parameters:
      keyEventConsumer - the method called when the key is released
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onMouseMoved

      public abstract Subscription onMouseMoved(Consumer<MouseEvent> mouseEventConsumer)
      Registers an on mouse moved listener.
      Parameters:
      mouseEventConsumer - the method called when mouse is moved
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onMousePressed

      public abstract Subscription onMousePressed(Consumer<MouseEvent> mouseEventConsumer)
      Registers an on mouse pressed listener.
      Parameters:
      mouseEventConsumer - the method called when mouse is pressed
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onMouseReleased

      public abstract Subscription onMouseReleased(Consumer<MouseEvent> mouseEventConsumer)
      Registers an on mouse released listener.
      Parameters:
      mouseEventConsumer - the method called when mouse is released
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onMouseWheel

      public abstract Subscription onMouseWheel(Consumer<MouseWheelEvent> mouseWheelEventConsumer)
      Registers an on mouse wheel listener.
      Parameters:
      mouseWheelEventConsumer - the method called when a mouse wheel interaction takes place
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • onTouch

      public abstract Subscription onTouch(Consumer<TouchEvent> touchEventConsumer)
      Registers an on touch listener.
      Parameters:
      touchEventConsumer - the method called when a touch interaction takes place
      Returns:
      an Subscription instance that can be used to unsubscribe the listener

    • setVirtualKeyboardVisible

      public abstract void setVirtualKeyboardVisible(boolean visible)
      Sets the visibility of the virtual keyboard.
      Parameters:
      visible - whether the virtual keyboard should be visible or not

    • initializePlatform

      protected abstract void initializePlatform(SolaConfiguration solaConfiguration, SolaPlatform.SolaPlatformInitialization solaPlatformInitialization)
      Method to initialize a SolaPlatform. This operation can be async. It will provide the configuration from the ).
      Parameters:
      solaConfiguration - the Sola configuration
      solaPlatformInitialization - call SolaPlatform.SolaPlatformInitialization.finish() when platform initialization is finished

    • beforeRender

      protected abstract void beforeRender(Renderer renderer)
      Method called before each render frame.
      Parameters:
      renderer - the Renderer

    • onRender

      protected abstract void onRender(Renderer renderer)
      Main render frame method.
      Parameters:
      renderer - the Renderer

    • populateAssetLoaderProvider

      protected abstract void populateAssetLoaderProvider(AssetLoaderProvider assetLoaderProvider)
      Method to populate the SolaPlatform AssetLoaderProvider with AssetLoaders that Sola will be able to use.
      Parameters:
      assetLoaderProvider - the AssetLoaderProvider

    • buildRenderer

      protected Renderer buildRenderer(SolaConfiguration solaConfiguration)
      Builds the Renderer for this platform. Default implementation will use the SoftwareRenderer implementation.
      Parameters:
      solaConfiguration - the SolaConfiguration for the Sola
      Returns:
      the built Renderer

    • buildGameLoop

      protected SolaPlatform.GameLoopProvider buildGameLoop()
      Builds the GameLoop for this platform. Default implementation will use the FixedUpdateGameLoop implementation.
      Returns:
      the built GameLoop

    • adjustPointerForViewport

      protected SolaPlatform.PointerCoordinate adjustPointerForViewport(float x, float y)
      Convenience method for calculating adjusted pointer coordinate considering the current AspectMode of the Viewport.
      Parameters:
      x - the raw x coordinate of the pointer
      y - the raw y coordinate of the pointer
      Returns:
      the viewport adjusted pointer coordinate

    • adjustPointerForViewport

      protected SolaPlatform.PointerCoordinate adjustPointerForViewport(int x, int y)
      Convenience method for calculating adjusted pointer coordinate considering the current AspectMode of the Viewport.
      Parameters:
      x - the raw x coordinate of the pointer
      y - the raw y coordinate of the pointer
      Returns:
      the viewport adjusted pointer coordinate