britzlmonarch
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
6.0.3- Pick a release from britzl/monarch releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as transitions_gui from "monarch.transitions.gui"
- Pick a release from britzl/monarch releases and add its Source code (zip) URL (or a packaged
Functions
slide_in_right(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_in_left(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_in_top(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_in_bottom(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_out_right(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_out_left(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_out_top(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)slide_out_bottom(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)scale_in(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)scale_out(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)fade_in(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)fade_out(node:Opaque<"node">, from:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)in_right_out_left(node:Opaque<"node">, duration: number, delay?: number, easing?:Easing)in_left_out_right(node:Opaque<"node">, duration: number, delay?: number, easing?:Easing)in_left_out_left(node:Opaque<"node">, duration: number, delay?: number, easing?:Easing)in_right_out_right(node:Opaque<"node">, duration: number, delay?: number, easing?:Easing)fade_in_out(node:Opaque<"node">, duration: number, delay?: number, easing?:Easing)window_resized(width: number, height: number)instant(node:Opaque<"node">, to:Vector3, easing:GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node:Opaque<"node">) => void)create(2 overloads)
slide_in_right(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">to:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_in_left(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">to:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_in_top(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">to:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_in_bottom(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">to:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_out_right(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_out_left(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_out_top(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
slide_out_bottom(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
scale_in(node: Opaque<"node">, to: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">to:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
scale_out(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
fade_in(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
fade_out(node: Opaque<"node">, from: Vector3, easing: GuiEasing, duration: number, delay?: number, complete_function?: (this: any, node: Opaque<"node">) => void)
Parameters
node:Opaque<"node">from:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
in_right_out_left(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)U
Create transition where the screen slides in from the right when shown and out to the left when hidden (and the reverse when going back)
Parameters
node:Opaque<"node">duration:numberdelay?:number— Optional. Defaults to 0easing?:Easing— Optional. A constant from monarch.transitions.easing
in_left_out_right(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)
Parameters
node:Opaque<"node">duration:numberdelay?:numbereasing?:Easing
in_left_out_left(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)
Parameters
node:Opaque<"node">duration:numberdelay?:numbereasing?:Easing
in_right_out_right(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)
Parameters
node:Opaque<"node">duration:numberdelay?:numbereasing?:Easing
fade_in_out(node: Opaque<"node">, duration: number, delay?: number, easing?: Easing)
Parameters
node:Opaque<"node">duration:numberdelay?:numbereasing?:Easing
window_resized(width: number, height: number)
Notify the transition system that the window size has changed
Parameters
width:numberheight: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:Vector3easing:GuiEasingduration:numberdelay?:numbercomplete_function?:(this: any, node: Opaque<"node">) => void
create(2 overloads)
(node: Opaque<"node">): TransitionParameters
node:Opaque<"node">
Returns
Transition
(): TransitionNodelessReturns
TransitionNodeless