@defold-typescript/library-types 0.22.0 → 0.24.0

package/generated/squid.d.ts

@@ -0,0 +1,127 @@
+/** @noResolution */
+declare module 'squid.squid' {
+	/**
+	 * @(1) trace logging level constant
+	 */
+	export const TRACE: number;
+	/**
+	 * @(2) debug logging level constant
+	 */
+	export const DEBUG: number;
+	/**
+	 * @(3) info logging level constant
+	 */
+	export const INFO: number;
+	/**
+	 * @(4) warning logging level constant
+	 */
+	export const WARN: number;
+	/**
+	 * @(5) error logging level constant
+	 */
+	export const ERROR: number;
+	/**
+	 * @Public list of allowed tags (pairs tag[string] - is_allowed[boolean])
+	 */
+	export const ALLOWLIST: LuaTable;
+	interface SquidInstance {
+		log(message: string | number, level: number, data?: unknown): void;
+		trace(message: string | number, data?: unknown): void;
+		debug(message: string | number, data?: unknown): void;
+		info(message: string | number, data?: unknown): void;
+		warn(message: string | number, data?: unknown): void;
+		error(message: string | number, data?: unknown): void;
+		set_allowed(this_tag?: string, this_is_allowed?: boolean): void;
+		save_logs(): void;
+		init(): void;
+		final(): void;
+	}
+	interface 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 SystemHelper {
+		is_linux: boolean;
+		is_mobile: boolean;
+		is_debug: boolean;
+	}
+	interface TableToString {
+	}
+	/**
+	 * ------
+	 * ------
+	 * ------
+	 * ------
+	 * Initialize Squid for error and crash handling and logging
+	 */
+	export function init(this: void): void;
+	/**
+	 * Set if logs should be saved to file
+	 */
+	export function set_allowed(this: void, tag: string, is_allowed: boolean): void;
+	/**
+	 * Log TRACE level message with optional data and tag
+	 */
+	export function trace(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log DEBUG level message with optional data and tag
+	 */
+	export function debug(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log INFO level message with optional data and tag
+	 */
+	export function info(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log WARNING level message with optional data and tag
+	 */
+	export function warn(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log ERROR level message with optional data and tag
+	 */
+	export function error(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log message with provided level, message, data and tag
+	 */
+	export function log(this: void, message: string | number, level?: number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Explicitly save buffer of unsaved logs to a file
+	 */
+	export function save_logs(this: void): boolean;
+	/**
+	 * Set error callback function that will be called on error after logging it
+	 */
+	export function set_error_callback(this: void, callback: (source: string, message: string, traceback: string) => void): void;
+	/**
+	 * Finalize Squid logging - check for crashes and saved all unsaved buffered logs
+	 */
+	export function final(this: void): void;
+	/**
+	 * Create a new instance of the Squid logger
+	 */
+	export function new_(this: void, tag?: string, is_allowed?: boolean): SquidInstance;
+	export { new_ as new };
+	/**
+	 * Get Squid configuration
+	 */
+	export function get_config(this: void): SquidConfig;
+	/**
+	 * Set and use user configuration
+	 */
+	export function set_config(this: void, config: SquidConfig): void;
+}

package/generated/tweener.d.ts

@@ -0,0 +1,42 @@
+/** @noResolution */
+declare module 'tweener.tweener' {
+	type easing_function = ((current: number, from: number, to: number, time: number) => number) | string | Opaque<"constant"> | number[];
+	/**
+	 * Describe a struct of tween object returned by the `tweener.tween` function
+	 */
+	interface tween {
+		timer_id: number;
+		is_paused: boolean;
+	}
+	/**
+	 * A tweener module to manage tweening operations. Tween functions are based on the Defold timer.delay function.
+	 * Use `tweener.tween` to create a tween, and `tweener.ease` to get the result of an easing function.
+	 * You can track the final call of tween by last parameter of the callback function.
+	 */
+	interface tweener {
+	}
+	/**
+	 * Starts a tweening operation. Return a tween object to manage the tween.
+	 */
+	export function tween(this: void, easing_function: easing_function, from: number, to: number, time: number | undefined, callback: (value: number, is_end: boolean, time_elapsed: number, time_total: number) => void, update_delta_time?: number | undefined): tween;
+	/**
+	 * Returns the result of an easing function.
+	 */
+	export function ease(this: void, easing_function: easing_function, from: number, to: number, time: number | undefined, time_elapsed: number): number;
+	/**
+	 * Check if a tween exists
+	 */
+	export function is_active(this: void, tween: tween): boolean;
+	/**
+	 * Cancel a previous running tween.
+	 */
+	export function cancel(this: void, tween?: tween | undefined): boolean;
+	/**
+	 * Check if a tween is paused
+	 */
+	export function is_paused(this: void, tween: tween): boolean;
+	/**
+	 * Sets the pause on a running tween.
+	 */
+	export function set_pause(this: void, tween: tween, is_paused: boolean): void;
+}

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;
 }