Skip to Content
defold-typescript libraries
baochungitdefold-wrap

baochungit/defold-wrap/wrap.node_list

Wraps several GUI nodes at once. new takes node ids, or names paired with ids or nodes, and returns a table holding one wrap.node wrapper per name, optionally looking each id up in a cloned tree first.

  • GitHub: baochungit/defold-wrap — pinned to 1.1.0
    1. Pick a release from baochungit/defold-wrap 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 node_list from "wrap.node_list"

Functions

new(2 overloads): NodeList<K>

  1. <const K extends string>(data: readonly K[], tree?: NodeTree)

    Wraps the node with each id, keyed by the id.

    Parameters

    • data: readonly K[] — The node ids.
    • tree?: NodeTree — A table from gui.clone_tree or gui.get_tree to look each id up in first. An id it lacks, or every id when it is omitted, is looked up with gui.get_node.
  2. <K extends string>(data: Record<K, string | Opaque<'node'>>, tree?: NodeTree)

    Wraps each node, keyed by its name. A Lua table mixing ids and named entries has no TypeScript literal, so name every entry, an id under its own name.

    Parameters

    • data: Record<K, string | Opaque<'node'>> — Each name, paired with a node id or a node.
    • tree?: NodeTree — A table from gui.clone_tree or gui.get_tree to look each id up in first. An id it lacks, or every id when it is omitted, is looked up with gui.get_node.

Returns

  • NodeList<K>

Types

type NodeList<K extends string> = [ OpenKey<K> ] extends [ never ] ? { readonly [P in K | 'tree']: P extends 'tree' ? 'tree' extends K ? Node : NodeTree | undefined : Node; } : { readonly [P in K]: Node; } & { readonly tree: Node | NodeTree | undefined; }

On this page