@defold-typescript/library-types 0.18.1

package/generated/richtext.richtext.d.ts

@@ -0,0 +1,126 @@
+/**
+ * @see {@link https://github.com/britzl/defold-richtext|Github Source}
+ * @example `import * as richtext from 'richtext.richtext'`
+ * @noResolution
+ */
+declare module 'richtext.richtext' {
+	type FontSettings = {
+		regular: Hash;
+		italic: Hash;
+		bold: Hash;
+		bold_italic: Hash;
+	};
+
+	type FontsTable = {
+		[name: string]: FontSettings;
+	};
+
+	type LayersTable = {
+		fonts: LuaMap<Hash, Hash>; // { [font: hash]: hash };
+		images: LuaMap<Hash, Hash>; // { [texture: hash]: hash };
+		spinescenes: LuaMap<Hash, Hash>; // { [spinescene: hash]: hash };
+	};
+
+	type Settings = {
+		width?: number;
+		position?: Vector3;
+		size?: number;
+		parent?: Opaque<"node">;
+		fonts?: FontsTable;
+		layers?: LayersTable;
+		color?: Vector4;
+		shadow?: Vector4;
+		outline?: Vector4;
+		align?: Alignment;
+		valign?: VAlignment;
+		line_spacing?: number;
+		paragraph_spacing?: number;
+		image_pixel_grid_snap?: boolean;
+		combine_words?: boolean;
+		dryrun?: boolean;
+	};
+
+	type Word = {
+		size: number;
+		color: Vector4;
+		shadow: Vector4;
+		outline: Vector4;
+		node: Opaque<"node">;
+		metrics: {
+			width: number;
+			height: number;
+			total_width: number;
+			max_descent?: number;
+			max_ascent?: number;
+		};
+		font: string;
+		text: string;
+	};
+
+	type TextMetrics = {
+		width: number;
+		height: number;
+		char_count: number;
+		img_count: number;
+		spine_count: number;
+	};
+
+	/** Creates rich text gui nodes from a text containing markup. */
+	export function create(
+		text: string,
+		font: string,
+		settings?: Settings,
+	): LuaMultiReturn<[Word[], TextMetrics]>;
+
+	/** Get all words with a specific tag. */
+	export function tagged(words: Word[], tag: string): Word[];
+
+	/**
+	 * Truncate a text down to a specific length. This function has two modes of operation:
+	 * 1) It can truncate the text on a per word basis or
+	 * 2) on a per character/image basis.
+	 * The function will disable nodes that shouldn't be visible and in the case of truncating
+	 * on a per character basis also update the text in nodes that should be partially visible.
+	 * The text metrics of a truncated word will be updated.
+	 */
+	export function truncate(
+		words: Word[],
+		length: number,
+		options?: { words: boolean },
+	): Word;
+
+	/** Get the length of a text ignoring any tags except image and spine tags which are treated as having a length of 1. */
+	export function length(text: Word[] | string): number;
+
+	/** Split a word into it's characters, including the creation of the gui nodes. Each of the characters will be given the same attributes as the word, and they will be positioned correctly within the word. */
+	export function characters(word: Word): Word[];
+
+	/** Call this function when a click/touch has been detected and your text contains words with an a tag. These words act as "hyperlinks" and will generate a message when clicked. */
+	export function on_click(
+		words: Word[],
+		action: {
+			node_id: Hash;
+			text: string;
+			screen_x: number;
+			screen_y: number;
+			tags: string[];
+		},
+	): boolean;
+
+	/** Removes all gui text nodes created by richtext.create(). */
+	export function remove(words: Word[]): void;
+
+	/** Returns the words created by richtext.create() as a plain text string without any formatting or tags. Linebreaks are included in the returned string. */
+	export function plaintext(words: Word[]): string;
+
+	type Alignment = Hash & Readonly<{ __brand: 'richtext.alignment' }>;
+	type VAlignment = Hash & Readonly<{ __brand: 'richtext.v.alignment' }>;
+
+	export const ALIGN_LEFT: Alignment;
+	export const ALIGN_CENTER: Alignment;
+	export const ALIGN_RIGHT: Alignment;
+	export const ALIGN_JUSTIFY: Alignment;
+	export const VALIGN_TOP: VAlignment;
+	export const VALIGN_MIDDLE: VAlignment;
+	export const VALIGN_BOTTOM: VAlignment;
+}

package/generated/richtext.tags.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @see {@link https://github.com/britzl/defold-richtext|Github Source}
+ * @example `import * as tags from 'richtext.tags'`
+ * @noResolution
+ */
+declare module 'richtext.tags' {
+	export function register(
+		tag: string,
+		fn: (params?: string, settings?: {}) => void,
+	): void;
+	export function apply(tag: string, params?: string, settings?: {}): void;
+}

package/generated/saver.saver.d.ts

@@ -0,0 +1,44 @@
+/** @noSelfInFile **/
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * @see {@link https://github.com/Insality/defold-saver|Github Source}
+ * @see {@link https://github.com/Insality/defold-saver/blob/main/API_REFERENCE.md|API Reference}
+ * @example `import * as saver from 'saver.saver'`
+ * @noResolution
+ */
+declare module 'saver.saver' {
+	interface LoggerInstance {
+		trace(this: any, message: string, data?: {}): void;
+		debug(this: any, message: string, data?: {}): void;
+		info(this: any, message: string, data?: {}): void;
+		warn(this: any, message: string, data?: {}): void;
+		error(this: any, message: string, data?: {}): void;
+	}
+
+	export function init(): void;
+	export function bind_save_part(keyId: string, tableReference: any): void;
+	export function save_game_state(fileName?: string): boolean;
+	export function load_game_state(fileName?: string): boolean;
+	export function get_game_state(): unknown;
+	export function set_game_state(state: any): boolean;
+	export function save_file_by_path(data: any, filePath: string): boolean;
+	export function load_file_by_path(path: string): unknown;
+	export function save_file_by_name(data: any, fileName: string): boolean;
+	export function load_file_by_name(fileName: string): unknown;
+	export function set_autosave_timer(seconds: number): void;
+	export function get_save_path(fileName?: string): string;
+	export function get_save_version(): number;
+	export function set_migrations(
+		migrationList: ((
+			this: void,
+			gameState: any,
+			logger: LoggerInstance,
+		) => any)[],
+	): void;
+	export function apply_migrations(): void;
+	export function set_logger(logger: LoggerInstance): void;
+	export function set_logger(remove_logger: undefined): void;
+	export function get_current_game_project_folder(): string | undefined;
+}

package/generated/saver.storage.d.ts

@@ -0,0 +1,16 @@
+/** @noSelfInFile **/
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * @see {@link https://github.com/Insality/defold-saver|Github Source}
+ * @see {@link https://github.com/Insality/defold-saver/blob/main/API_REFERENCE.md|API Reference}
+ * @example `import * as storage from 'saver.storage'`
+ * @noResolution
+ */
+declare module 'saver.storage' {
+	export function set(id: string, value: boolean | number | string): boolean;
+	export function get(id: string, defaultValue?: any): unknown;
+	export function get_number(id: string, defaultValue?: number): number;
+	export function get_string(id: string, defaultValue?: string): string;
+	export function get_boolean(id: string, defaultValue?: boolean): boolean;
+}

package/generated/squid.squid.d.ts

@@ -0,0 +1,106 @@
+/** @noSelfInFile **/
+
+/**
+ * Squid is a standalone injectable system for saveable logging of user logs, errors and crashes for Defold.
+ * @see {@link https://github.com/paweljarosz/squid|Github Source}
+ * @example `import * as squid from 'squid.squid'`
+ * @noResolution
+ */
+declare module 'squid.squid' {
+	type SquidConfig = {
+		app_catalog: string;
+		log_file_name: string;
+		log_file_extension: string;
+		is_enabled: boolean;
+		is_enabled_in_release: boolean;
+		is_printing: boolean;
+		is_saving: boolean;
+		is_adding_timestamp: boolean;
+		is_using_allowlist: boolean;
+		days_to_delete_logs: number;
+		min_log_level: number;
+		unsaved_logs_buffer: number;
+		max_data_length: number;
+		max_data_depth: number;
+		is_printing_crashes: boolean;
+		is_saving_crashes: boolean;
+		crash_file_name: string;
+		crash_file_extension: string;
+	};
+
+	interface SquidShared {
+		ALLOWLIST: { [key: string]: boolean };
+	}
+
+	/** @noSelf **/
+	interface CoreModule extends SquidShared {
+		TRACE: number;
+		DEBUG: number;
+		INFO: number;
+		WARN: number;
+		ERROR: number;
+		/** Create a new instance of the Squid logger */
+		['new'](tag?: string, is_allowed?: boolean): SquidInstance;
+
+		/** Get Squid configuration */
+		get_config(): SquidConfig;
+		/** Set and use user configuration */
+		set_config(config: SquidConfig): void;
+
+		/** Initialize Squid for error and crash handling and logging */
+		init(): void;
+
+		/** Set if logs should be saved to file */
+		set_allowed(tag: string, enabled: boolean): void;
+
+		trace(message: string, data?: AnyNotNil, tag?: string): void;
+		debug(message: string, data?: AnyNotNil, tag?: string): void;
+		info(message: string, data?: AnyNotNil, tag?: string): void;
+		warn(message: string, data?: AnyNotNil, tag?: string): void;
+		error(message: string, data?: AnyNotNil, tag?: string): void;
+
+		/** Log message with provided level, message, data and tag */
+		log(message: string, level: number, data?: AnyNotNil, tag?: string): void;
+
+		/**
+		 * Explicitly save buffer of unsaved logs to file
+		 * @returns true if saved logs successfully, false otherwise
+		 */
+		save_logs(): boolean;
+
+		/** Finalize Squid logging - check for crashes and saved all unsaved buffered logs */
+		final(): void;
+	}
+
+	interface SquidInstance extends SquidShared {
+		tag: string;
+
+		/** Initialize Squid for error and crash handling and logging */
+		init(): void;
+
+		/** Set if logs should be saved to file */
+		set_allowed(tag: string, enabled: boolean): void;
+
+		trace(message: string, data?: AnyNotNil, tag?: string): void;
+		debug(message: string, data?: AnyNotNil, tag?: string): void;
+		info(message: string, data?: AnyNotNil, tag?: string): void;
+		warn(message: string, data?: AnyNotNil, tag?: string): void;
+		error(message: string, data?: AnyNotNil, tag?: string): void;
+
+		/** Log message with provided level, message, data and tag */
+		log(message: string, level: number, data?: AnyNotNil, tag?: string): void;
+
+		/**
+		 * Explicitly save buffer of unsaved logs to file
+		 * @returns true if saved logs successfully, false otherwise
+		 */
+		save_logs(): boolean;
+
+		/** Finalize Squid logging - check for crashes and saved all unsaved buffered logs */
+		final(): void;
+	}
+
+	type Squid = Readonly<CoreModule>;
+	const exportThis: Squid;
+	export = exportThis;
+}

package/generated/starly.starly.d.ts

@@ -0,0 +1,148 @@
+/** @noSelfInFile **/
+
+/**
+ * @see {@link https://github.com/VowSoftware/starly|Github Source}
+ * @example `import * as starly from 'starly.starly'`
+ * @noResolution
+ */
+declare module 'starly.starly' {
+	interface CoreModule {
+		c_display_width: number;
+		c_display_height: number;
+		c_display_ratio: number;
+		c_behavior_center: Hash;
+		c_behavior_expand: Hash;
+		c_behavior_mixed: Hash;
+		c_behavior_stretch: Hash;
+
+		/**
+		 * Creates a camera. This function is called automatically in the game object's script component.
+		 * @param id Camera game object id.
+		 */
+		create(id: Hash): void;
+		/**
+		 * Destroys a camera. This function is called automatically in the game object's script component.
+		 * @param id Camera game object id.
+		 */
+		destroy(id: Hash): void;
+		/**
+		 * Activates a camera. This function should be called in the render script before any making any draw calls.
+		 * @param id Camera game object id.
+		 * @returns frustum
+		 */
+		activate(id: Hash): Matrix4;
+		/**
+		 * Shakes a camera.
+		 * @param id Camera game object id.
+		 * @param count Amount of pingpong movements.
+		 * @param duration Duration of each pingpong.
+		 * @param radius Distance of each pingpong.
+		 * @param [durationScalar] After each pingpong, the duration is scaled by this value.
+		 * @param [radiusScalar] After each pingpong, the radius is scaled by this value.
+		 */
+		shake(
+			id: Hash,
+			count: number,
+			duration: number,
+			radius: number,
+			durationScalar?: number,
+			radiusScalar?: number,
+		): void;
+		/**
+		 * Cancels an ongoing camera shake.
+		 * @param id Camera game object id.
+		 */
+		cancel_shake(id: Hash): void;
+		/**
+		 * Checks if a camera is shaking.
+		 * @param id Camera game object id.
+		 */
+		is_shaking(id: Hash): boolean;
+		/**
+		 * Gets the position offset of a camera after moving distance units, accounting for zoom and rotation.
+		 * @param id Camera game object id.
+		 * @param distance Position offset, before accounting for zoom and rotation.
+		 * @param absolute Determines if `distance` is in absolute world coordinates, which ignore rotation.
+		 */
+		get_offset(
+			id: Hash,
+			distance: Vector3,
+			absolute: boolean,
+		): Vector3;
+		/**
+		 * Gets the world area of a camera, which is defined as the rectangular area of the world that the camera can see, in world coordinates.
+		 * @param id Camera game object id.
+		 * @returns x, y, width, height
+		 */
+		get_world_area(id: Hash): LuaMultiReturn<[number, number, number, number]>;
+		/**
+		 * Gets the center position, minimum zoom, and minimum world area of a camera that can see all positions.
+		 *
+		 * This function was inspired by Super Smash Bros, where the camera moves and zooms to center and include all characters, with only a small amount of padding to the sides of the window.
+		 * @param id Camera game object id.
+		 * @param positions Array of `vector3` positions, in world coordinates.
+		 * @returns position, zoom, x, y, width, height
+		 */
+		get_tight_world_area(
+			id: Hash,
+			positions: Vector3[],
+		): LuaMultiReturn<[Vector3, number, number, number, number, number]>;
+		/**
+		 * Converts screen coordinates to world coordinates.
+		 * @param id Camera game object id.
+		 * @param screenX
+		 * @param screenY
+		 * @param [visible] Determines if the cursor must be visible to the camera. If `true`, then this function returns `undefined` when the cursor is outside the camera's viewport.
+		 */
+		screen_to_world(
+			id: Hash,
+			screenX: number,
+			screenY: number,
+			visible?: boolean,
+		): Vector3 | undefined;
+		/**
+		 * Converts world coordinates to screen coordinates.
+		 * @param id Camera game object id.
+		 * @param worldPosition
+		 * @param [visible] Determines if the cursor must be visible to the camera. If `true`, then this function returns `undefined` when the cursor is outside the camera's viewport.
+		 */
+		world_to_screen(
+			id: Hash,
+			worldPosition: Vector3,
+			visible?: boolean,
+		): Vector3 | undefined;
+		/**
+		 * Gets the viewport of a camera, in screen coordinates.
+		 * @param id Camera game object id.
+		 * @returns x, y, width, height
+		 */
+		get_viewport(id: Hash): LuaMultiReturn<[number, number, number, number]>;
+		/**
+		 * Gets the view of a camera.
+		 * @param id Camera game object id.
+		 */
+		get_view(id: Hash): Matrix4;
+		/**
+		 * Gets the projection of a camera.
+		 * @param id Camera game object id.
+		 */
+		get_projection(id: Hash): Matrix4;
+	}
+	type CameraMap = LuaMap<
+		Hash,
+		{
+			behavior: Hash;
+			viewport_x: number;
+			viewport_y: number;
+			viewport_width: number;
+			viewport_height: number;
+			near: number;
+			far: number;
+			zoom: number;
+		}
+	>;
+
+	type Starley = CameraMap & Readonly<CoreModule>;
+	const exportThis: Starley;
+	export = exportThis;
+}

package/generated/tweener.tweener.d.ts

@@ -0,0 +1,151 @@
+/** @noSelfInFile */
+
+/**
+ * Timer Based Defold Tween Library
+ * @see {@link https://github.com/Insality/defold-tweener|Github Source}
+ * @noResolution
+ */
+declare module 'tweener.tweener' {
+	type TweenFunc = Readonly<{ __brand: 'tweener' }> & number;
+	type AnyTweenFunc =
+		| TweenFunc
+		| typeof go.EASING_INBACK
+		| typeof go.EASING_INBOUNCE
+		| typeof go.EASING_INCIRC
+		| typeof go.EASING_INCUBIC
+		| typeof go.EASING_INELASTIC
+		| typeof go.EASING_INEXPO
+		| typeof go.EASING_INOUTBACK
+		| typeof go.EASING_INOUTBOUNCE
+		| typeof go.EASING_INOUTCIRC
+		| typeof go.EASING_INOUTCUBIC
+		| typeof go.EASING_INOUTELASTIC
+		| typeof go.EASING_INOUTEXPO
+		| typeof go.EASING_INOUTQUAD
+		| typeof go.EASING_INOUTQUART
+		| typeof go.EASING_INOUTQUINT
+		| typeof go.EASING_INOUTSINE
+		| typeof go.EASING_INQUAD
+		| typeof go.EASING_INQUART
+		| typeof go.EASING_INQUINT
+		| typeof go.EASING_INSINE
+		| typeof go.EASING_LINEAR
+		| typeof go.EASING_OUTBACK
+		| typeof go.EASING_OUTBOUNCE
+		| typeof go.EASING_OUTCIRC
+		| typeof go.EASING_OUTCUBIC
+		| typeof go.EASING_OUTELASTIC
+		| typeof go.EASING_OUTEXPO
+		| typeof go.EASING_OUTINBACK
+		| typeof go.EASING_OUTINBOUNCE
+		| typeof go.EASING_OUTINCIRC
+		| typeof go.EASING_OUTINCUBIC
+		| typeof go.EASING_OUTINELASTIC
+		| typeof go.EASING_OUTINEXPO
+		| typeof go.EASING_OUTINQUAD
+		| typeof go.EASING_OUTINQUART
+		| typeof go.EASING_OUTINQUINT
+		| typeof go.EASING_OUTINSINE
+		| typeof go.EASING_OUTQUAD
+		| typeof go.EASING_OUTQUART
+		| typeof go.EASING_OUTQUINT
+		| typeof go.EASING_OUTSINE
+		| typeof gui.EASING_INBACK
+		| typeof gui.EASING_INBOUNCE
+		| typeof gui.EASING_INCIRC
+		| typeof gui.EASING_INCUBIC
+		| typeof gui.EASING_INELASTIC
+		| typeof gui.EASING_INEXPO
+		| typeof gui.EASING_INOUTBACK
+		| typeof gui.EASING_INOUTBOUNCE
+		| typeof gui.EASING_INOUTCIRC
+		| typeof gui.EASING_INOUTCUBIC
+		| typeof gui.EASING_INOUTELASTIC
+		| typeof gui.EASING_INOUTEXPO
+		| typeof gui.EASING_INOUTQUAD
+		| typeof gui.EASING_INOUTQUART
+		| typeof gui.EASING_INOUTQUINT
+		| typeof gui.EASING_INOUTSINE
+		| typeof gui.EASING_INQUAD
+		| typeof gui.EASING_INQUART
+		| typeof gui.EASING_INQUINT
+		| typeof gui.EASING_INSINE
+		| typeof gui.EASING_LINEAR
+		| typeof gui.EASING_OUTBACK
+		| typeof gui.EASING_OUTBOUNCE
+		| typeof gui.EASING_OUTCIRC
+		| typeof gui.EASING_OUTCUBIC
+		| typeof gui.EASING_OUTELASTIC
+		| typeof gui.EASING_OUTEXPO
+		| typeof gui.EASING_OUTINBACK
+		| typeof gui.EASING_OUTINBOUNCE
+		| typeof gui.EASING_OUTINCIRC
+		| typeof gui.EASING_OUTINCUBIC
+		| typeof gui.EASING_OUTINELASTIC
+		| typeof gui.EASING_OUTINEXPO
+		| typeof gui.EASING_OUTINQUAD
+		| typeof gui.EASING_OUTINQUART
+		| typeof gui.EASING_OUTINQUINT
+		| typeof gui.EASING_OUTINSINE
+		| typeof gui.EASING_OUTQUAD
+		| typeof gui.EASING_OUTQUART
+		| typeof gui.EASING_OUTQUINT
+		| typeof gui.EASING_OUTSINE;
+	export const insine: TweenFunc;
+	export const inquad: TweenFunc;
+	export const incubic: TweenFunc;
+	export const incirc: TweenFunc;
+	export const inquart: TweenFunc;
+	export const inquint: TweenFunc;
+	export const inexpo: TweenFunc;
+	export const inback: TweenFunc;
+	export const inelastic: TweenFunc;
+	export const inbounce: TweenFunc;
+	export const outsine: TweenFunc;
+	export const outquad: TweenFunc;
+	export const outcubic: TweenFunc;
+	export const outcirc: TweenFunc;
+	export const outquart: TweenFunc;
+	export const outquint: TweenFunc;
+	export const outexpo: TweenFunc;
+	export const outback: TweenFunc;
+	export const outelastic: TweenFunc;
+	export const outbounce: TweenFunc;
+	export const inoutsine: TweenFunc;
+	export const inoutquad: TweenFunc;
+	export const inoutcubic: TweenFunc;
+	export const inoutcirc: TweenFunc;
+	export const inoutquart: TweenFunc;
+	export const inoutquint: TweenFunc;
+	export const inoutexpo: TweenFunc;
+	export const inoutback: TweenFunc;
+	export const inoutelastic: TweenFunc;
+	export const inoutbounce: TweenFunc;
+	export const outinsine: TweenFunc;
+	export const outinquad: TweenFunc;
+	export const outincubic: TweenFunc;
+	export const outincirc: TweenFunc;
+	export const outinquart: TweenFunc;
+	export const outinquint: TweenFunc;
+	export const outinexpo: TweenFunc;
+	export const outinback: TweenFunc;
+	export const outinelastic: TweenFunc;
+	export const outinbounce: TweenFunc;
+
+	export function tween(
+		tween_function: AnyTweenFunc,
+		from: number,
+		to: number,
+		time: number,
+		callback: (value: number, is_final_call: boolean) => void,
+		dt?: number,
+	): Hash;
+
+	export function ease(
+		tween_function: AnyTweenFunc,
+		from: number,
+		to: number,
+		time: number,
+		time_elapsed: number,
+	): number;
+}