@defold-typescript/types 0.5.2 → 0.5.4

package/generated/http.d.ts

@@ -8,30 +8,30 @@ declare global {
      * @param url - target url
      * @param method - HTTP/HTTPS method, e.g. "GET", "PUT", "POST" etc.
      * @param callback - response callback function
-  `self`
-  object The script instance
-  `id`
-  hash Internal message identifier. Do not use!
-  `response`
-  table The response data. Contains the fields:
-  - number `status`: the status of the response
-  - string `response`: the response data (if not saved on disc)
-  - table `headers`: all the returned headers (if status is 200 or 206)
-  - string `path`: the stored path (if saved to disc)
-  - string `error`: if any unforeseen errors occurred (e.g. file I/O)
-  - number `bytes_received`: the amount of bytes received/sent for a request, only if option `report_progress` is true
-  - number `bytes_total`: the total amount of bytes for a request, only if option `report_progress` is true
-  - number `range_start`: the start offset into the requested file
-  - number `range_end`: the end offset into the requested file (inclusive)
-  - number `document_size`: the full size of the requested file
+     * `self`
+     * object The script instance
+     * `id`
+     * hash Internal message identifier. Do not use!
+     * `response`
+     * table The response data. Contains the fields:
+     * - number `status`: the status of the response
+     * - string `response`: the response data (if not saved on disc)
+     * - table `headers`: all the returned headers (if status is 200 or 206)
+     * - string `path`: the stored path (if saved to disc)
+     * - string `error`: if any unforeseen errors occurred (e.g. file I/O)
+     * - number `bytes_received`: the amount of bytes received/sent for a request, only if option `report_progress` is true
+     * - number `bytes_total`: the total amount of bytes for a request, only if option `report_progress` is true
+     * - number `range_start`: the start offset into the requested file
+     * - number `range_end`: the end offset into the requested file (inclusive)
+     * - number `document_size`: the full size of the requested file
      * @param headers - optional table with custom headers
      * @param post_data - optional data to send
      * @param options - optional table with request parameters. Supported entries:
-  - number `timeout`: timeout in seconds
-  - string `path`: path on disc where to download the file. Only overwrites the path if status is 200. Path should be absolute
-  - boolean `ignore_cache`: don't return cached data if we get a 304. Not available in HTML5 build
-  - boolean `chunked_transfer`: use chunked transfer encoding for https requests larger than 16kb. Defaults to true. Not available in HTML5 build
-  - boolean `report_progress`: when it is true, the amount of bytes sent and/or received for a request will be passed into the callback function
+     * - number `timeout`: timeout in seconds
+     * - string `path`: path on disc where to download the file. Only overwrites the path if status is 200. Path should be absolute
+     * - boolean `ignore_cache`: don't return cached data if we get a 304. Not available in HTML5 build
+     * - boolean `chunked_transfer`: use chunked transfer encoding for https requests larger than 16kb. Defaults to true. Not available in HTML5 build
+     * - boolean `report_progress`: when it is true, the amount of bytes sent and/or received for a request will be passed into the callback function
      * @example
      * ```lua
      * Basic HTTP-GET request. The callback receives a table with the response

package/generated/iac.d.ts

@@ -6,7 +6,7 @@ declare global {
      *
      * @param payload - The iac payload.
      * @param type - The type of iac, an iac.TYPE_ enumeration. It can be one of the predefined constants below
-  - `iac.TYPE_INVOCATION`
+     * - `iac.TYPE_INVOCATION`
      */
     function set_listener(payload: Record<string | number, unknown>, type: number): void;
   }

package/generated/iap.d.ts

@@ -26,10 +26,10 @@ declare global {
      * Get current iap provider
      *
      * @returns one of the following values
-  - `iap.PROVIDER_ID_GOOGLE`
-  - `iap.PROVIDER_ID_AMAZON`
-  - `iap.PROVIDER_ID_APPLE`
-  - `iap.PROVIDER_ID_FACEBOOK`
+     * - `iap.PROVIDER_ID_GOOGLE`
+     * - `iap.PROVIDER_ID_AMAZON`
+     * - `iap.PROVIDER_ID_APPLE`
+     * - `iap.PROVIDER_ID_FACEBOOK`
      */
     function get_provider_id(): Opaque<"constant">;
     /**

package/generated/image.d.ts

@@ -24,12 +24,12 @@ declare global {
      *
      * @param buffer - .astc file data buffer
      * @returns header or `nil` if buffer is not a valid .astc. The header has these fields:
-  - number `width`: image width
-  - number `height`: image height
-  - number `depth`: image depth
-  - number `block_size_x`: block size x
-  - number `block_size_y`: block size y
-  - number `block_size_z`: block size z
+     * - number `width`: image width
+     * - number `height`: image height
+     * - number `depth`: image depth
+     * - number `block_size_x`: block size x
+     * - number `block_size_y`: block size y
+     * - number `block_size_z`: block size z
      * @example
      * ```lua
      * How to get the block size and dimensions from a .astc file
@@ -44,19 +44,19 @@ declare global {
      *
      * @param buffer - image data buffer
      * @param options - An optional table containing parameters for loading the image. Supported entries:
-  `premultiply_alpha`
-  boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
-  `flip_vertically`
-  boolean True if the image contents should be flipped vertically. Defaults to `false`.
+     * `premultiply_alpha`
+     * boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
+     * `flip_vertically`
+     * boolean True if the image contents should be flipped vertically. Defaults to `false`.
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
-  - number `width`: image width
-  - number `height`: image height
-  - constant `type`: image type
-  - `image.TYPE_RGB`
-  - `image.TYPE_RGBA`
-  - `image.TYPE_LUMINANCE`
-  - `image.TYPE_LUMINANCE_ALPHA`
-  - string `buffer`: the raw image data
+     * - number `width`: image width
+     * - number `height`: image height
+     * - constant `type`: image type
+     * - `image.TYPE_RGB`
+     * - `image.TYPE_RGBA`
+     * - `image.TYPE_LUMINANCE`
+     * - `image.TYPE_LUMINANCE_ALPHA`
+     * - string `buffer`: the raw image data
      * @example
      * ```lua
      * How to load an image from an URL and create a GUI texture from it:
@@ -73,19 +73,19 @@ declare global {
      *
      * @param buffer - image data buffer
      * @param options - An optional table containing parameters for loading the image. Supported entries:
-  `premultiply_alpha`
-  boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
-  `flip_vertically`
-  boolean True if the image contents should be flipped vertically. Defaults to `false`.
+     * `premultiply_alpha`
+     * boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
+     * `flip_vertically`
+     * boolean True if the image contents should be flipped vertically. Defaults to `false`.
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
-  - number `width`: image width
-  - number `height`: image height
-  - constant `type`: image type
-  - `image.TYPE_RGB`
-  - `image.TYPE_RGBA`
-  - `image.TYPE_LUMINANCE`
-  - `image.TYPE_LUMINANCE_ALPHA`
-  - buffer `buffer`: the script buffer that holds the decompressed image data. See buffer.create how to use the buffer.
+     * - number `width`: image width
+     * - number `height`: image height
+     * - constant `type`: image type
+     * - `image.TYPE_RGB`
+     * - `image.TYPE_RGBA`
+     * - `image.TYPE_LUMINANCE`
+     * - `image.TYPE_LUMINANCE_ALPHA`
+     * - buffer `buffer`: the script buffer that holds the decompressed image data. See buffer.create how to use the buffer.
      * @example
      * ```lua
      * Load an image from an URL as a buffer and create a texture resource from it:

package/generated/json.d.ts

@@ -11,7 +11,7 @@ declare global {
      *
      * @param json - json data
      * @param options - table with decode options
-  - boolean `decode_null_as_userdata`: wether to decode a JSON null value as json.null or nil (default is nil)
+     * - boolean `decode_null_as_userdata`: wether to decode a JSON null value as json.null or nil (default is nil)
      * @returns decoded json
      * @example
      * ```lua
@@ -42,7 +42,7 @@ declare global {
      *
      * @param tbl - lua table to encode
      * @param options - table with encode options
-  - string `encode_empty_table_as_object`: wether to encode an empty table as an JSON object or array (default is object)
+     * - string `encode_empty_table_as_object`: wether to encode an empty table as an JSON object or array (default is object)
      * @returns encoded json
      * @example
      * ```lua

package/generated/kinds/gui-script.d.ts

@@ -1,4 +1,5 @@
 import "../../src/go-overloads";
+import "../../src/message-guard";
 import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";

package/generated/kinds/render-script.d.ts

@@ -1,4 +1,5 @@
 import "../../src/go-overloads";
+import "../../src/message-guard";
 import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";

package/generated/kinds/script.d.ts

@@ -1,4 +1,5 @@
 import "../../src/go-overloads";
+import "../../src/message-guard";
 import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";

package/generated/model.d.ts

@@ -87,31 +87,31 @@ declare global {
      * @param url - the model for which to play the animation
      * @param anim_id - id of the animation to play
      * @param playback - playback mode of the animation
-  - `go.PLAYBACK_ONCE_FORWARD`
-  - `go.PLAYBACK_ONCE_BACKWARD`
-  - `go.PLAYBACK_ONCE_PINGPONG`
-  - `go.PLAYBACK_LOOP_FORWARD`
-  - `go.PLAYBACK_LOOP_BACKWARD`
-  - `go.PLAYBACK_LOOP_PINGPONG`
+     * - `go.PLAYBACK_ONCE_FORWARD`
+     * - `go.PLAYBACK_ONCE_BACKWARD`
+     * - `go.PLAYBACK_ONCE_PINGPONG`
+     * - `go.PLAYBACK_LOOP_FORWARD`
+     * - `go.PLAYBACK_LOOP_BACKWARD`
+     * - `go.PLAYBACK_LOOP_PINGPONG`
      * @param play_properties - optional table with properties
-  Play properties table:
-  `blend_duration`
-  number Duration of a linear blend between the current and new animation.
-  `offset`
-  number The normalized initial value of the animation cursor when the animation starts playing.
-  `playback_rate`
-  number The rate with which the animation will be played. Must be positive.
+     * Play properties table:
+     * `blend_duration`
+     * number Duration of a linear blend between the current and new animation.
+     * `offset`
+     * number The normalized initial value of the animation cursor when the animation starts playing.
+     * `playback_rate`
+     * number The rate with which the animation will be played. Must be positive.
      * @param complete_function - function to call when the animation has completed.
-  `self`
-  object The current object.
-  `message_id`
-  hash The name of the completion message, `"model_animation_done"`.
-  `message`
-  table Information about the completion:
-  - hash `animation_id` - the animation that was completed.
-  - constant `playback` - the playback mode for the animation.
-  `sender`
-  url The invoker of the callback: the model component.
+     * `self`
+     * object The current object.
+     * `message_id`
+     * hash The name of the completion message, `"model_animation_done"`.
+     * `message`
+     * table Information about the completion:
+     * - hash `animation_id` - the animation that was completed.
+     * - constant `playback` - the playback mode for the animation.
+     * `sender`
+     * url The invoker of the callback: the model component.
      * @example
      * ```lua
      * The following examples assumes that the model has id "model".

package/generated/particlefx.d.ts

@@ -27,18 +27,18 @@ declare global {
      *
      * @param url - the particle fx that should start playing.
      * @param emitter_state_function - optional callback function that will be called when an emitter attached to this particlefx changes state.
-  `self`
-  object The current object
-  `id`
-  hash The id of the particle fx component
-  `emitter`
-  hash The id of the emitter
-  `state`
-  constant the new state of the emitter:
-  - `particlefx.EMITTER_STATE_SLEEPING`
-  - `particlefx.EMITTER_STATE_PRESPAWN`
-  - `particlefx.EMITTER_STATE_SPAWNING`
-  - `particlefx.EMITTER_STATE_POSTSPAWN`
+     * `self`
+     * object The current object
+     * `id`
+     * hash The id of the particle fx component
+     * `emitter`
+     * hash The id of the emitter
+     * `state`
+     * constant the new state of the emitter:
+     * - `particlefx.EMITTER_STATE_SLEEPING`
+     * - `particlefx.EMITTER_STATE_PRESPAWN`
+     * - `particlefx.EMITTER_STATE_SPAWNING`
+     * - `particlefx.EMITTER_STATE_POSTSPAWN`
      * @example
      * ```lua
      * How to play a particle fx when a game object is created.
@@ -107,7 +107,7 @@ declare global {
      *
      * @param url - the particle fx that should stop playing
      * @param options - Options when stopping the particle fx. Supported options:
-  - boolean `clear`: instantly clear spawned particles
+     * - boolean `clear`: instantly clear spawned particles
      * @example
      * ```lua
      * How to stop a particle fx when a game object is deleted and immediately also clear

package/generated/physics.d.ts

@@ -42,8 +42,8 @@ declare global {
      * @param collisionobject_b - second collision object
      * @param position_b - local position where to attach the joint on the second collision object
      * @param properties - optional joint specific properties table
-  See each joint type for possible properties field. The one field that is accepted for all joint types is:
-  - boolean `collide_connected`: Set this flag to true if the attached bodies should collide.
+     * See each joint type for possible properties field. The one field that is accepted for all joint types is:
+     * - boolean `collide_connected`: Set this flag to true if the attached bodies should collide.
      */
     function create_joint(joint_type: number, collisionobject_a: string | Hash | Url, joint_id: string | Hash, position_a: Vector3, collisionobject_b: string | Hash | Url, position_b: Vector3, properties?: Record<string | number, unknown>): void;
     /**
@@ -77,11 +77,11 @@ declare global {
      *
      * @param url - the collision object to return the group of.
      * @returns hash value of the group.
-  `local function check_is_enemy()
-  local group = physics.get_group("#collisionobject")
-  return group == hash("enemy")
-  end
-  `
+     * `local function check_is_enemy()
+     * local group = physics.get_group("#collisionobject")
+     * return group == hash("enemy")
+     * end
+     * `
      */
     function get_group(url: string | Hash | Url): Hash;
     /**
@@ -92,7 +92,7 @@ declare global {
      * @param collisionobject - collision object where the joint exist
      * @param joint_id - id of the joint
      * @returns properties table. See the joint types for what fields are available, the only field available for all types is:
-  - boolean `collide_connected`: Set this flag to true if the attached bodies should collide.
+     * - boolean `collide_connected`: Set this flag to true if the attached bodies should collide.
      */
     function get_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash): { collide_connected: boolean };
     /**
@@ -122,12 +122,12 @@ declare global {
      * @param url - the collision object to check the mask of.
      * @param group - the name of the group to check for.
      * @returns boolean value of the maskbit. 'true' if present, 'false' otherwise.
-  `local function is_invincible()
-  -- check if the collisionobject would collide with the "bullet" group
-  local invincible = physics.get_maskbit("#collisionobject", "bullet")
-  return invincible
-  end
-  `
+     * `local function is_invincible()
+     * -- check if the collisionobject would collide with the "bullet" group
+     * local invincible = physics.get_maskbit("#collisionobject", "bullet")
+     * return invincible
+     * end
+     * `
      */
     function get_maskbit(url: string | Hash | Url, group: string): boolean;
     /**
@@ -136,30 +136,30 @@ declare global {
      * @param url - the collision object.
      * @param shape - the name of the shape to get data for.
      * @returns A table containing meta data about the physics shape
-  `type`
-  number The shape type. Supported values:
-  - `physics.SHAPE_TYPE_SPHERE`
-  - `physics.SHAPE_TYPE_BOX`
-  - `physics.SHAPE_TYPE_CAPSULE` *Only supported for 3D physics*
-  - `physics.SHAPE_TYPE_HULL`
-  The returned table contains different fields depending on which type the shape is.
-  If the shape is a sphere:
-  `diameter`
-  number the diameter of the sphere shape
-  If the shape is a box:
-  `dimensions`
-  vector3 a `vmath.vector3` of the box dimensions
-  If the shape is a capsule:
-  `diameter`
-  number the diameter of the capsule poles
-  `height`
-  number the height of the capsule
-  `local function get_shape_meta()
-  local sphere = physics.get_shape("#collisionobject", "my_sphere_shape")
-  -- returns a table with sphere.diameter
-  return sphere
-  end
-  `
+     * `type`
+     * number The shape type. Supported values:
+     * - `physics.SHAPE_TYPE_SPHERE`
+     * - `physics.SHAPE_TYPE_BOX`
+     * - `physics.SHAPE_TYPE_CAPSULE` *Only supported for 3D physics*
+     * - `physics.SHAPE_TYPE_HULL`
+     * The returned table contains different fields depending on which type the shape is.
+     * If the shape is a sphere:
+     * `diameter`
+     * number the diameter of the sphere shape
+     * If the shape is a box:
+     * `dimensions`
+     * vector3 a `vmath.vector3` of the box dimensions
+     * If the shape is a capsule:
+     * `diameter`
+     * number the diameter of the capsule poles
+     * `height`
+     * number the height of the capsule
+     * `local function get_shape_meta()
+     * local sphere = physics.get_shape("#collisionobject", "my_sphere_shape")
+     * -- returns a table with sphere.diameter
+     * return sphere
+     * end
+     * `
      */
     function get_shape(url: string | Hash | Url, shape: string | Hash): { type: number; diameter: number; dimensions: Vector3; diameter: number; height: number };
     /**
@@ -174,8 +174,8 @@ declare global {
      * @param to - the world position of the end of the ray
      * @param groups - a lua table containing the hashed groups for which to test collisions against
      * @param options - a lua table containing options for the raycast.
-  `all`
-  boolean Set to `true` to return all ray cast hits. If `false`, it will only return the closest hit.
+     * `all`
+     * boolean Set to `true` to return all ray cast hits. If `false`, it will only return the closest hit.
      * @returns It returns a list. If missed it returns `nil`. See ray_cast_response for details on the returned values.
      * @example
      * ```lua
@@ -239,17 +239,17 @@ declare global {
      * Only one physics world event listener can be set at a time.
      *
      * @param callback - A callback that receives an information about all the physics interactions in this physics world.
-  `self`
-  object The calling script
-  `event`
-  constant The type of event. Can be one of these messages:
-  - contact_point_event
-  - collision_event
-  - trigger_event
-  - ray_cast_response
-  - ray_cast_missed
-  `data`
-  table The callback value data is a table that contains event-related data. See the documentation for details on the messages.
+     * `self`
+     * object The calling script
+     * `event`
+     * constant The type of event. Can be one of these messages:
+     * - contact_point_event
+     * - collision_event
+     * - trigger_event
+     * - ray_cast_response
+     * - ray_cast_missed
+     * `data`
+     * table The callback value data is a table that contains event-related data. See the documentation for details on the messages.
      * @example
      * ```lua
      * local function physics_world_listener(self, events)
@@ -352,10 +352,10 @@ declare global {
      *
      * @param url - the collision object affected.
      * @param group - the new group name to be assigned.
-  `local function change_collision_group()
-  physics.set_group("#collisionobject", "enemy")
-  end
-  `
+     * `local function change_collision_group()
+     * physics.set_group("#collisionobject", "enemy")
+     * end
+     * `
      */
     function set_group(url: string | Hash | Url, group: string): void;
     /**
@@ -380,7 +380,7 @@ declare global {
      * @param collisionobject - collision object where the joint exist
      * @param joint_id - id of the joint
      * @param properties - joint specific properties table
-  Note: The `collide_connected` field cannot be updated/changed after a connection has been made.
+     * Note: The `collide_connected` field cannot be updated/changed after a connection has been made.
      */
     function set_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash, properties: Record<string | number, unknown>): void;
     /**
@@ -389,11 +389,11 @@ declare global {
      * @param url - the collision object to change the mask of.
      * @param group - the name of the group (maskbit) to modify in the mask.
      * @param maskbit - boolean value of the new maskbit. 'true' to enable, 'false' to disable.
-  `local function make_invincible()
-  -- no longer collide with the "bullet" group
-  physics.set_maskbit("#collisionobject", "bullet", false)
-  end
-  `
+     * `local function make_invincible()
+     * -- no longer collide with the "bullet" group
+     * physics.set_maskbit("#collisionobject", "bullet", false)
+     * end
+     * `
      */
     function set_maskbit(url: string | Hash | Url, group: string, maskbit: boolean): void;
     /**
@@ -404,26 +404,26 @@ declare global {
      * @param url - the collision object.
      * @param shape - the name of the shape to get data for.
      * @param table - the shape data to update the shape with.
-  See physics.get_shape for a detailed description of each field in the data table.
-  `local function set_shape_data()
-  -- set capsule shape data
-  local data = {}
-  data.type = physics.SHAPE_TYPE_CAPSULE
-  data.diameter = 10
-  data.height = 20
-  physics.set_shape("#collisionobject", "my_capsule_shape", data)
-  -- set sphere shape data
-  data = {}
-  data.type = physics.SHAPE_TYPE_SPHERE
-  data.diameter = 10
-  physics.set_shape("#collisionobject", "my_sphere_shape", data)
-  -- set box shape data
-  data = {}
-  data.type = physics.SHAPE_TYPE_BOX
-  data.dimensions = vmath.vector3(10, 10, 5)
-  physics.set_shape("#collisionobject", "my_box_shape", data)
-  end
-  `
+     * See physics.get_shape for a detailed description of each field in the data table.
+     * `local function set_shape_data()
+     * -- set capsule shape data
+     * local data = {}
+     * data.type = physics.SHAPE_TYPE_CAPSULE
+     * data.diameter = 10
+     * data.height = 20
+     * physics.set_shape("#collisionobject", "my_capsule_shape", data)
+     * -- set sphere shape data
+     * data = {}
+     * data.type = physics.SHAPE_TYPE_SPHERE
+     * data.diameter = 10
+     * physics.set_shape("#collisionobject", "my_sphere_shape", data)
+     * -- set box shape data
+     * data = {}
+     * data.type = physics.SHAPE_TYPE_BOX
+     * data.dimensions = vmath.vector3(10, 10, 5)
+     * physics.set_shape("#collisionobject", "my_box_shape", data)
+     * end
+     * `
      */
     function set_shape(url: string | Hash | Url, shape: string | Hash, table: { type?: number; diameter?: number; dimensions?: Vector3; diameter?: number; height?: number }): void;
     /**
@@ -457,12 +457,12 @@ declare global {
      * efficiency reasons. This function wakes them up.
      *
      * @param url - the collision object to wake.
-  `function on_input(self, action_id, action)
-  if action_id == hash("test") and action.pressed then
-  physics.wakeup("#collisionobject")
-  end
-  end
-  `
+     * `function on_input(self, action_id, action)
+     * if action_id == hash("test") and action.pressed then
+     * physics.wakeup("#collisionobject")
+     * end
+     * end
+     * `
      */
     function wakeup(url: string | Hash | Url): void;
     interface properties {

package/generated/profiler.d.ts

@@ -144,13 +144,13 @@ declare global {
      * Set the on-screen profile mode - run, pause, record or show peak frame
      *
      * @param mode - the mode to set the ui profiler in
-  - `profiler.MODE_RUN` This is default mode that continously shows the last frame
-  - `profiler.MODE_PAUSE` Pauses on the currently displayed frame
-  - `profiler.MODE_SHOW_PEAK_FRAME` Pauses on the currently displayed frame but shows a new frame if that frame is slower
-  - `profiler.MODE_RECORD` Records all incoming frames to the recording buffer
-  To stop recording, switch to a different mode such as `MODE_PAUSE` or `MODE_RUN`.
-  You can also use the `view_recorded_frame` function to display a recorded frame. Doing so stops the recording as well.
-  Every time you switch to recording mode the recording buffer is cleared.
+     * - `profiler.MODE_RUN` This is default mode that continously shows the last frame
+     * - `profiler.MODE_PAUSE` Pauses on the currently displayed frame
+     * - `profiler.MODE_SHOW_PEAK_FRAME` Pauses on the currently displayed frame but shows a new frame if that frame is slower
+     * - `profiler.MODE_RECORD` Records all incoming frames to the recording buffer
+     * To stop recording, switch to a different mode such as `MODE_PAUSE` or `MODE_RUN`.
+     * You can also use the `view_recorded_frame` function to display a recorded frame. Doing so stops the recording as well.
+     * Every time you switch to recording mode the recording buffer is cleared.
      * @example
      * ```lua
      * function start_recording()
@@ -167,8 +167,8 @@ declare global {
      * Set the on-screen profile view mode - minimized or expanded
      *
      * @param mode - the view mode to set the ui profiler in
-  - `profiler.VIEW_MODE_FULL` The default mode which displays all the ui profiler details
-  - `profiler.VIEW_MODE_MINIMIZED` Minimized mode which only shows the top header (fps counters and ui profiler mode)
+     * - `profiler.VIEW_MODE_FULL` The default mode which displays all the ui profiler details
+     * - `profiler.VIEW_MODE_MINIMIZED` Minimized mode which only shows the top header (fps counters and ui profiler mode)
      * @example
      * ```lua
      * -- Minimize the profiler view
@@ -201,8 +201,8 @@ declare global {
      * The frame to show can either be an absolute frame or a relative frame to the current frame.
      *
      * @param frame_index - a table where you specify one of the following parameters:
-  - `distance` The offset from the currently displayed frame (this is truncated between zero and the number of recorded frames)
-  - `frame` The frame index in the recording buffer (1 is first recorded frame)
+     * - `distance` The offset from the currently displayed frame (this is truncated between zero and the number of recorded frames)
+     * - `frame` The frame index in the recording buffer (1 is first recorded frame)
      * @example
      * ```lua
      * -- Go back one frame