korge/korlibs.korge.scene/Scene

Scene

abstract class Scene : InjectorDependency, ViewsContainer, CoroutineScope, ResourcesContainer, Extra

Acts as a controller. Subclasses must override at least one of: sceneInit or sceneMain.

The lifecycle of the Scene for (SceneContainer.pushTo, SceneContainer.changeTo, SceneContainer.back, SceneContainer.forward):

OLD Scene -> NEW Scene -- Scene is changed
NEW: sceneInit - BLOCK - Called when this scene enters. Waits until completed
NEW: sceneMain - DO NOT BLOCK - Called after sceneInit. Doesn't wait for completion. Its underlying Job is closed automatically on sceneAfterDestroy
OLD: sceneBeforeLeaving - BLOCK - Called on the old scene. Waits until completed.
Transition from the old view and the new view is performed the animation transition set values for View.ratio in the SceneContainer.transitionView in the range 0..1
OLD: sceneDestroy - BLOCK - Called when this scene exits. Waits until completed.
OLD: sceneAfterDestroy - DO NOT BLOCK - Cancels the Job of the old scene. Do not wait
NEW: sceneAfterInit - DO NOT BLOCK - Similar to sceneMain but after the transition.
New scene is returned

Inheritors

Constructors

Scene

constructor()

Properties

val ag: AG

A reference to the AG from the Views

val ViewsContainer.ag: AG

coroutineContext

open override val coroutineContext: CoroutineContext

extra

open override var extra: ExtraType

gameWindow

val gameWindow: GameWindow

injector

lateinit var injector: Injector

A child Injector for this instance. Set by the init method.

input

val input: Input

keys

val keys: InputKeys

resources

open override val resources: Resources

resourcesRoot

lateinit var resourcesRoot: ResourcesRoot

The ResourcesRoot singleton. Set by the init method.

root

val root: Container

sceneContainer

lateinit var sceneContainer: SceneContainer

The SceneContainer that contains this Scene. Set by the init method.

sceneHeight

open val sceneHeight: Int

sceneView

val sceneView: SContainer

sceneWidth

open val sceneWidth: Int

stage

val stage: Stage

storage

val ViewsContainer.storage: NativeStorage

views

open lateinit override var views: Views

The Views singleton of the application. Set by the init method.

Functions

delay

suspend fun Scene.delay(time: TimeSpan)

init

override fun init(injector: Injector)

This method will be called by the SceneContainer that will display this Scene. This will set the injector, views, sceneContainer and resourcesRoot.

installMouseDebugExtensionOnce

fun ViewsContainer.installMouseDebugExtensionOnce()

onSizeChanged

open fun onSizeChanged(size: Size)

registerFilterSerialization

fun ViewsContainer.registerFilterSerialization()

sceneAfterDestroy

open suspend fun sceneAfterDestroy()

DO NOT BLOCK. Called on the old scene after the transition has been performed, and the old scene is not visible anymore.

sceneAfterInit

open suspend fun sceneAfterInit()

DO NOT BLOCK. Called after the old scene has been destroyed and the transition has been completed.

sceneBeforeLeaving

open suspend fun sceneBeforeLeaving()

BLOCK. Called on the old scene after the new scene has been initialized, and before the transition is performed.

sceneDestroy

open suspend fun sceneDestroy()

BLOCK. Called on the old scene after the transition has been performed, and the old scene is not visible anymore.

sceneInit

open suspend fun SContainer.sceneInit()

BLOCK. This is called to setup the scene. Nothing will be shown until this method completes. Here you can read and wait for resources. No need to call super.

sceneMain

open suspend fun SContainer.sceneMain()

DO NOT BLOCK. This is called as a main method of the scene. This is called after sceneInit. This method doesn't need to complete as long as it suspends. Its underlying job will be automatically closed on the sceneAfterDestroy. No need to call super.

Scene

OLD Scene -> NEW Scene -- Scene is changed

New scene is returned

Inheritors

Constructors

Properties

Functions