britzldefold-input
britzl/defold-input/in.textbox
Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.
- GitHub: britzl/defold-input — pinned to
4.9.0- Pick a release from britzl/defold-input 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 textbox from "in.textbox"
- Pick a release from britzl/defold-input releases and add its Source code (zip) URL (or a packaged
Functions
acquire()release()register(box_node_or_string:Opaque<"node"> | string, text_node_or_string:Opaque<"node"> | string, is_masked?: boolean):Opaque<"node">unregister(node_or_string?:Opaque<"node"> | string)effect(node:Opaque<"node">, scale: { x: number; y: number; })text(node_or_string:Opaque<"node"> | string, text?: string): string | undefinedon_input(action_id:Hash, action: {}): boolean
acquire()U
Convenience function to acquire input focus
release()U
Convenience function to release input focus
register(box_node_or_string: Opaque<"node"> | string, text_node_or_string: Opaque<"node"> | string, is_masked?: boolean): Opaque<"node">U
Register box and text nodes and optional mask param Use is_mask = true if you want to show asterisks (*) instead of the text
Parameters
box_node_or_string:Opaque<"node"> | stringtext_node_or_string:Opaque<"node"> | stringis_masked?:boolean
Returns
Opaque<"node">
unregister(node_or_string?: Opaque<"node"> | string)U
Unregister a previously registered node or all nodes registered from the calling script
Parameters
node_or_string?:Opaque<"node"> | string
effect(node: Opaque<"node">, scale: { x: number; y: number; })
Parameters
node:Opaque<"node">scale:{ x: number; y: number; }x:numbery:number
text(node_or_string: Opaque<"node"> | string, text?: string): string | undefined
Get a registered textbox's text, or set it first when text is given.
Returns the text the box holds after the call.
Parameters
node_or_string:Opaque<"node"> | stringtext?:string
Returns
string | undefined
on_input(action_id: Hash, action: {}): booleanU
Forward on_input calls to this function to detect input for registered nodes
Parameters
action_id:Hashaction:{}
Returns
boolean— true if input a registerd node received input