Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: DialogueScene

[21:7] extends: FxglSubScene

Wraps FXGL's DialogueScene (com.almasb.fxgl.cutscene.dialogue.DialogueScene), the SubScene the engine pushes when a DialogueGraph is being played. Adds the typewriter-style text rendering, the player-line picker, and the per-tick advance logic on top of the standard SubScene base. The class is final; construction requires a SceneService, so Aussom users normally come at this through the CutsceneService wrapper instead of building one directly. The wrapper supports adopt for code that gets a DialogueScene back from the engine and start / endDialogue for driving an active scene.

Methods

  • DialogueScene ()

    Empty default constructor; populated by adopt.

  • adopt (object Ajo)

    Wraps an existing DialogueScene AussomJavaObject.

    • @p Ajo is an AussomJavaObject around a DialogueScene.
  • start (object GraphObj, object ContextAjo, object HandlerObj, callback OnFinishedCb = null)

    Starts playing the supplied DialogueGraph.

    • @p GraphObj is a DialogueGraph wrapper or raw AJO.
    • @p ContextAjo is a DialogueContext AJO.
    • @p HandlerObj is a FunctionCallHandler wrapper or raw AJO.
    • @p OnFinishedCb is an Aussom callback invoked when the dialogue completes; may be null.
  • endDialogue ()

    Ends the currently playing dialogue and pops the scene.

  • getGameVars ()

    Returns the PropertyMap of dialogue variables (Kotlin mangled).

  • getAssetLoader ()

    Returns the AssetLoaderService used by the dialogue scene.

  • getAudioPlayer ()

    Returns the AudioPlayer used by the dialogue scene.