Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Cutscene

[18:7] extends: FxObj

Wraps FXGL's Cutscene (com.almasb.fxgl.cutscene.Cutscene), a simple value type that holds the ordered list of dialogue lines a cutscene plays back. Each line uses FXGL's cutscene script format: id.name = Hero id.image = hero.png id: Hello, traveler! Pass the cutscene to CutsceneService.startCutscene to play it.

Methods

  • Cutscene (Lines = null)

    Creates a new Cutscene from a list of script lines.

    • @p Lines is an Aussom list of strings, or null for the adopt path.
  • adopt (object Ajo)

    Wraps an existing Cutscene AussomJavaObject.

    • @p Ajo is an AussomJavaObject around a Cutscene.
    • @r A new wrapper.
  • getLines ()

    Returns the cutscene's raw line list (read-only) as an AussomJavaObject around a List.

    • @r An AussomJavaObject around a List.