@defold-typescript/types 0.8.4 → 0.9.0

package/generated/resource.d.ts

@@ -8,8 +8,11 @@ declare global {
   namespace resource {
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -38,8 +41,11 @@ declare global {
     function atlas(path?: string): Hash;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -71,67 +77,109 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the atlas. Supported entries:
+     *
      * -
+     *
      * `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
+     *
      * -
+     *
      * `animations`
      * table a list of the animations in the atlas. Supports the following fields:
+     *
      * -
+     *
      * `id`
      * string the id of the animation, used in e.g sprite.play_animation
+     *
      * -
+     *
      * `width`
      * number the width of the animation
+     *
      * -
+     *
      * `height`
      * number the height of the animation
+     *
      * -
+     *
      * `frame_start`
      * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
+     *
      * -
+     *
      * `frame_end`
      * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
+     *
      * -
+     *
      * `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
+     *
      * -
+     *
      * `fps`
      * number optional fps of the animation, the default value is 30
+     *
      * -
+     *
      * `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
+     *
      * -
+     *
      * `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
+     *
      * -
+     *
      * `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
+     *
      * -
+     *
      * `id`
      * string The name of the geometry. Used when matching animations between multiple atlases
+     *
      * -
+     *
      * `width`
      * number The width of the image the sprite geometry represents
+     *
      * -
+     *
      * `height`
      * number The height of the image the sprite geometry represents
+     *
      * -
+     *
      * `pivot_x`
      * number The pivot x value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
+     *
      * -
+     *
      * `pivot_y`
      * number The pivot y value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
+     *
      * -
+     *
      * `rotated`
      * boolean Whether the image is rotated 90 degrees counter-clockwise in the atlas. This affects UV coordinate generation for proper rendering. Default is false.
+     *
      * -
+     *
      * `vertices`
      * table a list of the vertices in image space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
+     *
      * -
+     *
      * `uvs`
      * table a list of the uv coordinates in image space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}.
+     *
      * -
+     *
      * `indices`
      * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @returns Returns the atlas resource path
@@ -198,10 +246,14 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the buffer. Supported entries:
+     *
      * -
+     *
      * `buffer`
      * buffer the buffer to bind to this resource
+     *
      * -
+     *
      * `transfer_ownership`
      * boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default true)
      * @returns Returns the buffer resource path
@@ -261,6 +313,7 @@ declare global {
      *
      * @param path - the path to the resource. Must not already exist.
      * @param options - A table containing parameters for the text. Supported entries:
+     *
      * `data`
      * string The raw data of the file. May be partial, but must include the header of the file
      * `filesize`
@@ -292,13 +345,20 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the texture. Supported entries:
+     *
      * `type`
      * number The texture type. Supported values:
+     *
      * - `graphics.TEXTURE_TYPE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     *
      * `width`
      * number The width of the texture (in pixels). Must be larger than 0.
      * `height`
@@ -307,47 +367,80 @@ declare global {
      * number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
      * `format`
      * number The texture format, note that some of these formats might not be supported by the running device. Supported values:
+     *
      * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA`
+     *
      * These constants might not be available on the device:
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_ETC1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_BC1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_BC3`
+     *
      * - `graphics.TEXTURE_FORMAT_R_BC4`
+     *
      * - `graphics.TEXTURE_FORMAT_RG_BC5`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_BC7`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB32F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA32F`
+     *
      * - `graphics.TEXTURE_FORMAT_R16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RG16F`
+     *
      * - `graphics.TEXTURE_FORMAT_R32F`
+     *
      * - `graphics.TEXTURE_FORMAT_RG32F`
+     *
      * You can test if the device supports these values by checking if a specific enum is nil or not:
+     *
      * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
      * -- it is safe to use this format
      * end
      * `
+     *
      * `flags`
      * number Texture creation flags that can be used to dictate how the texture is created. The default value is graphics.TEXTURE_USAGE_FLAG_SAMPLE, which means that the texture can be sampled from a shader.
      * These flags may or may not be supported on the running device and/or the underlying graphics API and is simply used internally as a 'hint' when creating the texture. There is no guarantee that any of these will have any effect. Supported values:
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+     *
      * `max_mipmaps`
      * number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
      * `compression_type`
      * number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
      * Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     *
      * - `COMPRESSION_TYPE_DEFAULT`
+     *
      * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - optional buffer of precreated pixel data
      * @returns The path to the resource.
@@ -450,11 +543,17 @@ declare global {
      * @param table - A table containing info about how to create the texture. Supported entries:
      * `type`
      * number The texture type. Supported values:
+     *
      * - `graphics.TEXTURE_TYPE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     *
      * `width`
      * number The width of the texture (in pixels). Must be larger than 0.
      * `height`
@@ -463,46 +562,79 @@ declare global {
      * number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
      * `format`
      * number The texture format, note that some of these formats might not be supported by the running device. Supported values:
+     *
      * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA`
+     *
      * These constants might not be available on the device:
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_ETC1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB_BC1`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_BC3`
+     *
      * - `graphics.TEXTURE_FORMAT_R_BC4`
+     *
      * - `graphics.TEXTURE_FORMAT_RG_BC5`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA_BC7`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB32F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA32F`
+     *
      * - `graphics.TEXTURE_FORMAT_R16F`
+     *
      * - `graphics.TEXTURE_FORMAT_RG16F`
+     *
      * - `graphics.TEXTURE_FORMAT_R32F`
+     *
      * - `graphics.TEXTURE_FORMAT_RG32F`
+     *
      * You can test if the device supports these values by checking if a specific enum is nil or not:
+     *
      * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
      * -- it is safe to use this format
      * end
      * `
+     *
      * `flags`
      * number Texture creation flags that can be used to dictate how the texture is created. Supported values:
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+     *
      * - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+     *
      * `max_mipmaps`
      * number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
      * `compression_type`
      * number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
      * Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     *
      * - `COMPRESSION_TYPE_DEFAULT`
+     *
      * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - optional buffer of precreated pixel data
      * @param callback - callback function when texture is created (self, request_id, resource)
@@ -586,8 +718,11 @@ declare global {
     function create_texture_async(path: string | Hash, table: { type?: number; width?: number; height?: number; depth?: number; format?: number; flags?: number; max_mipmaps?: number; compression_type?: number }, buffer: Opaque<"buffer">, callback: (...args: unknown[]) => unknown): LuaMultiReturn<[Hash, number]>;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -619,9 +754,13 @@ declare global {
      *
      * @param path - The path to the atlas resource
      * @returns A table with the following entries:
+     *
      * - texture
+     *
      * - geometries
+     *
      * - animations
+     *
      * Each animation entry also contains a `frames` table with indices into
      * `geometries`, preserving the frame-to-geometry mapping used by the atlas.
      * See resource.set_atlas for a detailed description of each field
@@ -654,6 +793,7 @@ declare global {
      *
      * @param path - The path to the resource or a render target handle
      * @returns A table containing info about the render target:
+     *
      * `handle`
      * number the opaque handle to the texture resource
      * 'attachments'
@@ -668,19 +808,31 @@ declare global {
      * number number of mipmaps of the texture
      * `type`
      * number The texture type. Supported values:
+     *
      * - `graphics.TEXTURE_TYPE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     *
      * - `graphics.TEXTURE_TYPE_2D_ARRAY`
+     *
      * `buffer_type`
      * number The attachment buffer type. Supported values:
+     *
      * - `resource.BUFFER_TYPE_COLOR0`
+     *
      * - `resource.BUFFER_TYPE_COLOR1`
+     *
      * - `resource.BUFFER_TYPE_COLOR2`
+     *
      * - `resource.BUFFER_TYPE_COLOR3`
+     *
      * - `resource.BUFFER_TYPE_DEPTH`
+     *
      * -
      * `resource.BUFFER_TYPE_STENCIL`
+     *
      * -
+     *
      * `texture`
      * hash The hashed path to the attachment texture resource. This field is only available if the render target passed in is a resource.
      * @example
@@ -715,6 +867,7 @@ declare global {
      * @param url - the font to get the (unscaled) metrics from
      * @param text - text to measure
      * @param options - A table containing parameters for the text. Supported entries:
+     *
      * `width`
      * number The width of the text field. Not used if `line_break` is false.
      * `leading`
@@ -724,9 +877,13 @@ declare global {
      * `line_break`
      * boolean If the calculation should consider line breaks (default false)
      * @returns a table with the following fields:
+     *
      * - width
+     *
      * - height
+     *
      * - max_ascent
+     *
      * - max_descent
      * @example
      * ```ts
@@ -745,6 +902,7 @@ declare global {
      *
      * @param path - The path to the resource or a texture handle
      * @returns A table containing info about the texture:
+     *
      * `handle`
      * number the opaque handle to the texture resource
      * `width`
@@ -761,11 +919,17 @@ declare global {
      * number usage hints of the texture.
      * `type`
      * number The texture type. Supported values:
+     *
      * - `graphics.TEXTURE_TYPE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_2D_ARRAY`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
      * @example
      * ```ts
@@ -830,8 +994,11 @@ declare global {
     function load(path: string): Opaque<"buffer">;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -867,8 +1034,11 @@ declare global {
     function release(path: Hash | string): void;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -916,49 +1086,79 @@ declare global {
      *
      * @param path - The path to the atlas resource
      * @param table - A table containing info about the atlas. Supported entries:
+     *
      * -
+     *
      * `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
+     *
      * -
+     *
      * `animations`
      * table a list of the animations in the atlas. Supports the following fields:
+     *
      * -
+     *
      * `id`
      * string the id of the animation, used in e.g sprite.play_animation
+     *
      * -
+     *
      * `width`
      * number the width of the animation
+     *
      * -
+     *
      * `height`
      * number the height of the animation
+     *
      * -
+     *
      * `frame_start`
      * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
+     *
      * -
+     *
      * `frame_end`
      * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
+     *
      * -
+     *
      * `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
+     *
      * -
+     *
      * `fps`
      * number optional fps of the animation, the default value is 30
+     *
      * -
+     *
      * `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
+     *
      * -
+     *
      * `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
+     *
      * -
+     *
      * `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
+     *
      * -
+     *
      * `vertices`
      * table a list of the vertices in texture space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
+     *
      * -
+     *
      * `uvs`
      * table a list of the uv coordinates in texture space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}
+     *
      * -
+     *
      * `indices`
      * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @example
@@ -1020,7 +1220,9 @@ declare global {
      * @param path - The path to the resource
      * @param buffer - The resource buffer
      * @param table - A table containing info about how to set the buffer. Supported entries:
+     *
      * -
+     *
      * `transfer_ownership`
      * boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default false)
      * @example
@@ -1070,22 +1272,33 @@ declare global {
      *
      * @param path - The path to the resource
      * @param table - A table containing info about the texture. Supported entries:
+     *
      * `type`
      * number The texture type. Supported values:
+     *
      * - `graphics.TEXTURE_TYPE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     *
      * - `graphics.TEXTURE_TYPE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     *
      * `width`
      * number The width of the texture (in pixels)
      * `height`
      * number The width of the texture (in pixels)
      * `format`
      * number The texture format, note that some of these formats are platform specific. Supported values:
+     *
      * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     *
      * - `graphics.TEXTURE_FORMAT_RGB`
+     *
      * - `graphics.TEXTURE_FORMAT_RGBA`
+     *
      * These constants might not be available on the device:
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
      * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
@@ -1108,10 +1321,12 @@ declare global {
      * - `graphics.TEXTURE_FORMAT_R32F`
      * - `graphics.TEXTURE_FORMAT_RG32F`
      * You can test if the device supports these values by checking if a specific enum is nil or not:
+     *
      * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
      * -- it is safe to use this format
      * end
      * `
+     *
      * `x`
      * number optional x offset of the texture (in pixels)
      * `y`
@@ -1124,7 +1339,9 @@ declare global {
      * number optional mipmap to upload the data to
      * `compression_type`
      * number optional specify the compression type for the data in the buffer object that holds the texture data. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     *
      * - `COMPRESSION_TYPE_DEFAULT`
+     *
      * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - The buffer of precreated pixel data
      * To update a cube map texture you need to pass in six times the amount of data via the buffer, since a cube map has six sides!
@@ -1261,8 +1478,11 @@ declare global {
     function set_texture(path: Hash | string, table: { type?: number; width?: number; height?: number; format?: number; x?: number; y?: number; z?: number; page?: number; mipmap?: number; compression_type?: number }, buffer: Opaque<"buffer">): void;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource
@@ -1282,8 +1502,11 @@ declare global {
     function texture(path?: string): Hash;
     /**
      * Constructor-like function with two purposes:
+     *
      * - Load the specified resource as part of loading the script
+     *
      * - Return a hash to the run-time version of the resource
+     *
      * This function can only be called within go.property function calls.
      *
      * @param path - optional resource path string to the resource

package/generated/socket.d.ts

@@ -8,13 +8,17 @@ declare global {
    * runtime, which contain the core C functionality. Additional LuaSocket support modules for
    * SMTP, HTTP, FTP etc are not part of the core included, but can be easily added to a project
    * and used.
+   *
    * [icon:html5] On HTML5, the non-network helpers remain available, but TCP, UDP and
    * `socket.select()` are not supported.
+   *
    * Note the included helper module "socket.lua" in "builtins/scripts/socket.lua". Require this
    * module to add some additional functions and shortcuts to the namespace:
+   *
    * ```lua
    * require "builtins.scripts.socket"
    * ```
+   *
    * LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
    * LuaSocket is free software, released under the MIT license (same license as the Lua core).
    */

package/generated/sound.d.ts

@@ -106,8 +106,11 @@ declare global {
      * in the Android SDK. If your game is playing any sounds, *even with a gain of zero*, this
      * function will return `false`.
      * The best time to call this function is:
+     *
      * - In the `init` function of your main collection script before any sounds are triggered
+     *
      * - In a window listener callback when the window.WINDOW_EVENT_FOCUS_GAINED event is received
+     *
      * Both those times will give you a correct reading of the state even when your application is
      * swapped out and in while playing sounds and it works equally well on Android and iOS.
      *
@@ -170,13 +173,16 @@ declare global {
      * `start_frame`
      * number start playback offset (frames/samples). Optional, mutually exclusive with `start_time`. If both are provided, `start_frame` is used.
      * @param complete_function - function to call when the sound has finished playing or stopped manually via sound.stop.
+     *
      * `self`
      * object The current object.
      * `message_id`
      * hash The name of the completion message, which can be either `"sound_done"` if the sound has finished playing, or `"sound_stopped"` if it was stopped manually.
      * `message`
      * table Information about the completion:
+     *
      * - number `play_id` - the sequential play identifier that was given by the sound.play function.
+     *
      * `sender`
      * url The invoker of the callback: the sound component.
      * @returns The identifier for the sound voice