GitHub repository
On this page

britzl/monarch/monarch.transitions.gui

Monarch comes with a system for setting up transitions easily in a gui_script using the monarch.transitions.gui module.

  • GitHub: britzl/monarch — pinned to 2fe3aed
    1. Pick a release from britzl/monarch releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as transitions_gui from "monarch.transitions.gui"

Functions

in_right_out_left(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)

Parameters

  • node: Opaque<"node">
  • duration: number
  • delay?: number
  • easing?: Easing

in_left_out_right(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)

Parameters

  • node: Opaque<"node">
  • duration: number
  • delay?: number
  • easing?: Easing

in_left_out_left(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)

Parameters

  • node: Opaque<"node">
  • duration: number
  • delay?: number
  • easing?: Easing

in_right_out_right(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)

Parameters

  • node: Opaque<"node">
  • duration: number
  • delay?: number
  • easing?: Easing

fade_in_out(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)

Parameters

  • node: Opaque<"node">
  • duration: number
  • delay?: number
  • easing?: Easing

window_resized(width: number, height: number)

Notify the transition system that the window size has changed

Parameters

  • width: number
  • height: number

instant(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)

Calls complete_function

Parameters

  • node: Opaque<"node">
  • to: Vector3
  • easing: GuiEasing
  • duration: number
  • delay?: number
  • complete_function?: (this: any, node: Opaque<"node">) => void

create(node: Opaque<"node">): Transition

Parameters

  • node: Opaque<"node">

Returns

  • Transition

create(): TransitionNodeless

Returns

  • TransitionNodeless

Variables

slide_in_right: TransitionInFn

slide_in_left: TransitionInFn

slide_in_top: TransitionInFn

slide_in_bottom: TransitionInFn

slide_out_right: TransitionOutFn

slide_out_left: TransitionOutFn

slide_out_top: TransitionOutFn

slide_out_bottom: TransitionOutFn

scale_in: TransitionInFn

scale_out: TransitionOutFn

fade_in: TransitionInFn

fade_out: TransitionOutFn