@defold-typescript/library-types 0.23.0 → 0.25.0

package/generated/shutter.d.ts

@@ -0,0 +1,183 @@
+/** @noSelfInFile **/
+
+/**
+ * @see {@link https://github.com/Klaleus/defold-shutter|Github Source}
+ * @noResolution
+ * @example `import * as shutter from 'shutter.shutter'`
+ */
+declare module 'shutter.shutter' {
+	/**
+	 * One camera's state, created by the shutter.script game object in its `init` and
+	 * removed again in its `final`. The first eight properties mirror the script's
+	 * `go.property()` declarations; the rest are recalculated every frame and should be
+	 * read rather than written.
+	 */
+	interface ShutterCamera {
+		/** One of `center_behavior`, `expand_behavior` or `stretch_behavior`. */
+		behavior: Hash;
+		viewport_x: number;
+		viewport_y: number;
+		viewport_width: number;
+		viewport_height: number;
+		near: number;
+		far: number;
+		zoom: number;
+		/** Viewport left edge after the window scale and any letterboxing margin. */
+		viewport_x_adjusted: number;
+		/** Viewport bottom edge after the window scale and any pillarboxing margin. */
+		viewport_y_adjusted: number;
+		viewport_width_adjusted: number;
+		viewport_height_adjusted: number;
+		view: Matrix4;
+		projection: Matrix4;
+		/** Where the shaken object sat before the shake began, and `nil` while no shake
+		 * is running. `cancel_shake` restores the object to it. */
+		shake_origin?: Vector3;
+	}
+
+	/**
+	 * Every live camera, keyed by the id of the game object it lives on. The
+	 * shutter.script file writes to it; read from it rather than manipulating it
+	 * directly.
+	 */
+	const camera_table: LuaMap<Hash, ShutterCamera>;
+
+	/**
+	 * Keeps the projection fixed and shrinks the viewport to preserve the display
+	 * ratio, letterboxing or pillarboxing the remainder.
+	 */
+	const center_behavior: Hash;
+
+	/**
+	 * Keeps the viewport filling the window and widens the projection as the window
+	 * grows, showing more of the game world rather than scaling it.
+	 */
+	const expand_behavior: Hash;
+
+	/**
+	 * Keeps both the viewport and the projection filling the window, so the game world
+	 * distorts with the window ratio.
+	 */
+	const stretch_behavior: Hash;
+
+	/**
+	 * Installs a camera's viewport, view matrix and projection matrix into the render
+	 * context. Call it from a render script before drawing the world.
+	 * @param object The game object the camera lives on.
+	 * @returns The camera's frustum, for passing to `render.draw`.
+	 */
+	function activate(object: Hash): Matrix4;
+
+	/**
+	 * Restores the viewport and matrices Defold's GUI system expects, sized to the
+	 * current window. Call it before drawing GUI.
+	 * @returns The frustum matching the restored matrices.
+	 */
+	function deactivate(): Matrix4;
+
+	/**
+	 * Recalculates a camera's viewport, view matrix and projection matrix immediately.
+	 * The shutter.script game object already does this once per frame; call it directly
+	 * only after changing a camera property mid-frame.
+	 * @param object The game object the camera lives on.
+	 */
+	function force_update(object: Hash): void;
+
+	/**
+	 * Calculates the camera's viewport in window coordinates, scaled from the
+	 * game.project display size and, under center behavior, shrunk and centered to
+	 * preserve the display ratio.
+	 * @param object The game object the camera lives on.
+	 * @returns The viewport's x, y, width and height.
+	 */
+	function get_viewport(object: Hash): LuaMultiReturn<[number, number, number, number]>;
+
+	/**
+	 * Calculates the camera's view matrix from the inverse of its game object's world
+	 * transform.
+	 * @param object The game object the camera lives on.
+	 */
+	function get_view(object: Hash): Matrix4;
+
+	/**
+	 * Calculates the camera's orthographic projection matrix, sized from the display
+	 * under center and stretch behavior and from the window under expand behavior.
+	 * @param object The game object the camera lives on.
+	 */
+	function get_projection(object: Hash): Matrix4;
+
+	/**
+	 * Returns the camera's frustum, the product of its last calculated projection and
+	 * view matrices.
+	 * @param object The game object the camera lives on.
+	 */
+	function get_frustum(object: Hash): Matrix4;
+
+	/**
+	 * Converts a screen distance into the world distance an object must travel to cover
+	 * it, accounting for the camera's zoom and, under center and stretch behavior, for
+	 * the viewport no longer mapping to physical screen coordinates.
+	 * @param object The game object the camera lives on.
+	 * @param distance The screen distance to convert.
+	 * @param absolute Skip rotating the result by the camera's rotation.
+	 */
+	function get_distance(object: Hash, distance: Vector3, absolute?: boolean): Vector3;
+
+	/**
+	 * Starts a camera shake animation, cancelling and restarting any shake already
+	 * running on this camera.
+	 * @param object The game object the camera lives on.
+	 * @param parent Shake the camera object's parent instead of the camera itself.
+	 * @param count How many times to displace the camera before stopping.
+	 * @param duration Seconds each displacement takes.
+	 * @param radius How far each displacement moves the camera.
+	 * @param duration_scalar Multiplies the duration after each displacement. Defaults to 1.
+	 * @param radius_scalar Multiplies the radius after each displacement. Defaults to 1.
+	 */
+	function shake(
+		object: Hash,
+		parent: boolean,
+		count: number,
+		duration: number,
+		radius: number,
+		duration_scalar?: number,
+		radius_scalar?: number,
+	): void;
+
+	/**
+	 * Stops a running camera shake and returns the shaken object to where it started.
+	 * Does nothing if no shake is running.
+	 * @param object The game object the camera lives on.
+	 * @param parent Whether the shake was started against the camera object's parent.
+	 */
+	function cancel_shake(object: Hash, parent?: boolean): void;
+
+	/**
+	 * Converts a screen position to its world position through the inverse of the
+	 * camera's frustum.
+	 * @param object The game object the camera lives on.
+	 * @param x The screen position's x coordinate.
+	 * @param y The screen position's y coordinate.
+	 * @param visible Return `nil` instead when the position falls outside the camera's view.
+	 * @returns The world position, or `nil` if `visible` filtered it out.
+	 */
+	function screen_to_world(
+		object: Hash,
+		x: number,
+		y: number,
+		visible?: boolean,
+	): Vector3 | undefined;
+
+	/**
+	 * Converts a world position to its screen position through the camera's frustum.
+	 * @param object The game object the camera lives on.
+	 * @param position The world position to convert.
+	 * @param visible Return `nil` instead when the position falls outside the camera's view.
+	 * @returns The screen position, or `nil` if `visible` filtered it out.
+	 */
+	function world_to_screen(
+		object: Hash,
+		position: Vector3,
+		visible?: boolean,
+	): Vector3 | undefined;
+}

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

@@ -29,7 +29,21 @@ declare module 'yagames.yagames' {
   }
   export function adv_show_rewarded_video(callbacks: RewardedCallbacks): void;
 
-  //* Authentication + Player 
+  export interface StickyBannerStatus {
+    stickyAdvIsShowing: boolean;
+    reason?: "ADV_IS_NOT_CONNECTED" | "UNKNOWN";
+  }
+  export type StickyBannerCallback = (ctx: Context, err?: string, result?: StickyBannerStatus) => void;
+  export function adv_get_banner_adv_status(callback: StickyBannerCallback): void;
+
+  export function adv_show_banner_adv(callback?: StickyBannerCallback): void;
+
+  export type StickyBannerHideCallback = (ctx: Context, err?: string, result?: {
+    stickyAdvIsShowing: boolean;
+  }) => void;
+  export function adv_hide_banner_adv(callback?: StickyBannerHideCallback): void;
+
+  //* Authentication + Player
 
   export function auth_open_auth_dialog(callback: ApiCallback): void;
 
@@ -50,7 +64,7 @@ declare module 'yagames.yagames' {
   export function player_get_stats(keys: Array<string> | undefined, callback: ApiCallback): void;
 
   /**
- * @deprecated Use `player_get_unqiue_id` instead.
+ * @deprecated Use `player_get_unique_id` instead.
  */
   export function player_get_id(): string;
 
@@ -66,6 +80,24 @@ declare module 'yagames.yagames' {
 
   export function player_get_photo(size: 'small' | 'medium' | 'large'): string;
 
+  export function player_get_paying_status(): 'paying' | 'partially_paying' | 'not_paying' | 'unknown';
+
+  /**
+ * Upstream types the result as "table or nil" and publishes no field list for the
+ * SDK's `_personalInfo` object, so the shape stays open rather than invented.
+ */
+  export type PlayerPersonalInfo = Record<string, unknown>;
+  export function player_get_personal_info(): PlayerPersonalInfo | undefined;
+
+  export function player_get_signature(): string | undefined;
+
+  /**
+ * @deprecated Use `player_is_authorized` instead.
+ */
+  export function player_get_mode(): 'lite' | '';
+
+  export function player_is_authorized(): boolean;
+
   //* In-Game Purchases
 
   export function payments_init(options: { signed?: boolean } | undefined, callback: ApiCallback): void;
@@ -101,12 +133,19 @@ declare module 'yagames.yagames' {
     priceValue: string;
     priceCurrencyCode: string;
   }>) => void;
-  export function payments_get_catalog(callback: PaymentsCatalogCallback): void;
+  export interface PaymentsCatalogOptions {
+    getPriceCurrencyImage?: 'medium' | 'small' | 'svg';
+  }
+  export function payments_get_catalog(options: PaymentsCatalogOptions | undefined, callback: PaymentsCatalogCallback): void;
 
   export function payments_consume_purchase(purchase_token: string, callback: ApiCallback): void;
 
   //* Leaderboards
 
+  /**
+ * @deprecated The leaderboards subsystem no longer needs initializing; the other
+ * `leaderboards_*` functions work without it.
+ */
   export function leaderboards_init(callback: ApiCallback): void;
 
   export type LeaderboardsDescriptionCallback = (ctx: Context, err?: string, data?: {
@@ -177,6 +216,33 @@ declare module 'yagames.yagames' {
 
   export function leaderboards_set_score(leaderboard_name: string, score: number, extra_data: string, callback: ApiCallback): void;
 
+  //* Features
+
+  export function features_loadingapi_ready(): void;
+
+  export function features_gameplayapi_start(): void;
+
+  export function features_gameplayapi_stop(): void;
+
+  export interface GamesApiGame {
+    appID: string;
+    title: string;
+    url: string;
+    coverURL: string;
+    iconURL: string;
+  }
+  export type GamesApiAllGamesCallback = (ctx: Context, err?: string, result?: {
+    games: Array<GamesApiGame>;
+    developerURL: string;
+  }) => void;
+  export function features_gamesapi_get_all_games(callback: GamesApiAllGamesCallback): void;
+
+  export type GamesApiGameByIdCallback = (ctx: Context, err?: string, result?: {
+    isAvailable: boolean;
+    game?: GamesApiGame;
+  }) => void;
+  export function features_gamesapi_get_game_by_id(app_id: number, callback: GamesApiGameByIdCallback): void;
+
   //* Feedback
 
   export type FeedbackCanReviewCallback = (ctx: Context, err?: string, data?: {
@@ -204,6 +270,8 @@ declare module 'yagames.yagames' {
 
   export function device_info_is_tablet(): boolean;
 
+  export function device_info_is_tv(): boolean;
+
   //* Environment
 
   export interface EnvironmentResults {
@@ -229,6 +297,18 @@ declare module 'yagames.yagames' {
   
   export function screen_fullscreen_exit(callback?: ApiCallback): void;
 
+  //* Shortcuts
+
+  export type ShortcutCanShowCallback = (ctx: Context, err?: string, result?: {
+    canShow: boolean;
+  }) => void;
+  export function shortcut_can_show_prompt(callback: ShortcutCanShowCallback): void;
+
+  export type ShortcutShowPromptCallback = (ctx: Context, err?: string, result?: {
+    outcome: string;
+  }) => void;
+  export function shortcut_show_prompt(callback?: ShortcutShowPromptCallback): void;
+
   //* Safe Storage
 
   export function storage_init(callback: ApiCallback): void;
@@ -245,35 +325,77 @@ declare module 'yagames.yagames' {
 
   export function storage_length(): number;
 
-  //* Banner Ads
+  //* Remote Config
+
+  export interface FlagsClientFeature {
+    name: string;
+    value: string;
+  }
+  export interface FlagsOptions {
+    defaultFlags?: Record<string, string>;
+    clientFeatures?: Array<FlagsClientFeature>;
+  }
+  export type FlagsCallback = (ctx: Context, err?: string, flags?: Record<string, string>) => void;
+  export function flags_get(options: FlagsOptions | undefined, callback: FlagsCallback): void;
+
+  //* Events
 
-  export function banner_init(callback: ApiCallback): void;
+  export function event_on(event_name: string, listener: ApiCallback): void;
 
-  export interface BannerCreateOptions {
-    stat_id?: number;
-    css_styles?: string;
-    css_class?: string;
-    display?: "none" | "block";
+  export function event_off(event_name: string, listener: ApiCallback): void;
+
+  export function event_dispatch(event_name: string): void;
+
+  //* Multiplayer Sessions
+
+  export interface MultiplayerSessionsMetaRange {
+    min: number;
+    max: number;
   }
-  export type BannerCreateCallback = (ctx: Context, err?: string, data?: {
-    product: "direct" | "rtb";
-  }) => void;
-  export function banner_create(rtb_id: string, options: BannerCreateOptions, callback?: BannerCreateCallback): void;
-  
-  export function banner_delete(rtb_id: string): void;
-  
-  export function banner_refresh(rtb_id: string, callback?: BannerCreateCallback): void;
-  
-  export function banner_set(rtb_id: string, property: "stat_id" | "css_styles" | "css_class" | "display", value: string): void;
+  export interface MultiplayerSessionsMeta {
+    meta1?: MultiplayerSessionsMetaRange;
+    meta2?: MultiplayerSessionsMetaRange;
+    meta3?: MultiplayerSessionsMetaRange;
+  }
+  export interface MultiplayerSessionsInitOptions {
+    count: number;
+    isEventBased: boolean;
+    maxOpponentTurnTime?: number;
+    meta: MultiplayerSessionsMeta;
+  }
+  export interface MultiplayerSessionEvent {
+    id: string;
+    payload: Record<string, unknown>;
+    time: number;
+  }
+  export interface MultiplayerSession {
+    id: string;
+    meta1?: number;
+    meta2?: number;
+    meta3?: number;
+    player: {
+      avatar: string;
+      name: string;
+    }
+    timeline: Array<MultiplayerSessionEvent>;
+  }
+  export type MultiplayerSessionsInitCallback = (ctx: Context, err?: string, result?: Array<MultiplayerSession>) => void;
+  export function multiplayer_sessions_init(options: MultiplayerSessionsInitOptions, callback: MultiplayerSessionsInitCallback): void;
 
-  //* Sitelock
-  
-  export function add_domain(domain: string): void;
-  
-  export function verify_domain(): boolean;
-  
-  export function get_current_domain(): string;
-  
-  export function is_release_build(): boolean;
+  export function multiplayer_sessions_commit(data: Record<string, unknown>): void;
+
+  export interface MultiplayerSessionsPushMeta {
+    meta1?: number;
+    meta2?: number;
+    meta3?: number;
+  }
+  export function multiplayer_sessions_push(data: MultiplayerSessionsPushMeta): void;
+
+  //* Miscellaneous
+
+  export type AvailableMethodCallback = (ctx: Context, err?: string, result?: boolean) => void;
+  export function is_available_method(name: string, callback: AvailableMethodCallback): void;
+
+  export function server_time(): number;
 
  }

package/generated/{zzfx.api.d.ts → zzfx.d.ts}

@@ -10,11 +10,18 @@ type ZzFXSample = LuaUserdata & {
  * @noResolution
  */
 declare module 'zzfx.api' {
+  /**
+   * Build a sample from a ZzFX parameter list and play it in one call.
+   * @see {@link https://killedbyapixel.github.io/ZzFX/|the ZzFX sound designer}
+   */
   export function play(...args: number[]): void;
 
+  /** Set the sample rate used to render subsequent samples. Defaults to 44100. */
   export function samplerate(rate: number): void;
 
+  /** Play a sample previously returned by {@link build_sample}. */
   export function play_sample(sample: ZzFXSample): void;
 
+  /** Build a reusable sample from a ZzFX parameter list, without playing it. */
   export function build_sample(...args: number[]): ZzFXSample;
 }

package/library-classification.json

@@ -27,20 +27,6 @@
         "lua_script_instance"
       ]
     },
-    {
-      "dir": "boom",
-      "classification": "already-vendored",
-      "modules": [
-        "boom.boom"
-      ]
-    },
-    {
-      "dir": "bzAnim",
-      "classification": "already-vendored",
-      "modules": [
-        "bzAnim.bzAnim"
-      ]
-    },
     {
       "dir": "def-setv",
       "classification": "native",
@@ -62,20 +48,6 @@
         "taptic_engine"
       ]
     },
-    {
-      "dir": "defcon",
-      "classification": "already-vendored",
-      "modules": [
-        "defcon.console"
-      ]
-    },
-    {
-      "dir": "defmath",
-      "classification": "already-vendored",
-      "modules": [
-        "defmath.defmath"
-      ]
-    },
     {
       "dir": "defold-apkx",
       "classification": "native",
@@ -118,22 +90,6 @@
         "imagepicker"
       ]
     },
-    {
-      "dir": "defold-input",
-      "classification": "already-vendored",
-      "modules": [
-        "in.accelerometer",
-        "in.button",
-        "in.cursor",
-        "in.gesture",
-        "in.keyboard",
-        "in.mapper",
-        "in.onscreen",
-        "in.state",
-        "in.textbox",
-        "in.triggers"
-      ]
-    },
     {
       "dir": "defold-lfs",
       "classification": "native",
@@ -148,21 +104,6 @@
         "lldebugger.debug"
       ]
     },
-    {
-      "dir": "defold-metrics",
-      "classification": "already-vendored",
-      "modules": [
-        "metrics.fps",
-        "metrics.mem"
-      ]
-    },
-    {
-      "dir": "defold-orthographic",
-      "classification": "already-vendored",
-      "modules": [
-        "orthographic.camera"
-      ]
-    },
     {
       "dir": "defold-playable-ads",
       "classification": "native",
@@ -191,15 +132,6 @@
         "rnd"
       ]
     },
-    {
-      "dir": "defold-richtext",
-      "classification": "already-vendored",
-      "modules": [
-        "richtext.color",
-        "richtext.richtext",
-        "richtext.tags"
-      ]
-    },
     {
       "dir": "defold-scene3d",
       "classification": "native",
@@ -277,13 +209,6 @@
         "xmath"
       ]
     },
-    {
-      "dir": "defold-yagames",
-      "classification": "already-vendored",
-      "modules": [
-        "yagames.yagames"
-      ]
-    },
     {
       "dir": "defold-yametrica",
       "classification": "native",
@@ -305,13 +230,6 @@
         "zstd"
       ]
     },
-    {
-      "dir": "defold-zzfx",
-      "classification": "already-vendored",
-      "modules": [
-        "zzfx.api"
-      ]
-    },
     {
       "dir": "defos",
       "classification": "native",
@@ -319,27 +237,6 @@
         "defos"
       ]
     },
-    {
-      "dir": "defsave",
-      "classification": "already-vendored",
-      "modules": [
-        "defsave.defsave"
-      ]
-    },
-    {
-      "dir": "deftest",
-      "classification": "already-vendored",
-      "modules": [
-        "deftest.deftest"
-      ]
-    },
-    {
-      "dir": "dicebag",
-      "classification": "already-vendored",
-      "modules": [
-        "dicebag.dicebag"
-      ]
-    },
     {
       "dir": "drawpixels",
       "classification": "native",
@@ -591,65 +488,12 @@
       "classification": "native",
       "modules": []
     },
-    {
-      "dir": "gooey",
-      "classification": "already-vendored",
-      "modules": [
-        "gooey.gooey"
-      ]
-    },
     {
       "dir": "jstodef",
       "classification": "native",
       "modules": [
         "jstodef"
       ]
-    },
-    {
-      "dir": "library-defold-persist",
-      "classification": "already-vendored",
-      "modules": [
-        "persist.persist"
-      ]
-    },
-    {
-      "dir": "library-defold-rendy",
-      "classification": "already-vendored",
-      "modules": [
-        "rendy.rendy"
-      ]
-    },
-    {
-      "dir": "monarch",
-      "classification": "already-vendored",
-      "modules": [
-        "monarch.monarch",
-        "monarch.transitions.easings",
-        "monarch.transitions.gui"
-      ]
-    },
-    {
-      "dir": "nakama-defold",
-      "classification": "already-vendored",
-      "modules": [
-        "nakama.engine.defold",
-        "nakama.nakama",
-        "nakama.util.log"
-      ]
-    },
-    {
-      "dir": "platypus",
-      "classification": "already-vendored",
-      "modules": [
-        "platypus.platypus"
-      ]
-    },
-    {
-      "dir": "starly",
-      "classification": "already-vendored",
-      "modules": [
-        "starly.starly"
-      ]
     }
   ]
 }