feat: add Starly type definitions

packages/starly/library.json

@@ -0,0 +1,4 @@
+{
+	"name": "starly",
+	"url": "https://github.com/VowSoftware/starly"
+}

packages/starly/starly-0.0.1.d.ts

@@ -0,0 +1,2 @@
+/// <library version="0.0.1" src="https://github.com/VowSoftware/starly/archive/main.zip" />
+/// <reference path="starly.d.ts" />

packages/starly/starly.d.ts

@@ -0,0 +1,131 @@
+/** @noSelfInFile **/
+
+/**
+ * @see {@link https://github.com/VowSoftware/starly|Github Source}
+ * @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): vmath.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: vmath.vector3,
+			absolute: boolean,
+		): vmath.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: vmath.vector3[],
+		): LuaMultiReturn<[vmath.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,
+		): vmath.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: vmath.vector3,
+			visible?: boolean,
+		): vmath.vector3 | undefined;
+	}
+	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;
+}