@defold-typescript/library-types 0.18.1

package/generated/orthographic.camera.d.ts

@@ -0,0 +1,308 @@
+/** @noSelfInFile **/
+
+/**
+ * @see {@link https://github.com/britzl/defold-orthographic|Github Source}
+ * @noResolution
+ */
+declare module 'orthographic.camera' {
+	/**
+	 * Follow a game object.
+	 * @param camera_id undefined for the first camera
+	 * @param target Game object to follow
+	 * @param options Options
+	 */
+	export function follow(
+		camera_id: Hash | Url | undefined,
+		target: Hash | Url,
+		options?: {
+			/**
+			 *  Lerp from current position to target position with lerp as t.
+			 */
+			lerp?: number;
+			/**
+			 *  Camera offset from target position.
+			 */
+			offset?: Vector3;
+			/**
+			 *  True if following the target along the horizontal axis.
+			 */
+			horizontal?: boolean;
+			/**
+			 *  True if following the target along the vertical axis.
+			 */
+			vertical?: boolean;
+			/**
+			 * True if the camera should be immediately positioned on the target even when lerping.
+			 */
+			immediate?: boolean;
+		},
+	): void;
+
+	/**
+	 * Get the current zoom level of the camera.
+	 * @param camera_id (hash | url), undefined for the first camera
+	 */
+	export function get_zoom(camera_id: Hash | Url | undefined): number;
+
+	/**
+	 * Change the zoom level of the camera.
+	 * @param camera_id undefined for the first camera
+	 * @param zoom  The new zoom level of the camera
+	 */
+	export function set_zoom(
+		camera_id: Hash | Url | undefined,
+		zoom: number,
+	): void;
+
+	/**
+	 * Shake the camera.
+	 * @param camera_id undefined for the first camera
+	 * @param intensity Intensity of the shake, in percent of screen. Defaults to 0.05
+	 * @param duration Duration of the shake, in seconds. Defaults to 0.5
+	 * @param direction Direction of the shake. Possible values: `both`, `horizontal`, `vertical`. Defaults to `both`.
+	 * @param cb Function to call when the shake has finished. Optional.
+	 */
+	export function shake(
+		camera_id: Hash | Url | undefined,
+		intensity?: number,
+		duration?: number,
+		direction?: { both?: boolean; horizontal?: boolean; vertical?: boolean },
+		cb?: () => void,
+	): void;
+
+	/**
+	 * Stop shaking the camera.
+	 * @param camera_id (hash | url), undefined for the first camera
+	 */
+	export function stop_shaking(camera_id: Hash | Url | undefined): void;
+
+	/**
+	 * Translate screen coordinates to world coordinates, based on the view and projection of the camera.
+	 * @param camera_id (hash | url), undefined for the first camera
+	 * @param screen Screen coordinates to convert
+	 */
+	export function screen_to_world(
+		camera_id: Hash | Url | undefined,
+		screen: Vector3,
+	): Vector3;
+
+	/**
+	 * Translate window coordinates to world coordinates, based on the view and projection of the camera.
+	 * @param camera_id (hash | url), undefined for the first camera
+	 * @param window Window coordinates to convert
+	 */
+	export function window_to_world(
+		camera_id: Hash | Url | undefined,
+		window: Vector3,
+	): Vector3;
+
+	/**
+	 * Get the display size (ie from game.project).
+	 */
+	export function get_display_size(): LuaMultiReturn<[number, number]>;
+
+	/**
+	 * Get window size.
+	 */
+	export function get_window_size(): LuaMultiReturn<[number, number]>;
+
+	/**
+	 * Get list of camera ids.
+	 */
+	export function get_cameras(): Array<Hash | Url | undefined>;
+
+	/**
+	 * Get the current view of the camera.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function get_view(camera_id: Hash | Url | undefined): Matrix4;
+
+	/**
+	 * Get the current viewport of the camera.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function get_viewport(
+		camera_id: Hash | Url | undefined,
+	): LuaMultiReturn<[number, number, number, number]>;
+
+	/**
+	 * Get the current projection of the camera.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function get_projection(
+		camera_id: Hash | Url | undefined,
+	): Matrix4;
+
+	/**
+	 * Get the current projection id of the camera.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function get_projection_id(camera_id: Hash | Url | undefined): Hash;
+
+	/**
+	 * Apply a recoil effect to the camera. The recoil will decay using linear interpolation.
+	 * @param camera_id
+	 * @param offset Offset to apply to the camera. Defaults to 0.05
+	 * @param duration Duration of the recoil, in seconds. Defaults to 0.5
+	 */
+	export function recoil(
+		camera_id: Hash | Url,
+		offset: Vector3,
+		duration?: number,
+	): void;
+
+	/**
+	 * Get the current offset of the camera (caused by shake or recoil)
+	 * @param camera_id undefined for the first camera
+	 */
+	export function get_offset(camera_id: Hash | Url | undefined): Vector3;
+
+	/**
+	 * Change the camera follow offset.
+	 * @param camera_id undefined for the first camera
+	 * @param offset Camera offset from target position.
+	 */
+	export function follow_offset(
+		camera_id: Hash | Url | undefined,
+		offset: Vector3,
+	): void;
+
+	/**
+	 * Stop following a game object.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function unfollow(camera_id: Hash | Url | undefined): void;
+
+	/**
+	 * If following a game object this will add a deadzone around the camera position where the camera position will not update. If the target moves to the edge of the deadzone the camera will start to follow until the target returns within the bounds of the deadzone.
+	 * @param camera_id undefined for the first camera
+	 * @param left Number of pixels to the left of the camera
+	 * @param top Number of pixels above the camera
+	 * @param right Number of pixels to the right of the camera
+	 * @param bottom Number of pixels below the camera
+	 */
+	export function deadzone(
+		camera_id: Hash | Url | undefined,
+		left: number,
+		top: number,
+		right: number,
+		bottom: number,
+	): void;
+
+	/**
+	 * Limits the camera position to within the specified rectangle.
+	 * @param camera_id undefined for the first camera
+	 * @param left Left edge of the camera bounds
+	 * @param top Top edge of camera bounds
+	 * @param right  Right edge of camera bounds
+	 * @param bottom Bottom edge of camera bounds
+	 */
+	export function bounds(
+		camera_id: Hash | Url | undefined,
+		left: number,
+		top: number,
+		right: number,
+		bottom: number,
+	): void;
+
+	/**
+	 * Translate screen boundaries (corners) to world coordinates, based on the view and projection of the camera.
+	 * @param camera_id undefined for the first camera
+	 */
+	export function screen_to_world_bounds(
+		camera_id: Hash | Url | undefined,
+	): Vector4;
+
+	/**
+	 * Translate world coordinates to screen coordinates, based on the view and projection of the camera, optionally taking into account an adjust mode. This is useful when manually culling game objects and you need to determine if a world coordinate will be visible or not. It can also be used to position gui nodes on top of game objects.
+	 * @param camera_id undefined for the first camera
+	 * @param world World coordinates to convert
+	 * @param adjust_mode One of gui.ADJUST_FIT, gui.ADJUST_ZOOM and gui.ADJUST_STRETCH, or undefined to not take into account the adjust mode.
+	 */
+	export function world_to_screen(
+		camera_id: Hash | Url | undefined,
+		world: Vector3,
+		adjust_mode?:
+			| typeof gui.ADJUST_FIT
+			| typeof gui.ADJUST_STRETCH
+			| typeof gui.ADJUST_ZOOM,
+	): Vector3;
+
+	/**
+	 * Translate screen coordinates to world coordinates using the specified view and projection.
+	 * @param view
+	 * @param projection
+	 * @param screen Screen coordinates to convert
+	 */
+	export function unproject(
+		view: Matrix4,
+		projection: Matrix4,
+		screen: Vector3,
+	): Vector3;
+
+	/**
+	 * Translate world coordinates to screen coordinates using the specified view and projection.
+	 * @param view
+	 * @param projection
+	 * @param world World coordinates to convert
+	 */
+	export function project(
+		view: Matrix4,
+		projection: Matrix4,
+		world: Vector3,
+	): Vector3;
+
+	/**
+	 * Add a custom projector that can be used by cameras in your project (see configuration above).
+	 * @param projector_id  Id of the projector. Used as a value in the projection field of the camera script.
+	 * @param projector_fn The function to call when a projection matrix is needed for the camera. The function will receive the id, near_z and far_z values of the camera.
+	 */
+	export function add_projector(
+		projector_id: Hash,
+		projector_fn: (id: Hash, near_z: number, far_z: number) => void,
+	): void;
+
+	/**
+	 * Set a specific projector for a camera. This must be either one of the predefined projectors (see above) or a custom projector added using `camera.add_projector()`.
+	 * @param camera_id undefined for the first camera
+	 * @param projector_id  Id of the projector.
+	 */
+	export function use_projector(
+		camera_id: Hash | Url | undefined,
+		projector_id: Hash,
+	): void;
+
+	/**
+	 * Set window scaling factor (basically retina or no retina screen). There is no built-in way to detect if Defold is running on a retina or non retina screen. This information combined with the High DPI setting in game.project can be used to ensure that the zoom behaves the same way regardless of screen type and High DPI setting. You can use an extension such as DefOS to get the window scaling factor.
+	 * @param scaling_factor Current window scaling factor
+	 */
+	export function set_window_scaling_factor(scaling_factor: number): void;
+
+	export const PROJECTOR: {
+		FIXED_ZOOM: Hash;
+		DEFAULT: Hash;
+		FIXED_AUTO: Hash;
+	};
+
+	export const SHAKE_BOTH: Hash;
+	export const SHAKE_VERTICAL: Hash;
+	export const SHAKE_HORIZONTAL: Hash;
+
+	export const ORTHOGRAPHIC_RENDER_SCRIPT_USED: boolean;
+
+	export const MSG_DISABLE: Hash;
+	export const MSG_UNFOLLOW: Hash;
+	export const MSG_FOLLOW: Hash;
+	export const MSG_FOLLOW_OFFSET: Hash;
+	export const MSG_RECOIL: Hash;
+	export const MSG_SHAKE: Hash;
+	export const MSG_SHAKE_COMPLETED: Hash;
+	export const MSG_STOP_SHAKING: Hash;
+	export const MSG_DEADZONE: Hash;
+	export const MSG_BOUNDS: Hash;
+	export const MSG_UPDATE_CAMERA: Hash;
+	export const MSG_ZOOM_TO: Hash;
+	export const MSG_USE_PROJECTION: Hash;
+	export const MSG_VIEWPORT: Hash;
+	export const MSG_ENABLE: Hash;
+}

package/generated/persist.persist.d.ts

@@ -0,0 +1,34 @@
+/** @noSelfInFile */
+
+/**
+ * A simple interface for saving and loading data.
+ * @see {@link https://github.com/klaytonkowalski/library-defold-persist|Github Source}
+ * @example `import * as persist from 'persist.persist'`
+ * @noResolution
+ */
+declare module 'persist.persist' {
+	/**
+	 * Creates a file with the specified data.
+	 * If the file already exists, then its data can be overwritten.
+	 */
+	export function create(
+		file_name: string,
+		data: any,
+		overwrite?: boolean,
+	): void;
+
+	/** Writes data to a file. */
+	export function write(file_name: string, key: string, value: any): void;
+
+	/** Flushes unsaved data from a file. If a key is specified, then only that field is flushed. */
+	export function flush(file_name: string, key?: string): void;
+
+	/** Saves data that was written to a file. */
+	export function save(file_name: string): void;
+
+	/**
+	 * Loads data from a file, including data that has not yet been saved.
+	 * Returns an `object`, or `undefined` if the file does not exist.
+	 */
+	export function load(file_name: string): {} | undefined;
+}

package/generated/platypus.platypus.d.ts

@@ -0,0 +1,76 @@
+/** @noSelfInFile */
+
+/**
+ * Defold platformer engine
+ * @see {@link https://github.com/britzl/platypus|Github Source}
+ * @example `import * as platypus from 'platypus.platypus'`
+ * @noResolution
+ */
+declare module 'platypus.platypus' {
+	interface PlatypusConfig {
+		collisions: {
+			groups: LuaMap<Hash, Direction>;
+			left: number;
+			right: number;
+			top: number;
+			bottom: number;
+			offset?: Vector3;
+		};
+		debug?: boolean;
+		reparent?: boolean;
+		gravity?: number;
+		max_velocity?: number;
+		wall_jump_power_ratio_x?: number;
+		wall_jump_power_ratio_y?: number;
+		allow_double_jump?: boolean;
+		allow_wall_jump?: boolean;
+		const_wall_jump?: boolean;
+		allow_wall_slide?: boolean;
+		wall_slide_velocity?: number;
+	}
+
+	/** @noSelf **/
+	interface PlatypusInstance extends PlatypusConfig {
+		velocity: Vector3;
+		update(dt: number): void;
+		on_message(message_id: Hash, message: AnyNotNil): void;
+		left(velocity: number): void;
+		right(velocity: number): void;
+		up(velocity: number): void;
+		down(velocity: number): void;
+		move(velocity: Vector3): void;
+		jump(power: number): void;
+		force_jump(power: number): void;
+		abort_jump(reduction: number): void;
+		abort_wall_slide(): void;
+		has_ground_contact(): boolean;
+		has_wall_contact(): boolean;
+		is_falling(): boolean;
+		is_jumping(): boolean;
+		is_wall_jumping(): boolean;
+		is_wall_sliding(): boolean;
+		toggle_debug(): void;
+		set_collisions(collisions: {
+			top: number;
+			left: number;
+			right: number;
+			bottom: number;
+		}): void;
+	}
+
+	export function create(config: PlatypusConfig): PlatypusInstance;
+	export const FALLING: Hash;
+	export const GROUND_CONTACT: Hash;
+	export const WALL_CONTACT: Hash;
+	export const JUMP: Hash;
+	export const WALL_JUMP: Hash;
+	export const DOUBLE_JUMP: Hash;
+	export const WALL_SLIDE: Hash;
+
+	type Direction = number;
+	export const DIR_UP: Direction;
+	export const DIR_LEFT: Direction;
+	export const DIR_RIGHT: Direction;
+	export const DIR_DOWN: Direction;
+	export const DIR_ALL: Direction;
+}

package/generated/proto.proto.d.ts

@@ -0,0 +1,36 @@
+/** @noSelfInFile **/
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * @see {@link https://github.com/Insality/defold-proto|Github Source}
+ * @see {@link https://github.com/Insality/defold-proto/blob/main/API_REFERENCE.md|API Reference}
+ * @example `import * as proto from 'proto.proto'`
+ * @noResolution
+ */
+declare module 'proto.proto' {
+	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(configOrPath: string | { [key: string]: string }): void;
+	export function get(protoType: string): { [key: string]: unknown };
+	export function encode(
+		protoType: string,
+		data: { [key: string]: any },
+	): string;
+	export function decode(
+		protoType: string,
+		data?: string,
+	): { [key: string]: unknown };
+	export function verify(
+		protoType: string,
+		data: { [key: string]: any },
+	): { [key: string]: unknown };
+	export function set_logger(logger_instance: LoggerInstance): void;
+	export function set_logger(remove_logger_instance: undefined): void;
+}

package/generated/rendy.rendy.d.ts

@@ -0,0 +1,184 @@
+/** @noSelfInFile **/
+
+/** 
+ * A versatile camera suite and render pipeline
+ * @see {@link https://github.com/klaytonkowalski/library-defold-rendy|Github Source}
+ * @noResolution
+ * @example `import * as rendy from 'rendy.rendy'`
+ */
+declare module 'rendy.rendy' {
+	type CameraId = Hash | string;
+
+	/**
+	 * Creates a camera. This function is called automatically by the rendy.go game object.
+	 * @param camera_id - The identifier for the camera.
+	 */
+	function create_camera(camera_id: CameraId): void;
+
+	/**
+	 * Destroys a camera. This function is called automatically by the rendy.go game object.
+	 * @param camera_id - The identifier for the camera to be destroyed.
+	 */
+	function destroy_camera(camera_id: CameraId): void;
+
+	/**
+	 * Sets a camera property. This function replaces the standard go.set().
+	 * @param camera_id - The identifier for the camera.
+	 * @param property - The property to be set.
+	 * @param value - The value to set the property to.
+	 */
+	function set(camera_id: CameraId, property: Hash | string, value: any): void;
+
+	/**
+	 * Animates a camera property. This function replaces the standard go.animate().
+	 * @param camera_id - The identifier for the camera.
+	 * @param property - The property to be animated.
+	 * @param playback - The playback mode of the animation.
+	 * @param to - The target value of the animation.
+	 * @param easing - The easing function for the animation.
+	 * @param duration - The duration of the animation.
+	 * @param delay - Optional delay before starting the animation.
+	 * @param complete_function - Optional function to be called when the animation is complete.
+	 */
+	function animate(
+		camera_id: CameraId,
+		property: Hash | string,
+		playback:
+			| typeof go.PLAYBACK_LOOP_BACKWARD
+			| typeof go.PLAYBACK_LOOP_FORWARD
+			| typeof go.PLAYBACK_LOOP_PINGPONG
+			| typeof go.PLAYBACK_ONCE_BACKWARD
+			| typeof go.PLAYBACK_ONCE_FORWARD
+			| typeof go.PLAYBACK_ONCE_PINGPONG,
+		to: Quaternion | Vector3 | Vector4 | number,
+		easing:
+			| Vector3
+			| 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,
+		duration: number,
+		delay?: number,
+		complete_function?: (this: any, url: Url, property: Hash) => void,
+	): void;
+
+	/**
+	 * Cancels a camera property animation. This function replaces the standard go.cancel_animations().
+	 * @param camera_id - The identifier for the camera.
+	 * @param property - The property of the animation to be cancelled.
+	 */
+	function cancel_animations(
+		camera_id: CameraId,
+		property: Hash | string,
+	): void;
+
+	/**
+	 * Gets a camera property. This function is equivalent to the standard go.get().
+	 * @param camera_id - The identifier for the camera.
+	 * @param property - The property to be retrieved.
+	 * @returns The value of the specified property.
+	 */
+	function get(camera_id: CameraId, property: Hash | string): unknown;
+
+	/**
+	 * Gets the initial window size specified in the game.project file.
+	 * @returns The initial window size.
+	 */
+	function get_display_size(): Vector3;
+
+	/**
+	 * Gets the current window size.
+	 * @returns The current window size.
+	 */
+	function get_window_size(): Vector3;
+
+	/**
+	 * Gets camera ids whose viewports intersect a screen position.
+	 * @param screen_x - The x-coordinate of the screen position.
+	 * @param screen_y - The y-coordinate of the screen position.
+	 * @returns An array of camera ids.
+	 */
+	function get_stack(screen_x: number, screen_y: number): CameraId[];
+
+	/**
+	 * Starts a camera shake animation. If the camera is already shaking, then the animation is cancelled and restarted.
+	 * The radius is increased or decreased over time if the scaler argument is ~= 1.
+	 * @param camera_id - The identifier for the camera.
+	 * @param radius - The initial radius of the camera shake.
+	 * @param intensity - The intensity of the camera shake.
+	 * @param duration - The duration of the camera shake animation.
+	 * @param scaler - Optional scaler argument for adjusting the radius over time.
+	 */
+	function shake(
+		camera_id: CameraId,
+		radius: number,
+		intensity: number,
+		duration: number,
+		scaler?: number,
+	): void;
+
+	/**
+	 * Cancels an ongoing camera shake animation.
+	 * @param camera_id - The identifier for the camera.
+	 */
+	function cancel_shake(camera_id: CameraId): void;
+
+	/**
+	 * Converts a screen position to a world position. The screen position's z component maps to the camera frustum's z component.
+	 * @param camera_id - The identifier for the camera.
+	 * @param screen_position - The screen position to be converted.
+	 * @returns The corresponding world position.
+	 */
+	function screen_to_world(
+		camera_id: CameraId,
+		screen_position: Vector3,
+	): Vector3;
+
+	/**
+	 * Converts a world position to a screen position. The world position's z component maps to the camera frustum's z component.
+	 * @param camera_id - The identifier for the camera.
+	 * @param world_position - The world position to be converted.
+	 * @returns The corresponding screen position.
+	 */
+	function world_to_screen(
+		camera_id: CameraId,
+		world_position: Vector3,
+	): Vector3;
+}

package/generated/richtext.color.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @see {@link https://github.com/britzl/defold-richtext|Github Source}
+ * @example `import * as color from 'richtext.color'`
+ * @noResolution
+ */
+declare module 'richtext.color' {
+	export function add(name: string, color: number | string): void;
+
+	export const COLORS: {
+		aqua: Vector4;
+		black: Vector4;
+		blue: Vector4;
+		brown: Vector4;
+		cyan: Vector4;
+		darkblue: Vector4;
+		fuchsia: Vector4;
+		green: Vector4;
+		grey: Vector4;
+		lightblue: Vector4;
+		lime: Vector4;
+		magenta: Vector4;
+		maroon: Vector4;
+		navy: Vector4;
+		olive: Vector4;
+		orange: Vector4;
+		purple: Vector4;
+		red: Vector4;
+		silver: Vector4;
+		teal: Vector4;
+		white: Vector4;
+		yellow: Vector4;
+	};
+}