core/com.lehaine.littlekt/Game

Game

open class Game<SceneType : Scene>(val context: Context, firstScene: SceneType? = null) : ContextListener

A ContextListener that handles commonly loading assets and preparing assets. Handles scene switching and caching.

Author

Colt Daily

See also

Parameters

context

the context instance

firstScene

the initial scene the was be used immediately by the context.

SceneType

the common base interface or class of all scenes.

Constructors

fun <SceneType : Scene> Game(context: Context, firstScene: SceneType? = null)

Types

object Companion

Functions

inline suspend fun <Type : SceneType> addScene(scene: Type)

open suspend fun <Type : SceneType> addScene(type: KClass<Type>, scene: Type)

Registers an instance of Scene.

inline fun <Type : SceneType> containsScene(): Boolean

open fun <Type : SceneType> containsScene(type: KClass<Type>): Boolean

Checks if the scene of the given type is registered.

inline fun <Type : SceneType> getScene(): Type

open fun <Type : SceneType> getScene(type: KClass<Type>): Type

Returns the cached instance of Scene of the selected type.

inline fun <Type : SceneType> removeScene(): Type?

open fun <Type : SceneType> removeScene(type: KClass<Type>): Type?

Removes the cached instance of Scene of the selected type. Note that this method does not dispose of the scene and will not affect shownScene.

inline suspend fun <Type : SceneType> setScene()

open suspend fun <Type : SceneType> setScene(type: KClass<Type>)

Replaces the current scene with the registered scene instance of the passed type.

open suspend override fun Context.start()

Handles resizing the current scene and disposing of the current scene. If this is overridden, ensure to call setSceneCallbacks to ensure the lifecycle events happen for a Scene.

Properties

val clipboard: Clipboard

val context: Context

val gl: GL

val graphics: Graphics

val input: Input

val logger: Logger

val resourcesVfs: VfsFile

open val shownScene: SceneType

Provides direct access to current Scene instance handling game events.

val stats: AppStats

val storageVfs: VfsFile

val vfs: Vfs