@ts-defold/types 1.1.16 → 1.2.3

package/index.d.ts

@@ -1,7 +1,8 @@
 /** @noSelfInFile */
 /// <reference types="lua-types/5.1" />
+/// <reference types="typescript-to-lua/language-extensions" />
 
-// DEFOLD. stable version 1.2.186 (1f748d5b0a84e8b5c58bf747e4c48d153ef77a52)
+// DEFOLD. stable version 1.2.187 (581c6439ae93755a8a6bcf58732c39c724fa193c)
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
 
 
@@ -97,6 +98,130 @@ declare function pprint(v: any): void
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
 
 
+declare namespace socket {
+
+	/**
+	* max numbers of sockets the select function can handle
+	*/
+	export let _SETSIZE: any
+
+	/**
+	* the current LuaSocket version
+	*/
+	export let _VERSION: any
+
+	/**
+	* This function is a shortcut that creates and returns a TCP client object connected to a remote
+	* address at a given port. Optionally, the user can also specify the local address and port to
+	* bind (`locaddr` and `locport`), or restrict the socket family to `"inet"` or `"inet6"`.
+	* Without specifying family to connect, whether a tcp or tcp6 connection is created depends on
+	* your system configuration.
+	* @param address  the address to connect to.
+	* @param port  the port to connect to.
+	* @param locaddr  optional local address to bind to.
+	* @param locport  optional local port to bind to.
+	* @param family  optional socket family to use, `"inet"` or `"inet6"`.
+	* @return tcp_client  a new IPv6 TCP client object, or `nil` in case of error.
+	* @return error  the error message, or `nil` if no error occurred.
+	*/
+	export function connect(address: string, port: number, locaddr?: string, locport?: number, family?: string): LuaMultiReturn<[any, string]>
+
+	/**
+	* Returns the time in seconds, relative to the system epoch (Unix epoch time since January 1, 1970 (UTC) or Windows file time since January 1, 1601 (UTC)).
+	* You should use the values returned by this function for relative measurements only.
+	* @return seconds  the number of seconds elapsed.
+	*/
+	export function gettime(): number
+
+	/**
+	* This function creates and returns a clean try function that allows for cleanup before the exception is raised.
+	* The `finalizer` function will be called in protected mode (see protect).
+	* @param finalizer  a function that will be called before the try throws the exception.
+	* @return try  the customized try function.
+	*/
+	export function newtry(finalizer: any): any
+
+	/**
+	* Converts a function that throws exceptions into a safe function. This function only catches exceptions thrown by try functions. It does not catch normal Lua errors.
+	* ⚠ Beware that if your function performs some illegal operation that raises an error, the protected function will catch the error and return it as a string. This is because try functions uses errors as the mechanism to throw exceptions.
+	* @param func  a function that calls a try function (or assert, or error) to throw exceptions.
+	* @return safe_func  an equivalent function that instead of throwing exceptions, returns `nil` followed by an error message.
+	*/
+	export function protect(func: any): any
+
+	/**
+	* The function returns a list with the sockets ready for reading, a list with the sockets ready for writing and an error message. The error message is "timeout" if a timeout condition was met and nil otherwise. The returned tables are doubly keyed both by integers and also by the sockets themselves, to simplify the test if a specific socket has changed status.
+	* `Recvt` and `sendt` parameters can be empty tables or `nil`. Non-socket values (or values with non-numeric indices) in these arrays will be silently ignored.
+	* The returned tables are doubly keyed both by integers and also by the sockets themselves, to simplify the test if a specific socket has changed status.
+	* ⚠ This function can monitor a limited number of sockets, as defined by the constant socket._SETSIZE. This number may be as high as 1024 or as low as 64 by default, depending on the system. It is usually possible to change this at compile time. Invoking select with a larger number of sockets will raise an error.
+	* ⚠ A known bug in WinSock causes select to fail on non-blocking TCP sockets. The function may return a socket as writable even though the socket is not ready for sending.
+	* ⚠ Calling select with a server socket in the receive parameter before a call to accept does not guarantee accept will return immediately. Use the settimeout method or accept might block forever.
+	* ⚠ If you close a socket and pass it to select, it will be ignored.
+	* (Using select with non-socket objects: Any object that implements `getfd` and `dirty` can be used with select, allowing objects from other libraries to be used within a socket.select driven loop.)
+	* @param recvt  array with the sockets to test for characters available for reading.
+	* @param sendt  array with sockets that are watched to see if it is OK to immediately write on them.
+	* @param timeout  the maximum amount of time (in seconds) to wait for a change in status. Nil, negative or omitted timeout value allows the function to block indefinitely.
+	* @return sockets_r  a list with the sockets ready for reading.
+	* @return sockets_w  a list with the sockets ready for writing.
+	* @return error  an error message. "timeout" if a timeout condition was met, otherwise `nil`.
+	*/
+	export function select(recvt: any, sendt: any, timeout?: number): LuaMultiReturn<[any, any, string]>
+
+	/**
+	* This function drops a number of arguments and returns the remaining.
+	* It is useful to avoid creation of dummy variables:
+	* `D` is the number of arguments to drop. `Ret1` to `retN` are the arguments.
+	* The function returns `retD+1` to `retN`.
+	* @param d  the number of arguments to drop.
+	* @param ret1  argument 1.
+	* @param ret2  argument 2.
+	* @param retN  argument N.
+	* @return retD_1  argument D+1.
+	* @return retD_2  argument D+2.
+	* @return retN  argument N.
+	*/
+	export function skip(d: number, ret1?: any, ret2?: any, retN?: any): LuaMultiReturn<[any, any, any]> | undefined
+
+	/**
+	* Freezes the program execution during a given amount of time.
+	* @param time  the number of seconds to sleep for.
+	*/
+	export function sleep(time: number): void
+
+	/**
+	* Creates and returns an IPv4 TCP master object. A master object can be transformed into a server object with the method `listen` (after a call to `bind`) or into a client object with the method `connect`. The only other method supported by a master object is the `close` method.
+	* @return tcp_master  a new IPv4 TCP master object, or `nil` in case of error.
+	* @return error  the error message, or `nil` if no error occurred.
+	*/
+	export function tcp(): LuaMultiReturn<[any, string]>
+
+	/**
+	* Creates and returns an IPv6 TCP master object. A master object can be transformed into a server object with the method `listen` (after a call to `bind`) or into a client object with the method connect. The only other method supported by a master object is the close method.
+	* Note: The TCP object returned will have the option "ipv6-v6only" set to true.
+	* @return tcp_master  a new IPv6 TCP master object, or `nil` in case of error.
+	* @return error  the error message, or `nil` if no error occurred.
+	*/
+	export function tcp6(): LuaMultiReturn<[any, string]>
+
+	/**
+	* Creates and returns an unconnected IPv4 UDP object. Unconnected objects support the `sendto`, `receive`, `receivefrom`, `getoption`, `getsockname`, `setoption`, `settimeout`, `setpeername`, `setsockname`, and `close` methods. The `setpeername` method is used to connect the object.
+	* @return udp_unconnected  a new unconnected IPv4 UDP object, or `nil` in case of error.
+	* @return error  the error message, or `nil` if no error occurred.
+	*/
+	export function udp(): LuaMultiReturn<[any, string]>
+
+	/**
+	* Creates and returns an unconnected IPv6 UDP object. Unconnected objects support the `sendto`, `receive`, `receivefrom`, `getoption`, `getsockname`, `setoption`, `settimeout`, `setpeername`, `setsockname`, and `close` methods. The `setpeername` method is used to connect the object.
+	* Note: The UDP object returned will have the option "ipv6-v6only" set to true.
+	* @return udp_unconnected  a new unconnected IPv6 UDP object, or `nil` in case of error.
+	* @return error  the error message, or `nil` if no error occurred.
+	*/
+	export function udp6(): LuaMultiReturn<[any, string]>
+
+}
+// =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
+
+
 declare namespace crash {
 
 	/**
@@ -1923,7 +2048,7 @@ with a custom curve. See the animation guide for more information.
 	* @return success  texture creation was successful
 	* @return code  one of the gui.RESULT_* codes if unsuccessful
 	*/
-	export function new_texture(texture: string | hash, width: number, height: number, type: any, buffer: string, flip: boolean): boolean
+	export function new_texture(texture: string | hash, width: number, height: number, type: any, buffer: string, flip: boolean): LuaMultiReturn<[boolean, number]>
 
 	/**
 	* Tests whether a coordinate is within the bounding box of a
@@ -4215,7 +4340,7 @@ The HTTP user agent, i.e. "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) Apple
 	* @return data  loaded data, or `nil` if the resource could not be loaded
 	* @return error  the error message, or `nil` if no error occurred
 	*/
-	export function load_resource(filename: string): string
+	export function load_resource(filename: string): LuaMultiReturn<[string, string]>
 
 	/**
 	* Open URL in default application, typically a browser
@@ -4394,7 +4519,7 @@ declare namespace window {
 	* @return width  The window width
 	* @return height  The window height
 	*/
-	export function get_size(): number
+	export function get_size(): LuaMultiReturn<[number, number]>
 
 	/**
 	* 🤖 Sets the dimming mode on a mobile device.
@@ -5867,7 +5992,7 @@ declare namespace sound {
 	* @return peak_l  peak value for left channel
 	* @return peak_r  peak value for right channel
 	*/
-	export function get_peak(group: string | hash, window: number): number
+	export function get_peak(group: string | hash, window: number): LuaMultiReturn<[number, number]>
 
 	/**
 	* Get RMS (Root Mean Square) value from mixer group. This value is the
@@ -5882,7 +6007,7 @@ declare namespace sound {
 	* @return rms_l  RMS value for left channel
 	* @return rms_r  RMS value for right channel
 	*/
-	export function get_rms(group: string | hash, window: number): number
+	export function get_rms(group: string | hash, window: number): LuaMultiReturn<[number, number]>
 
 	/**
 	* Checks if background music is playing, e.g. from iTunes.
@@ -6311,7 +6436,7 @@ declare namespace tilemap {
 	* @return w  number of columns (width) in the tile map
 	* @return h  number of rows (height) in the tile map
 	*/
-	export function get_bounds(url: string | hash | url): number
+	export function get_bounds(url: string | hash | url): LuaMultiReturn<[number, number, number, number]>
 
 	/**
 	* Get the tile set at the specified position in the tilemap.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-defold/types",
-  "version": "1.1.16",
+  "version": "1.2.3",
   "description": "TypeScript definitions for Defold",
   "repository": "github:ts-defold/types",
   "keywords": [
@@ -24,10 +24,14 @@
     "version": "latest"
   },
   "dependencies": {
-    "lua-types": "2.8.0"
+    "lua-types": "^2.10.1"
   },
   "devDependencies": {
-    "@ts-defold/type-gen": "^0.2.10",
-    "typescript": "^4.3.5"
+    "@ts-defold/type-gen": "^0.5.0",
+    "typescript": "4.3.4",
+    "typescript-to-lua": "^1.0.1"
+  },
+  "peerDependencies": {
+    "typescript-to-lua": "^1.0.1"
   }
 }