Skip to Content
defold-typescript libraries
Pause-Gamesflow

Pause-Games/flow/flow.bottom_sheet

Flow's hosted bottom-sheet component and GUI lifecycle adapter.

  • GitHub: Pause-Games/flow — pinned to 1.0.0
    1. Pick a release from Pause-Games/flow 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 bottom_sheet from "flow.bottom_sheet"

Variables

init: (self: FlowSelf, config: Flow_BottomSheetHostConfig) => void

final: (self: FlowSelf) => void

update: (self: FlowSelf, dt: number) => boolean

present: (self: FlowSelf, params?: FlowParams) => void

dismiss: (self: FlowSelf, result?: unknown) => boolean

invalidate: (self: FlowSelf) => boolean

on_input: (self: FlowSelf, action_id: Hash | undefined, action: FlowInputAction) => boolean

on_message: (self: FlowSelf, message_id: Hash | string, message?: FlowParams, sender?: Url) => boolean

Types

type FlowSelf = object

type FlowParams = LuaMap<string, unknown> | Record<string, unknown>

FlowInputAction

FlowInputAction.x?: number

FlowInputAction.y?: number

FlowInputAction.pressed?: boolean

FlowInputAction.released?: boolean

FlowBottomSheetModule

FlowBottomSheetModule.__call(props: Flow_BottomSheetProps): Flow_Element

Creates a bottom-sheet element.

Parameters

  • props: Flow_BottomSheetProps

Returns

  • Flow_Element

On this page