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

Class Sola

java.lang.Object
technology.sola.engine.core.Sola
@NullMarked public abstract class Sola extends Object
Sola contains the core functionality needed to make a game. It is played via SolaPlatform.

  • Field Details

    • configuration

      protected final SolaConfiguration configuration
      The configuration for this Sola

    • solaEcs

      protected technology.sola.ecs.SolaEcs solaEcs
      The SolaEcs instance used by this Sola

    • eventHub

      protected EventHub eventHub
      The EventHub instance used by this Sola

    • keyboardInput

      protected KeyboardInput keyboardInput
      Used to check the current state of keyboard input.

    • mouseInput

      protected MouseInput mouseInput
      Used to check the current state of mouse input.

    • touchInput

      protected TouchInput touchInput
      Used to check the current state of touch input.

    • assetLoaderProvider

      protected AssetLoaderProvider assetLoaderProvider
      Used to load assets for the Sola to use.

  • Constructor Details

    • Sola

      protected Sola(SolaConfiguration configuration)
      Creates a Sola instance with desired SolaConfiguration.
      Parameters:
      configuration - the configuration for the Sola

  • Method Details

    • onInit

      protected abstract void onInit()
      Method called to initialize the Sola.

    • onAsyncInit

      protected void onAsyncInit(Runnable completeAsyncInit)
      Method called if any asynchronous initialization is needed. Call completeAsyncInit.run() when completed to continue starting the Sola.

      Note: No render calls will happen until this async initialization has completed, so be careful!

      Parameters:
      completeAsyncInit - the callback to notify the hosting platform initialization is complete

    • onRender

      protected abstract void onRender(Renderer renderer)
      Method called every frame to render the world.
      Parameters:
      renderer - the Renderer instance

    • platform

      protected SolaPlatform platform()
      Returns:
      the SolaPlatform running this Sola.

    • onUpdate

      protected void onUpdate(float deltaTime)
      Method called every frame to update the input and world state.
      Parameters:
      deltaTime - the time since the last update