@defold-typescript/library-types 0.23.0 → 0.24.0

package/generated/defsave.d.ts

@@ -0,0 +1,144 @@
+/** @noSelfInFile **/
+
+/**
+ * Save and load config and user data persistently between a Defold project's sessions
+ * @see {@link https://github.com/subsoap/defsave|Github Source}
+ * @noResolution
+ */
+declare module "defsave.defsave" {
+  /**
+   * Set to true to autosave all loaded files that are changed on a timer
+   */
+  export let autosave: boolean;
+
+  /**
+   * Amount of seconds between autosaves if changes have been made
+   */
+  export let autosave_timer: number;
+
+  /**
+   * Current timer value, only increases if autosave is enabled
+   */
+  export let timer: number;
+
+  /**
+   * Locally used but can be useful to have exposed
+   */
+  export let changed: boolean;
+
+  /**
+   * If true then more information will be printed, such as autosaves
+   */
+  export let verbose: boolean;
+
+  /**
+   * If true then files already loaded will never be overwritten with a reload
+   */
+  export let block_reloading: boolean;
+
+  /**
+   * Determines part of the path for saving files to
+   */
+  export let appname: string;
+
+  /**
+   * List of files currently loaded
+   */
+  export let loaded: LuaMap<string, unknown>;
+
+  /**
+   * System information captured at module load
+   */
+  export let sysinfo: ReturnType<typeof sys.get_sys_info>;
+
+  /**
+   * If true will attempt to load default data from the default_data table when loading an empty file
+   */
+  export let use_default_data: boolean;
+
+  /**
+   * If true then all data saved and loaded will be encrypted with AES - SLOWER
+   */
+  export let enable_encryption: boolean;
+
+  /**
+   * Pick an encryption key to use if you're using encryption
+   */
+  export let encryption_key: string;
+
+  /**
+   * If true then all data saved and loaded will be XOR obfuscated - FASTER
+   */
+  export let enable_obfuscation: boolean;
+
+  /**
+   * Pick an obfuscation key to use if you're using obfuscation; the longer the key the better
+   */
+  export let obfuscation_key: string;
+
+  /**
+   * If true then data is serialized with sys.serialize rather than encoded as JSON
+   */
+  export let use_serialize: boolean;
+
+  /**
+   * Default data to set files to if any cannot be loaded
+   */
+  export let default_data: LuaMap<string, unknown>;
+
+  export function set_appname(name: string): void;
+
+  /**
+   * XOR the input against a key, cycling the key as needed. Defaults to obfuscation_key.
+   */
+  export function obfuscate(input: string, key?: string): string;
+
+  /**
+   * The save path a file resolves to, or nil when no file was given
+   */
+  export function get_file_path(file: string): string | undefined;
+
+  export function load(file: string): boolean | undefined;
+
+  export function get(file: string, key: string): unknown;
+
+  export function set(file: string, key: string, value: any): boolean | undefined;
+
+  export function save(file: string, force?: boolean): boolean | undefined;
+
+  /**
+   * You can save all files at once. By default, it will only actually save files with changes, but you can force saving all files by setting the force flag to true.
+   * @param force false only saves changed files and true saves all files
+   */
+  export function save_all(force?: boolean): void;
+
+  /**
+   * Whether a key is set on a loaded file. Returns nil when the file is loaded but the key is absent.
+   */
+  export function key_exists(file: string, key: string): boolean | undefined;
+
+  /**
+   * Alias of key_exists
+   */
+  export function isset(file: string, key: string): boolean | undefined;
+
+  /**
+   * Reset a file to its default_data entry, or to empty when it has none
+   */
+  export function reset_to_default(file: string): boolean | undefined;
+
+  /**
+   * Whether a file is currently in the loaded list
+   */
+  export function is_loaded(file: string): boolean;
+
+  /**
+   * In your update, if you want autosave to be enabled, you will need to include
+   */
+  export function update(dt: number): void;
+
+  /**
+   * Save all loaded files; call from your script's final
+   */
+  export function final(): void;
+}

package/generated/{dicebag.dicebag.d.ts → dicebag.d.ts}

@@ -6,6 +6,31 @@
  * @noResolution
  */
 declare module "dicebag.dicebag" {
+  /**
+   * Every marble bag `bag_create` has made, keyed by its identifier. `bag_draw` reads
+   * and decrements the counts here; `bag_reset` restores them from the `full_*` pair.
+   */
+  export const bags: LuaMap<
+    string | number | Hash,
+    {
+      success: number;
+      fail: number;
+      full_success: number;
+      full_fail: number;
+      reset_on_success: boolean;
+    }
+  >;
+
+  /**
+   * Every rollable table `table_create` has made, keyed by its identifier. `active` is
+   * what `table_roll` draws from and removes as it goes; `original` is the untouched
+   * copy `table_reset` restores from.
+   */
+  export const tables: LuaMap<
+    string | number | Hash,
+    { active: Array<[number, any, boolean?]>; original: Array<[number, any, boolean?]> }
+  >;
+
   /**
    * Sets up the randomseed and clears the first number of random rolls.
    * @param seed optional seed, if not specified a seed will be generated using socket.gettime().

package/generated/druid.d.ts

@@ -1,5 +1,6 @@
 /** @noResolution */
 declare module 'druid.druid' {
+	import { event } from 'event.event';
 	type druid_text_adjust_type = "downscale" | "trim" | "no_adjust" | "downscale_limited" | "scroll" | "scale_then_scroll" | "trim_left" | "scale_then_trim" | "scale_then_trim_left";
 	type color = Vector4 | Vector3 | string;
 	type druid_container_mode = "stretch" | "fit" | "stretch_x" | "stretch_y";
@@ -15,12 +16,12 @@ declare module 'druid.druid' {
 	 * - It uses a key_back and key_backspace action ids
 	 */
 	interface druid_back_handler extends druid_component {
-		on_back: unknown;
+		on_back: event;
 		params?: unknown | undefined;
 		/**
 		 * The Back Handler constructor
 		 */
-		init(callback?: unknown | undefined, params?: unknown | undefined): void;
+		init(callback?: ((...args: any[]) => unknown) | undefined, params?: unknown | undefined): void;
 	}
 	/**
 	 * Druid component for block input. Use it to block input in special zone.
@@ -56,12 +57,12 @@ declare module 'druid.druid' {
 		LONGTAP_TIME?: number | undefined;
 		AUTOHOLD_TRIGGER?: number | undefined;
 		DOUBLETAP_TIME?: number | undefined;
-		on_init?: ((self: unknown) => void) | undefined;
-		on_click?: ((self: unknown, node: unknown) => void) | undefined;
-		on_click_disabled?: ((self: unknown, node: unknown) => void) | undefined;
-		on_hover?: ((self: unknown, node: unknown, hover_state: unknown) => void) | undefined;
-		on_mouse_hover?: ((self: unknown, node: unknown, hover_state: unknown) => void) | undefined;
-		on_set_enabled?: ((self: unknown, node: unknown, enabled_state: unknown) => void) | undefined;
+		on_init?: ((self: druid_button) => void) | undefined;
+		on_click?: ((self: druid_button, node: Opaque<"node">) => void) | undefined;
+		on_click_disabled?: ((self: druid_button, node: Opaque<"node">) => void) | undefined;
+		on_hover?: ((self: druid_button, node: Opaque<"node">, hover_state: boolean) => void) | undefined;
+		on_mouse_hover?: ((self: druid_button, node: Opaque<"node">, hover_state: boolean) => void) | undefined;
+		on_set_enabled?: ((self: druid_button, node: Opaque<"node">, enabled_state: boolean | undefined) => void) | undefined;
 	}
 	/**
 	 * Basic Druid input component. Handle input on node and provide different callbacks on touch events.
@@ -82,13 +83,13 @@ declare module 'druid.druid' {
 	 * -
 	 */
 	interface druid_button extends druid_component {
-		on_click: unknown;
-		on_pressed: unknown;
-		on_repeated_click: unknown;
-		on_long_click: unknown;
-		on_double_click: unknown;
-		on_hold_callback: unknown;
-		on_click_outside: unknown;
+		on_click: event;
+		on_pressed: event;
+		on_repeated_click: event;
+		on_long_click: event;
+		on_double_click: event;
+		on_hold_callback: event;
+		on_click_outside: event;
 		node: Opaque<"node">;
 		node_id: Hash;
 		anim_node: Opaque<"node">;
@@ -136,7 +137,7 @@ declare module 'druid.druid' {
 		/**
 		 * Set function for additional check for button click availability.
 		 */
-		set_check_function(check_function?: unknown | undefined, failure_callback?: unknown | undefined): druid_button;
+		set_check_function(check_function?: ((...args: any[]) => unknown) | undefined, failure_callback?: ((...args: any[]) => unknown) | undefined): druid_button;
 		/**
 		 * Set Button mode to work inside user HTML5 interaction event.
 		 *
@@ -186,11 +187,11 @@ declare module 'druid.druid' {
 	 */
 	interface druid_drag extends druid_component {
 		node: Opaque<"node">;
-		on_touch_start: unknown;
-		on_touch_end: unknown;
-		on_drag_start: unknown;
-		on_drag: unknown;
-		on_drag_end: unknown;
+		on_touch_start: event;
+		on_touch_end: event;
+		on_drag_start: event;
+		on_drag: event;
+		on_drag_end: event;
 		style: druid_drag_style;
 		click_zone?: Opaque<"node"> | undefined;
 		is_touch: boolean;
@@ -208,7 +209,7 @@ declare module 'druid.druid' {
 		/**
 		 * The constructor for Drag component
 		 */
-		init(node_or_node_id: Opaque<"node"> | string, on_drag_callback: (self: unknown, touch: unknown) => void): void;
+		init(node_or_node_id: Opaque<"node"> | string, on_drag_callback: (self: unknown, dx: number, dy: number, x: number, y: number, touch: touch) => void): void;
 		/**
 		 * Set Drag component enabled state.
 		 */
@@ -248,14 +249,14 @@ declare module 'druid.druid' {
 	 */
 	interface druid_hover extends druid_component {
 		node: Opaque<"node">;
-		on_hover: unknown;
-		on_mouse_hover: unknown;
+		on_hover: event;
+		on_mouse_hover: event;
 		style: druid_hover_style;
 		click_zone: Opaque<"node">;
 		/**
 		 * The constructor for the hover component
 		 */
-		init(node: Opaque<"node">, on_hover_callback: unknown, on_mouse_hover: unknown): void;
+		init(node: Opaque<"node">, on_hover_callback: (...args: any[]) => unknown, on_mouse_hover: (...args: any[]) => unknown): void;
 		/**
 		 * Set hover state
 		 */
@@ -326,9 +327,9 @@ declare module 'druid.druid' {
 	interface druid_scroll extends druid_component {
 		node: Opaque<"node">;
 		click_zone?: Opaque<"node"> | undefined;
-		on_scroll: unknown;
-		on_scroll_to: unknown;
-		on_point_scroll: unknown;
+		on_scroll: event;
+		on_scroll_to: event;
+		on_point_scroll: event;
 		view_node: Opaque<"node">;
 		view_border: Vector4;
 		content_node: Opaque<"node">;
@@ -453,11 +454,11 @@ declare module 'druid.druid' {
 	 * The component for manage the nodes position in the grid with various options
 	 */
 	interface druid_grid extends druid_component {
-		on_add_item: unknown;
-		on_remove_item: unknown;
-		on_change_items: unknown;
-		on_clear: unknown;
-		on_update_positions: unknown;
+		on_add_item: event;
+		on_remove_item: event;
+		on_change_items: event;
+		on_clear: event;
+		on_update_positions: event;
 		parent: Opaque<"node">;
 		nodes: Opaque<"node">[];
 		first_index: number;
@@ -535,7 +536,7 @@ declare module 'druid.druid' {
 		/**
 		 * Change set position function for grid nodes. It will call on
 		 */
-		set_position_function(callback: unknown): druid_grid;
+		set_position_function(callback: (...args: any[]) => unknown): druid_grid;
 		/**
 		 * Clear grid nodes array. GUI nodes will be not deleted!
 		 */
@@ -555,7 +556,7 @@ declare module 'druid.druid' {
 		/**
 		 * Sort grid nodes by custom comparator function
 		 */
-		sort_nodes(comparator: unknown): druid_grid;
+		sort_nodes(comparator: (...args: any[]) => unknown): druid_grid;
 		_extend_border(border: Vector4, pos: Vector3, size: Vector3, pivot: Vector3): void;
 	}
 	interface druid_text_style {
@@ -586,9 +587,9 @@ declare module 'druid.druid' {
 	 */
 	interface druid_text extends druid_component {
 		node: Opaque<"node">;
-		on_set_text: unknown;
-		on_update_text_scale: unknown;
-		on_set_pivot: unknown;
+		on_set_text: event;
+		on_update_text_scale: event;
+		on_set_pivot: event;
 		style: druid_text_style;
 		start_pivot: number;
 		start_scale: Vector3;
@@ -607,6 +608,8 @@ declare module 'druid.druid' {
 		get_text_index_by_width(width: number): number;
 		/**
 		 * Set text to text field
+		 *
+		 * @deprecated
 		 */
 		set_to(set_to: string): druid_text;
 		set_text(): void;
@@ -944,7 +947,7 @@ declare module 'druid.druid' {
 		min_size_y?: number | undefined;
 		max_size_x?: number | undefined;
 		max_size_y?: number | undefined;
-		on_size_changed: unknown;
+		on_size_changed: event;
 		_parent_container: druid_container;
 		_containers: LuaTable;
 		_draggable_corners: LuaTable;
@@ -1027,16 +1030,16 @@ declare module 'druid.druid' {
 	interface druid_data_list extends druid_component {
 		scroll: druid_scroll;
 		grid: druid_grid;
-		on_scroll_progress_change: unknown;
-		on_element_add: unknown;
-		on_element_remove: unknown;
+		on_scroll_progress_change: event;
+		on_element_add: event;
+		on_element_remove: event;
 		top_index: number;
 		last_index: number;
 		scroll_progress: number;
 		/**
 		 * The DataList constructor
 		 */
-		init(scroll: druid_scroll, grid: druid_grid, create_function: unknown): void;
+		init(scroll: druid_scroll, grid: druid_grid, create_function: (...args: any[]) => unknown): void;
 		/**
 		 * Set use cache version of DataList. Requires make setup of components in on_element_add callback and clean in on_element_remove
 		 */
@@ -1101,13 +1104,13 @@ declare module 'druid.druid' {
 	 * - Hotkey can be set to repeat on key hold
 	 */
 	interface druid_hotkey extends druid_component {
-		on_hotkey_pressed: unknown;
-		on_hotkey_released: unknown;
+		on_hotkey_pressed: event;
+		on_hotkey_released: event;
 		style: druid_hotkey_style;
 		/**
 		 * The Hotkey constructor
 		 */
-		init(keys: string[] | string, callback: unknown, callback_argument?: unknown | undefined): void;
+		init(keys: string[] | string, callback: (...args: any[]) => unknown, callback_argument?: unknown | undefined): void;
 		/**
 		 * Add hotkey for component callback
 		 */
@@ -1146,13 +1149,13 @@ declare module 'druid.druid' {
 	 * - You can setup allowed characters. On add not allowed characters `on_input_wrong` will be called
 	 */
 	interface druid_input extends druid_component {
-		on_input_select: unknown;
-		on_input_unselect: unknown;
-		on_input_text: unknown;
-		on_input_empty: unknown;
-		on_input_full: unknown;
-		on_input_wrong: unknown;
-		on_select_cursor_change: unknown;
+		on_input_select: event;
+		on_input_unselect: event;
+		on_input_text: event;
+		on_input_empty: event;
+		on_input_full: event;
+		on_input_wrong: event;
+		on_select_cursor_change: event;
 		style: druid_input_style;
 		init(click_node: Opaque<"node">, text_node: Opaque<"node"> | druid_text, keyboard_type?: Opaque<"constant"> | undefined): void;
 		get_text_selected(): void;
@@ -1217,7 +1220,7 @@ declare module 'druid.druid' {
 	interface druid_lang_text extends druid_component {
 		text: druid_text;
 		node: Opaque<"node">;
-		on_change: unknown;
+		on_change: event;
 		init(node: string | Opaque<"node">, locale_id?: string | undefined, adjust_type?: string | undefined): void;
 		/**
 		 * Setup raw text to lang_text component. This will clear any locale settings.
@@ -1236,8 +1239,7 @@ declare module 'druid.druid' {
 		 */
 		format(...args: string[]): druid_lang_text;
 	}
-	interface event_on_size_changed {
-		subscribe: (_: unknown, callback: (new_size: Vector3) => void, context: unknown | undefined) => void;
+	interface event_on_size_changed extends event {
 	}
 	interface druid_layout_row_data {
 		width: number;
@@ -1249,7 +1251,7 @@ declare module 'druid.druid' {
 		total_height: number;
 		nodes_width: LuaTable<Opaque<"node">, number>;
 		nodes_height: LuaTable<Opaque<"node">, number>;
-		rows: unknown;
+		rows: druid_layout_row_data[];
 	}
 	/**
 	 * Druid component to manage the layout of nodes, placing them inside the node size with respect to the size and pivot of each node.
@@ -1301,7 +1303,7 @@ declare module 'druid.druid' {
 		 */
 		remove(node_or_node_id: Opaque<"node"> | string): druid_layout;
 		get_size(): Vector3;
-		get_content_size(): unknown;
+		get_content_size(): LuaMultiReturn<[number, number]>;
 		refresh_layout(is_instant?: boolean | undefined): druid_layout;
 		clear_layout(): druid_layout;
 		get_node_size(node: Opaque<"node">): LuaMultiReturn<[number, number]>;
@@ -1309,7 +1311,7 @@ declare module 'druid.druid' {
 		/**
 		 * Set custom position function for layout nodes. It will call on update poses on layout elements. Default: gui.set_position
 		 */
-		set_position_function(callback: unknown): druid_layout;
+		set_position_function(callback: (...args: any[]) => unknown): druid_layout;
 	}
 	interface druid_progress_style {
 		SPEED?: number | undefined;
@@ -1330,7 +1332,7 @@ declare module 'druid.druid' {
 	 */
 	interface druid_progress extends druid_component {
 		node: Opaque<"node">;
-		on_change: unknown;
+		on_change: event;
 		style: druid_progress_style;
 		key: string;
 		prop: Hash;
@@ -1355,11 +1357,11 @@ declare module 'druid.druid' {
 		/**
 		 * Set points on progress bar to fire the callback
 		 */
-		set_steps(steps: number[], callback: unknown): druid_progress;
+		set_steps(steps: number[], callback: (...args: any[]) => unknown): druid_progress;
 		/**
 		 * Start animation of a progress bar
 		 */
-		to(to: number, callback?: unknown | undefined): druid_progress;
+		to(to: number, callback?: ((...args: any[]) => unknown) | undefined): druid_progress;
 		/**
 		 * Set progress bar max node size
 		 */
@@ -1380,12 +1382,12 @@ declare module 'druid.druid' {
 	 */
 	interface druid_slider extends druid_component {
 		node: Opaque<"node">;
-		on_change_value: unknown;
+		on_change_value: event;
 		style: LuaTable;
 		/**
 		 * The Slider constructor
 		 */
-		init(node: Opaque<"node">, end_pos: Vector3, callback?: unknown | undefined): void;
+		init(node: Opaque<"node">, end_pos: Vector3, callback?: ((...args: any[]) => unknown) | undefined): void;
 		/**
 		 * Set value for slider
 		 */
@@ -1425,10 +1427,10 @@ declare module 'druid.druid' {
 	 */
 	interface druid_swipe extends druid_component {
 		node: Opaque<"node">;
-		on_swipe: unknown;
+		on_swipe: event;
 		style: druid_swipe_style;
 		click_zone: Opaque<"node">;
-		init(node_or_node_id: Opaque<"node"> | string, on_swipe_callback: unknown): void;
+		init(node_or_node_id: Opaque<"node"> | string, on_swipe_callback: (...args: any[]) => unknown): void;
 		/**
 		 * Set the click zone for the swipe, useful for restricting events outside stencil node
 		 */
@@ -1458,15 +1460,15 @@ declare module 'druid.druid' {
 	 * - Timer uses update function to handle time
 	 */
 	interface druid_timer extends druid_component {
-		on_tick: unknown;
-		on_set_enabled: unknown;
-		on_timer_end: unknown;
+		on_tick: event;
+		on_set_enabled: event;
+		on_timer_end: event;
 		node: Opaque<"node">;
 		from: number;
 		target: number;
 		value: number;
 		is_on?: boolean | undefined;
-		init(node: Opaque<"node">, seconds_from?: number | undefined, seconds_to?: number | undefined, callback?: unknown | undefined): void;
+		init(node: Opaque<"node">, seconds_from?: number | undefined, seconds_to?: number | undefined, callback?: ((...args: any[]) => unknown) | undefined): void;
 		/**
 		 * Set the timer to a specific value
 		 */
@@ -1617,7 +1619,7 @@ declare module 'druid.druid' {
 		/**
 		 * Create Button component
 		 */
-		new_button(node: string | Opaque<"node">, callback?: unknown | unknown | undefined, params?: unknown | undefined, anim_node?: Opaque<"node"> | string | undefined): druid_button;
+		new_button(node: string | Opaque<"node">, callback?: ((...args: any[]) => unknown) | event | undefined, params?: unknown | undefined, anim_node?: Opaque<"node"> | string | undefined): druid_button;
 		/**
 		 * Create Blocker component
 		 */
@@ -1625,11 +1627,11 @@ declare module 'druid.druid' {
 		/**
 		 * Create BackHandler component
 		 */
-		new_back_handler(callback?: unknown | unknown | undefined, params?: unknown | undefined): druid_back_handler;
+		new_back_handler(callback?: ((...args: any[]) => unknown) | event | undefined, params?: unknown | undefined): druid_back_handler;
 		/**
 		 * Create Hover component
 		 */
-		new_hover(node: string | Opaque<"node">, on_hover_callback?: unknown | undefined, on_mouse_hover_callback?: unknown | undefined): druid_hover;
+		new_hover(node: string | Opaque<"node">, on_hover_callback?: ((...args: any[]) => unknown) | undefined, on_mouse_hover_callback?: ((...args: any[]) => unknown) | undefined): druid_hover;
 		/**
 		 * Create Text component
 		 */
@@ -1645,11 +1647,11 @@ declare module 'druid.druid' {
 		/**
 		 * Create Drag component
 		 */
-		new_drag(node: string | Opaque<"node">, on_drag_callback?: unknown | undefined): druid_drag;
+		new_drag(node: string | Opaque<"node">, on_drag_callback?: ((...args: any[]) => unknown) | undefined): druid_drag;
 		/**
 		 * Create Swipe component
 		 */
-		new_swipe(node: string | Opaque<"node">, on_swipe_callback?: unknown | undefined): druid_swipe;
+		new_swipe(node: string | Opaque<"node">, on_swipe_callback?: ((...args: any[]) => unknown) | undefined): druid_swipe;
 		/**
 		 * Create LangText component
 		 */
@@ -1657,7 +1659,7 @@ declare module 'druid.druid' {
 		/**
 		 * Create Slider component
 		 */
-		new_slider(pin_node: string | Opaque<"node">, end_pos: Vector3, callback?: unknown | undefined): druid_slider;
+		new_slider(pin_node: string | Opaque<"node">, end_pos: Vector3, callback?: ((...args: any[]) => unknown) | undefined): druid_slider;
 		/**
 		 * Create Input component
 		 */
@@ -1665,11 +1667,11 @@ declare module 'druid.druid' {
 		/**
 		 * Create DataList component
 		 */
-		new_data_list(druid_scroll: druid_scroll, druid_grid: druid_grid, create_function: unknown): druid_data_list;
+		new_data_list(druid_scroll: druid_scroll, druid_grid: druid_grid, create_function: (...args: any[]) => unknown): druid_data_list;
 		/**
 		 * Create Timer component
 		 */
-		new_timer(node: string | Opaque<"node">, seconds_from?: number | undefined, seconds_to?: number | undefined, callback?: unknown | undefined): druid_timer;
+		new_timer(node: string | Opaque<"node">, seconds_from?: number | undefined, seconds_to?: number | undefined, callback?: ((...args: any[]) => unknown) | undefined): druid_timer;
 		/**
 		 * Create Progress component
 		 */
@@ -1685,7 +1687,7 @@ declare module 'druid.druid' {
 		/**
 		 * Create Hotkey component
 		 */
-		new_hotkey(keys_array: string | string[], callback?: unknown | unknown | undefined, callback_argument?: unknown | undefined): druid_hotkey;
+		new_hotkey(keys_array: string | string[], callback?: ((...args: any[]) => unknown) | event | undefined, callback_argument?: unknown | undefined): druid_hotkey;
 		/**
 		 * Create RichText component.
 		 */