Module technology.sola.engine

Package technology.sola.engine.assets.list

Record Class AssetList

java.lang.Object

java.lang.Record

technology.sola.engine.assets.list.AssetList

Record Components:

audioAssets - the list of AudioClip assets

fontAssets - the list of Font assets

guiAssets - the list of GuiJsonDocument assets

imageAssets - the list of SolaImage assets

sceneAssets - the list of Scene assets

spriteSheetAssets - the list of SpriteSheet assets

All Implemented Interfaces:

Asset

@NullMarked
public record AssetList(List<AssetList.AssetDetails<AudioClip>> audioAssets, List<AssetList.AssetDetails<Font>> fontAssets, List<AssetList.AssetDetails<GuiJsonDocument>> guiAssets, List<AssetList.AssetDetails<SolaImage>> imageAssets, List<AssetList.AssetDetails<Scene>> sceneAssets, List<AssetList.AssetDetails<SpriteSheet>> spriteSheetAssets)
extends Record
implements Asset

AssetList is an Asset that contains a list of other assets to be loaded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AssetList.AssetDetails<T extends Asset>	AssetDetails contains details for loading assets on startup of the Sola.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The id of the main asset list.
static final String	PATH	The path to the main asset list.

Constructor Summary

Constructors

Constructor	Description
AssetList(List<AssetList.AssetDetails<AudioClip>> audioAssets, List<AssetList.AssetDetails<Font>> fontAssets, List<AssetList.AssetDetails<GuiJsonDocument>> guiAssets, List<AssetList.AssetDetails<SolaImage>> imageAssets, List<AssetList.AssetDetails<Scene>> sceneAssets, List<AssetList.AssetDetails<SpriteSheet>> spriteSheetAssets)	Creates an instance of a AssetList record class.

Method Summary

Modifier and Type	Method	Description
List<AssetList.AssetDetails<AudioClip>>	audioAssets()	Returns the value of the audioAssets record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<AssetList.AssetDetails<Font>>	fontAssets()	Returns the value of the fontAssets record component.
List<AssetList.AssetDetails<GuiJsonDocument>>	guiAssets()	Returns the value of the guiAssets record component.
final int	hashCode()	Returns a hash code value for this object.
List<AssetList.AssetDetails<SolaImage>>	imageAssets()	Returns the value of the imageAssets record component.
List<AssetList.AssetDetails<Scene>>	sceneAssets()	Returns the value of the sceneAssets record component.
List<AssetList.AssetDetails<SpriteSheet>>	spriteSheetAssets()	Returns the value of the spriteSheetAssets record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ID

public static final String ID

The id of the main asset list.

See Also:

• Constant Field Values

PATH

public static final String PATH

The path to the main asset list.

See Also:

• Constant Field Values

Constructor Details

AssetList

public AssetList(List<AssetList.AssetDetails<AudioClip>> audioAssets,
 List<AssetList.AssetDetails<Font>> fontAssets,
 List<AssetList.AssetDetails<GuiJsonDocument>> guiAssets,
 List<AssetList.AssetDetails<SolaImage>> imageAssets,
 List<AssetList.AssetDetails<Scene>> sceneAssets,
 List<AssetList.AssetDetails<SpriteSheet>> spriteSheetAssets)

Creates an instance of a AssetList record class.

Parameters:

audioAssets - the value for the audioAssets record component

fontAssets - the value for the fontAssets record component

guiAssets - the value for the guiAssets record component

imageAssets - the value for the imageAssets record component

sceneAssets - the value for the sceneAssets record component

spriteSheetAssets - the value for the spriteSheetAssets record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

audioAssets

public List<AssetList.AssetDetails<AudioClip>> audioAssets()

Returns the value of the audioAssets record component.

Returns:

the value of the audioAssets record component

fontAssets

public List<AssetList.AssetDetails<Font>> fontAssets()

Returns the value of the fontAssets record component.

Returns:

the value of the fontAssets record component

guiAssets

public List<AssetList.AssetDetails<GuiJsonDocument>> guiAssets()

Returns the value of the guiAssets record component.

Returns:

the value of the guiAssets record component

imageAssets

public List<AssetList.AssetDetails<SolaImage>> imageAssets()

Returns the value of the imageAssets record component.

Returns:

the value of the imageAssets record component

sceneAssets

public List<AssetList.AssetDetails<Scene>> sceneAssets()

Returns the value of the sceneAssets record component.

Returns:

the value of the sceneAssets record component

spriteSheetAssets

public List<AssetList.AssetDetails<SpriteSheet>> spriteSheetAssets()

Returns the value of the spriteSheetAssets record component.

Returns:

the value of the spriteSheetAssets record component