Module technology.sola.engine

Package technology.sola.engine.defaults

Class SolaWithDefaults

java.lang.Object

technology.sola.engine.core.Sola

technology.sola.engine.defaults.SolaWithDefaults

@NullMarked
public abstract class SolaWithDefaults
extends Sola

SolaWithDefaults extends Sola with some default behaviors that many games will find useful, such as default physics configurations and rendering options. These can be enabled in the onInit(DefaultsConfigurator) method and configured further via the member instances

• solaPhysics
• solaGraphics
• guiDocument
• solaControls

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SolaWithDefaults.DefaultsConfigurator	DefaultsConfigurator provides methods for enabling various default functionality.

Field Summary

Fields

Modifier and Type	Field	Description
protected final SolaControls	solaControls	The SolaControls instance for this Sola.

Fields inherited from class technology.sola.engine.core.Sola

assetLoaderProvider, configuration, eventHub, keyboardInput, mouseInput, solaEcs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SolaWithDefaults(SolaConfiguration configuration)	Creates a SolaWithDefaults instance with desired SolaConfiguration.

Method Summary

Modifier and Type	Method	Description
protected GuiDocument	guiDocument()	The GuiDocument instance for this Sola.
protected void	onInit()	Method called to initialize the Sola.
protected abstract void	onInit(SolaWithDefaults.DefaultsConfigurator defaultsConfigurator)	Calls Sola.onInit() while providing access to the SolaWithDefaults.DefaultsConfigurator.
protected void	onRender(Renderer renderer)	Method called every frame to render the world.
protected SolaGraphics	solaGraphics()	The SolaGraphics instance for this Sola.
protected SolaPhysics	solaPhysics()	The SolaPhysics instance for this Sola.

Methods inherited from class technology.sola.engine.core.Sola

onAsyncInit, onUpdate, platform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

solaControls

protected final SolaControls solaControls

The SolaControls instance for this Sola. It can be used in place of other input related objects for convenience.

Constructor Details

SolaWithDefaults

protected SolaWithDefaults(SolaConfiguration configuration)

Creates a SolaWithDefaults instance with desired SolaConfiguration.

Parameters:

configuration - the configuration for the Sola

Method Details

onInit

protected abstract void onInit(SolaWithDefaults.DefaultsConfigurator defaultsConfigurator)

Calls Sola.onInit() while providing access to the SolaWithDefaults.DefaultsConfigurator.

Parameters:

defaultsConfigurator - the DefaultsConfigurator instance

onInit

protected void onInit()

Description copied from class: Sola

Method called to initialize the Sola.

Specified by:

onInit in class Sola

onRender

protected void onRender(Renderer renderer)

Description copied from class: Sola

Method called every frame to render the world.

Specified by:

onRender in class Sola

Parameters:

renderer - the Renderer instance

solaGraphics

protected SolaGraphics solaGraphics()

The SolaGraphics instance for this Sola. Call SolaWithDefaults.DefaultsConfigurator.useGraphics() to configure.

Returns:

SolaGraphics instance

solaPhysics

protected SolaPhysics solaPhysics()

The SolaPhysics instance for this Sola. Call SolaWithDefaults.DefaultsConfigurator.usePhysics() to configure.

Returns:

SolaPhysics instance

guiDocument

protected GuiDocument guiDocument()

The GuiDocument instance for this Sola. Call SolaWithDefaults.DefaultsConfigurator.useGui() to configure.

Returns:

GuiDocument instance