@defold-typescript/types 0.38.0 → 0.40.0

package/generated/resource.d.ts

@@ -18,20 +18,28 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load an atlas and set it to a sprite:
      * ```ts
      * // Load an atlas and set it to a sprite:
-     * go.property("my_atlas", resource.atlas("/atlas.atlas"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_atlas: resource.atlas("/atlas.atlas") },
+     *
      *   init(self) {
      *     go.set("#sprite", "image", self.my_atlas);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load an atlas and set it to a gui:
+     * ```ts
      * // Load an atlas and set it to a gui:
-     * go.property("my_atlas", resource.atlas("/atlas.atlas"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_atlas: resource.atlas("/atlas.atlas") },
+     *
      *   init(self) {
      *     go.set("#gui", "textures", self.my_atlas, { key: "my_atlas" });
      *   },
@@ -53,9 +61,11 @@ declare global {
      * @example
      * ```ts
      * // Set a unique buffer it to a sprite:
-     * go.property("my_buffer", resource.buffer("/cube.buffer"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_buffer: resource.buffer("/cube.buffer") },
+     *
      *   init(self) {
      *     go.set("#mesh", "vertices", self.my_buffer);
      *   },
@@ -78,109 +88,67 @@ declare global {
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the atlas. Supported entries:
      *
-     * -
-     *
-     * `texture`
+     * - `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
      *
-     * -
-     *
-     * `animations`
+     * - `animations`
      * table a list of the animations in the atlas. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string the id of the animation, used in e.g sprite.play_animation
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number the width of the animation
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number the height of the animation
      *
-     * -
-     *
-     * `frame_start`
+     * - `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`
+     * - `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`
+     * - `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
      *
-     * -
-     *
-     * `fps`
+     * - `fps`
      * number optional fps of the animation, the default value is 30
      *
-     * -
-     *
-     * `flip_vertical`
+     * - `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
      *
-     * -
-     *
-     * `flip_horizontal`
+     * - `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
      *
-     * -
-     *
-     * `geometries`
+     * - `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string The name of the geometry. Used when matching animations between multiple atlases
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number The width of the image the sprite geometry represents
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number The height of the image the sprite geometry represents
      *
-     * -
-     *
-     * `pivot_x`
+     * - `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`
+     * - `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`
+     * - `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`
+     * - `vertices`
      * table a list of the vertices in image space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
      *
-     * -
-     *
-     * `uvs`
+     * - `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`
+     * - `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
      * @example
@@ -233,7 +201,7 @@ declare global {
      * });
      * ```
      */
-    function create_atlas(path: string, table: { texture?: string | Hash; animations?: { id?: string; width?: number; height?: number; frame_start?: number; frame_end?: number; playback?: Opaque<"constant">; fps?: number; flip_vertical?: boolean; flip_horizontal?: boolean }[]; geometries?: { id?: string; width?: number; height?: number; pivot_x?: number; pivot_y?: number; rotated?: boolean }[]; vertices?: number[]; uvs?: number[]; indices?: number[] }): Hash;
+    function create_atlas(path: string, table: { texture?: string | Hash; animations?: { id?: string; width?: number; height?: number; frame_start?: number; frame_end?: number; playback?: go.Playback; fps?: number; flip_vertical?: boolean; flip_horizontal?: boolean }[]; geometries?: { id?: string; width?: number; height?: number; pivot_x?: number; pivot_y?: number; rotated?: boolean }[]; vertices?: number[]; uvs?: number[]; indices?: number[] }): Hash;
     /**
      * This function creates a new buffer resource that can be used in the same way as any buffer created during build time.
      * The function requires a valid buffer created from either buffer.create or another pre-existing buffer resource.
@@ -247,17 +215,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`
      * buffer the buffer to bind to this resource
      *
-     * -
-     *
-     * `transfer_ownership`
+     * - `transfer_ownership`
      * boolean optional flag to determine whether or not the resource should take over ownership of the buffer object (default true)
      * @returns Returns the buffer resource path
      * @example
+     * Create a buffer object and bind it to a buffer resource
      * ```ts
      * // Create a buffer object and bind it to a buffer resource
      * export default defineScript({
@@ -285,15 +250,18 @@ declare global {
      *     const stream = buffer.get_stream(buffer_handle, hash("position"));
      *
      *     // transfer vertex data to buffer
-     *     for (let k = 0; k < positions.length; k++) {
-     *       stream[k] = positions[k];
-     *     }
+     *     positions.forEach((value, k) => {
+     *       stream[k] = value;
+     *     });
      *
      *     const my_buffer = resource.create_buffer("/my_buffer.bufferc", { buffer: buffer_handle });
      *     go.set("/go#mesh", "vertices", my_buffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Create a buffer resource from existing resource
+     * ```ts
      * // Create a buffer resource from existing resource
      * export default defineScript({
      *   init() {
@@ -326,6 +294,11 @@ declare global {
      * export default defineScript({
      *   init() {
      *     // create a new sound resource, given the initial chunk of the file
+     *     const [data] = sys.load_resource("/sounds/music_header.oggc");
+     *     if (data === undefined) {
+     *       return;
+     *     }
+     *     const filesize = 1048576;
      *     const relative_path = "/a/unique/resource/name.oggc";
      *     const hash = resource.create_sound_data(relative_path, { data, filesize, partial: true });
      *     go.set("#music", "sound", hash); // override the previous sound resource
@@ -449,7 +422,9 @@ declare global {
      * if graphics.TEXTURE_TYPE_3D ~= nil then
      * -- Device and graphics adapter support 3D textures
      * end
+     * ```
      * @example
+     * How to create an 128x128 RGBA texture resource and assign it to a model
      * ```ts
      * // How to create an 128x128 RGBA texture resource and assign it to a model
      * export default defineScript({
@@ -464,7 +439,10 @@ declare global {
      *     go.set("#model", "texture0", my_texture_id);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create an 128x128 floating point texture (RGBA32F) resource from a buffer object
+     * ```ts
      * // How to create an 128x128 floating point texture (RGBA32F) resource from a buffer object
      * export default defineScript({
      *   init() {
@@ -498,7 +476,10 @@ declare global {
      *     go.set("#model", "texture0", my_texture_id);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create a 32x32x32 floating point 3D texture that can be used to generate volumetric data in a compute shader
+     * ```ts
      * // How to create a 32x32x32 floating point 3D texture that can be used to generate volumetric data in a compute shader
      * export default defineScript({
      *   init() {
@@ -507,15 +488,18 @@ declare global {
      *       width: 32,
      *       height: 32,
      *       depth: 32,
-     *       format: resource.TEXTURE_FORMAT_RGBA32F,
-     *       flags: resource.TEXTURE_USAGE_FLAG_STORAGE + resource.TEXTURE_USAGE_FLAG_SAMPLE,
+     *       format: graphics.TEXTURE_FORMAT_RGBA32F,
+     *       flags: graphics.TEXTURE_USAGE_FLAG_STORAGE + graphics.TEXTURE_USAGE_FLAG_SAMPLE,
      *     });
      *
      *     // pass the backing texture to the render script
      *     msg.post("@render:", "add_textures", [t_volume]);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create 512x512 texture array with 5 pages.
+     * ```ts
      * // How to create 512x512 texture array with 5 pages.
      * const new_tex = resource.create_texture("/runtime/example_array.texturec", {
      *   type: graphics.TEXTURE_TYPE_2D_ARRAY,
@@ -526,7 +510,7 @@ declare global {
      * });
      * ```
      */
-    function create_texture(path: string, table: { type?: number; width?: number; height?: number; depth?: number; format?: number; flags?: number; max_mipmaps?: number; compression_type?: number }, buffer?: Opaque<"buffer">): Hash;
+    function create_texture(path: string, table: { type?: number; width?: number; height?: number; depth?: number; format?: number; flags?: number; max_mipmaps?: number; compression_type?: number; page_count?: number }, buffer?: Opaque<"buffer">): Hash;
     /**
      * Creates a new texture resource that can be used in the same way as any texture created during build time.
      * The path used for creating the texture must be unique, trying to create a resource at a path that is already
@@ -639,14 +623,15 @@ declare global {
      * @param buffer - optional buffer of precreated pixel data
      * @param callback - callback function when texture is created (self, request_id, resource)
      * @example
+     * Create a texture resource asyncronously with a buffer and a callback
      * ```ts
      * // Create a texture resource asyncronously with a buffer and a callback
-     * function callback(self, request_id, resource) {
+     * function callback(self: unknown, request_id: unknown, texture_path: unknown) {
      *   // The resource has been updated with a new texture,
      *   // so we can update other systems with the new handle,
      *   // or update components to use the resource if we want
-     *   const tinfo = resource.get_texture_info(resource);
-     *   msg.post("@render:", "set_backing_texture", tinfo.handle);
+     *   const tinfo = resource.get_texture_info(texture_path as Hash);
+     *   msg.post("@render:", "set_backing_texture", { handle: tinfo.handle });
      * }
      *
      * export default defineScript({
@@ -680,7 +665,10 @@ declare global {
      *     go.set("#model", "texture0", tpath);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Create a texture resource asyncronously without a callback
+     * ```ts
      * // Create a texture resource asyncronously without a callback
      * export default defineScript({
      *   init() {
@@ -728,20 +716,28 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load a font and set it to a label:
      * ```ts
      * // Load a font and set it to a label:
-     * go.property("my_font", resource.font("/font.font"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_font: resource.font("/font.font") },
+     *
      *   init(self) {
      *     go.set("#label", "font", self.my_font);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load a font and set it to a gui:
+     * ```ts
      * // Load a font and set it to a gui:
-     * go.property("my_font", resource.font("/font.font"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_font: resource.font("/font.font") },
+     *
      *   init(self) {
      *     go.set("#gui", "fonts", self.my_font, { key: "my_font" });
      *   },
@@ -765,7 +761,7 @@ declare global {
      * `geometries`, preserving the frame-to-geometry mapping used by the atlas.
      * See resource.set_atlas for a detailed description of each field
      */
-    function get_atlas(path: Hash | string): { texture: string | Hash; animations: { id: string; width: number; height: number; frame_start: number; frame_end: number; playback: Opaque<"constant">; fps: number; flip_vertical: boolean; flip_horizontal: boolean }[]; geometries: { vertices: number[]; uvs: number[]; indices: number[] }[] };
+    function get_atlas(path: Hash | string): { texture: string | Hash; animations: { id: string; width: number; height: number; frame_start: number; frame_end: number; playback: go.Playback; fps: number; flip_vertical: boolean; flip_horizontal: boolean }[]; geometries: { vertices: number[]; uvs: number[]; indices: number[] }[] };
     /**
      * gets the buffer from a resource
      *
@@ -776,11 +772,11 @@ declare global {
      * // How to get the data from a buffer
      * export default defineScript({
      *   init() {
-     *     const res_path = go.get("#mesh", "vertices");
+     *     const res_path = go.get<mesh.properties>()("#mesh", "vertices");
      *     const buf = resource.get_buffer(res_path);
      *     const stream_positions = buffer.get_stream(buf, "position");
      *
-     *     for (let i = 0; i < stream_positions.length; i++) {
+     *     for (let i = 0; i < stream_positions.length(); i++) {
      *       print(i, stream_positions[i]);
      *     }
      *   },
@@ -828,14 +824,12 @@ declare global {
      *
      * - `resource.BUFFER_TYPE_DEPTH`
      *
-     * -
-     * `resource.BUFFER_TYPE_STENCIL`
-     *
-     * -
+     * - `resource.BUFFER_TYPE_STENCIL`
      *
-     * `texture`
+     * - `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
+     * Get the metadata from a render target resource
      * ```ts
      * // Get the metadata from a render target resource
      * export default defineScript({
@@ -847,7 +841,10 @@ declare global {
      *     const info_attachment_1 = resource.get_texture_info(info.attachments[0]!.handle);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Get a texture attachment from a render target and set it on a model component
+     * ```ts
      * // Get a texture attachment from a render target and set it on a model component
      * export default defineScript({
      *   init() {
@@ -889,7 +886,7 @@ declare global {
      * ```ts
      * export default defineScript({
      *   init() {
-     *     const font = go.get("#label", "font");
+     *     const font = go.get<label.properties>()("#label", "font");
      *     const metrics = resource.get_text_metrics(font, "The quick brown fox\n jumps over the lazy dog");
      *     pprint(metrics);
      *   },
@@ -932,6 +929,7 @@ declare global {
      *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
      * @example
+     * Create a new texture and get the metadata from it
      * ```ts
      * // Create a new texture and get the metadata from it
      * export default defineScript({
@@ -960,7 +958,10 @@ declare global {
      *     // }
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Get the meta data from an atlas resource
+     * ```ts
      * // Get the meta data from an atlas resource
      * export default defineScript({
      *   init() {
@@ -1004,20 +1005,28 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load a material and set it to a sprite:
      * ```ts
      * // Load a material and set it to a sprite:
-     * go.property("my_material", resource.material("/material.material"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material("/material.material") },
+     *
      *   init(self) {
      *     go.set("#sprite", "material", self.my_material);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load a material resource and update a named material with the resource:
+     * ```ts
      * // Load a material resource and update a named material with the resource:
-     * go.property("my_material", resource.material("/material.material"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material("/material.material") },
+     *
      *   init(self) {
      *     go.set("#gui", "materials", self.my_material, { key: "my_material" });
      *   },
@@ -1046,9 +1055,11 @@ declare global {
      * @example
      * ```ts
      * // Set a render target color attachment as a model texture:
-     * go.property("my_render_target", resource.render_target("/rt.render_target"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_render_target: resource.render_target("/rt.render_target") },
+     *
      *   init(self) {
      *     const rt_info = resource.get_render_target_info(self.my_render_target);
      *     go.set("#model", "texture0", rt_info.attachments[0]!.texture!);
@@ -1067,7 +1078,7 @@ declare global {
      * // Assuming the folder "/res" is added to the project custom resources:
      * // load a texture resource and set it on a sprite
      * const buffer = resource.load("/res/new.texturec");
-     * resource.set(go.get("#sprite", "texture0"), buffer);
+     * resource.set(go.get<sprite.properties>()("#sprite", "texture0"), buffer);
      * ```
      */
     function set(path: string | Hash, buffer: Opaque<"buffer">): void;
@@ -1087,81 +1098,52 @@ declare global {
      * @param path - The path to the atlas resource
      * @param table - A table containing info about the atlas. Supported entries:
      *
-     * -
-     *
-     * `texture`
+     * - `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
      *
-     * -
-     *
-     * `animations`
+     * - `animations`
      * table a list of the animations in the atlas. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string the id of the animation, used in e.g sprite.play_animation
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number the width of the animation
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number the height of the animation
      *
-     * -
-     *
-     * `frame_start`
+     * - `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`
+     * - `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`
+     * - `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
      *
-     * -
-     *
-     * `fps`
+     * - `fps`
      * number optional fps of the animation, the default value is 30
      *
-     * -
-     *
-     * `flip_vertical`
+     * - `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
      *
-     * -
-     *
-     * `flip_horizontal`
+     * - `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
      *
-     * -
-     *
-     * `geometries`
+     * - `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
      *
-     * -
-     *
-     * `vertices`
+     * - `vertices`
      * table a list of the vertices in texture space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
      *
-     * -
-     *
-     * `uvs`
+     * - `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`
+     * - `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
+     * Add a new animation to an existing atlas
      * ```ts
      * // Add a new animation to an existing atlas
      * export default defineScript({
@@ -1175,12 +1157,17 @@ declare global {
      *       frame_end: 6,
      *       playback: go.PLAYBACK_LOOP_PINGPONG,
      *       fps: 8,
+     *       flip_vertical: false,
+     *       flip_horizontal: false,
      *     };
      *     data.animations.push(my_animation);
      *     resource.set_atlas("/main/my_atlas.a.texturesetc", data);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Sets atlas data for a 256x256 texture with a single animation being rendered as a quad
+     * ```ts
      * // Sets atlas data for a 256x256 texture with a single animation being rendered as a quad
      * export default defineScript({
      *   init() {
@@ -1207,7 +1194,7 @@ declare global {
      * });
      * ```
      */
-    function set_atlas(path: Hash | string, table: { texture?: string | Hash; animations?: { id?: string; width?: number; height?: number; frame_start?: number; frame_end?: number; playback?: Opaque<"constant">; fps?: number; flip_vertical?: boolean; flip_horizontal?: boolean }[]; geometries?: { vertices?: number[]; uvs?: number[]; indices?: number[] }[]; vertices?: number[]; uvs?: number[]; indices?: number[] }): void;
+    function set_atlas(path: Hash | string, table: { texture?: string | Hash; animations?: { id?: string; width?: number; height?: number; frame_start?: number; frame_end?: number; playback?: go.Playback; fps?: number; flip_vertical?: boolean; flip_horizontal?: boolean }[]; geometries?: { vertices?: number[]; uvs?: number[]; indices?: number[] }[]; vertices?: number[]; uvs?: number[]; indices?: number[] }): void;
     /**
      * Sets the buffer of a resource. By default, setting the resource buffer will either copy the data from the incoming buffer object
      * to the buffer stored in the destination resource, or make a new buffer object if the sizes between the source buffer and the destination buffer
@@ -1221,22 +1208,20 @@ declare global {
      * @param buffer - The resource buffer
      * @param table - A table containing info about how to set the buffer. Supported entries:
      *
-     * -
-     *
-     * `transfer_ownership`
+     * - `transfer_ownership`
      * boolean optional flag to determine whether or not the resource should take over ownership of the buffer object (default false)
      * @example
      * ```ts
      * // How to set the data from a buffer
-     * function fill_stream(stream, verts) {
+     * function fill_stream(stream: { [index: number]: number }, verts: number[]) {
      *   verts.forEach((value, key) => {
-     *     stream[key] = verts[key];
+     *     stream[key] = value;
      *   });
      * }
      *
      * export default defineScript({
      *   init() {
-     *     const res_path = go.get("#mesh", "vertices");
+     *     const res_path = go.get<mesh.properties>()("#mesh", "vertices");
      *
      *     const positions = [
      *       1, -1, 0,
@@ -1350,62 +1335,74 @@ declare global {
      * if graphics.TEXTURE_TYPE_3D ~= nil then
      * -- Device and graphics adapter support 3D textures
      * end
+     * ```
      * @example
+     * How to set all pixels of an atlas
      * ```ts
      * // How to set all pixels of an atlas
      * export default defineScript({
-     *   init(self) {
-     *     self.height = 128;
-     *     self.width = 128;
-     *     self.buffer = buffer.create(self.width * self.height, [{ name: hash("rgb"), type: buffer.VALUE_TYPE_UINT8, count: 3 }]);
-     *     self.stream = buffer.get_stream(self.buffer, hash("rgb"));
-     *
-     *     for (let y = 0; y < self.height; y++) {
-     *       for (let x = 0; x < self.width; x++) {
-     *         const index = y * self.width * 3 + x * 3;
-     *         self.stream[index + 0] = 0xff;
-     *         self.stream[index + 1] = 0x80;
-     *         self.stream[index + 2] = 0x10;
+     *   init() {
+     *     const height = 128;
+     *     const width = 128;
+     *     const buf = buffer.create(width * height, [{ name: hash("rgb"), type: buffer.VALUE_TYPE_UINT8, count: 3 }]);
+     *     const stream = buffer.get_stream(buf, hash("rgb"));
+     *
+     *     for (let y = 0; y < height; y++) {
+     *       for (let x = 0; x < width; x++) {
+     *         const index = y * width * 3 + x * 3;
+     *         stream[index + 0] = 0xff;
+     *         stream[index + 1] = 0x80;
+     *         stream[index + 2] = 0x10;
      *       }
      *     }
      *
-     *     const resource_path = go.get("#model", "texture0");
-     *     const args = { width: self.width, height: self.height, type: graphics.TEXTURE_TYPE_2D, format: graphics.TEXTURE_FORMAT_RGB, num_mip_maps: 1 };
-     *     resource.set_texture(resource_path, args, self.buffer);
+     *     const resource_path = go.get<model.properties>()("#model", "texture0");
+     *     const args = { width, height, type: graphics.TEXTURE_TYPE_2D, format: graphics.TEXTURE_FORMAT_RGB, num_mip_maps: 1 };
+     *     resource.set_texture(resource_path, args, buf);
+     *     return { buffer: buf, stream };
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to update a specific region of an atlas by using the x,y values. Assumes the already set atlas is a 128x128 texture.
+     * ```ts
      * // How to update a specific region of an atlas by using the x,y values. Assumes the already set atlas is a 128x128 texture.
      * export default defineScript({
-     *   init(self) {
-     *     self.x = 16;
-     *     self.y = 16;
-     *     self.height = 128 - self.x * 2;
-     *     self.width = 128 - self.y * 2;
-     *     self.buffer = buffer.create(self.width * self.height, [{ name: hash("rgb"), type: buffer.VALUE_TYPE_UINT8, count: 3 }]);
-     *     self.stream = buffer.get_stream(self.buffer, hash("rgb"));
-     *
-     *     for (let y = 0; y < self.height; y++) {
-     *       for (let x = 0; x < self.width; x++) {
-     *         const index = y * self.width * 3 + x * 3;
-     *         self.stream[index + 0] = 0xff;
-     *         self.stream[index + 1] = 0x80;
-     *         self.stream[index + 2] = 0x10;
+     *   init() {
+     *     const x = 16;
+     *     const y = 16;
+     *     const height = 128 - x * 2;
+     *     const width = 128 - y * 2;
+     *     const buf = buffer.create(width * height, [{ name: hash("rgb"), type: buffer.VALUE_TYPE_UINT8, count: 3 }]);
+     *     const stream = buffer.get_stream(buf, hash("rgb"));
+     *
+     *     for (let row = 0; row < height; row++) {
+     *       for (let col = 0; col < width; col++) {
+     *         const index = row * width * 3 + col * 3;
+     *         stream[index + 0] = 0xff;
+     *         stream[index + 1] = 0x80;
+     *         stream[index + 2] = 0x10;
      *       }
      *     }
      *
-     *     const resource_path = go.get("#model", "texture0");
-     *     const args = { width: self.width, height: self.height, x: self.x, y: self.y, type: graphics.TEXTURE_TYPE_2D, format: graphics.TEXTURE_FORMAT_RGB, num_mip_maps: 1 };
-     *     resource.set_texture(resource_path, args, self.buffer);
+     *     const resource_path = go.get<model.properties>()("#model", "texture0");
+     *     const args = { width, height, x, y, type: graphics.TEXTURE_TYPE_2D, format: graphics.TEXTURE_FORMAT_RGB, num_mip_maps: 1 };
+     *     resource.set_texture(resource_path, args, buf);
+     *     return { buffer: buf, stream };
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Update a texture from a buffer resource
+     * ```ts
      * // Update a texture from a buffer resource
-     * go.property("my_buffer", resource.buffer("/my_default_buffer.buffer"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_buffer: resource.buffer("/my_default_buffer.buffer") },
+     *
      *   init(self) {
-     *     const resource_path = go.get("#model", "texture0");
+     *     const resource_path = go.get<model.properties>()("#model", "texture0");
      *     // the "my_buffer" resource is expected to hold 128 * 128 * 3 bytes!
      *     const args = {
      *       width: 128,
@@ -1419,7 +1416,10 @@ declare global {
      *     resource.set_texture(resource_path, args, resource.get_buffer(self.my_buffer));
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Update an existing 3D texture from a lua buffer
+     * ```ts
      * // Update an existing 3D texture from a buffer
      * export default defineScript({
      *   init() {
@@ -1446,7 +1446,7 @@ declare global {
      *       width: 8,
      *       height: 8,
      *       depth: 8,
-     *       format: resource.TEXTURE_FORMAT_RGBA32F,
+     *       format: graphics.TEXTURE_FORMAT_RGBA32F,
      *     };
      *
      *     // This expects that the texture resource "/my_3d_texture.texturec" already exists
@@ -1455,24 +1455,37 @@ declare global {
      *     resource.set_texture("/my_3d_texture.texturec", t_args, tbuffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * ```ts
      * // Update texture 2nd array page with loaded texture from png
-     * // new_tex is resource handle of texture which was created via resource.create_resource
      * const tex_path = "/bundle_resources/page_02.png";
      * const [data] = sys.load_resource(tex_path);
-     * const buf = image.load_buffer(data);
-     * resource.set_texture(
-     *   new_tex,
-     *   {
-     *     type: graphics.TEXTURE_TYPE_2D_ARRAY,
-     *     width: buf.width,
-     *     height: buf.height,
-     *     page: 1,
-     *     format: graphics.TEXTURE_FORMAT_RGB,
-     *   },
-     *   buf.buffer,
-     * );
-     * go.set("#mesh", "texture0", new_tex);
+     * if (data !== undefined) {
+     *   const buf = image.load_buffer(data);
+     *   if (buf !== undefined) {
+     *     // new_tex is the resource handle of a texture created via resource.create_texture
+     *     const new_tex = resource.create_texture("/my_array_texture.texturec", {
+     *       type: graphics.TEXTURE_TYPE_2D_ARRAY,
+     *       width: buf.width,
+     *       height: buf.height,
+     *       page_count: 2,
+     *       format: graphics.TEXTURE_FORMAT_RGB,
+     *     });
+     *     resource.set_texture(
+     *       new_tex,
+     *       {
+     *         type: graphics.TEXTURE_TYPE_2D_ARRAY,
+     *         width: buf.width,
+     *         height: buf.height,
+     *         page: 1,
+     *         format: graphics.TEXTURE_FORMAT_RGB,
+     *       },
+     *       buf.buffer,
+     *     );
+     *     go.set("#mesh", "texture0", new_tex);
+     *   }
+     * }
      * ```
      */
     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;
@@ -1490,9 +1503,11 @@ declare global {
      * @example
      * ```ts
      * // Load a texture and set it to a model:
-     * go.property("my_texture", resource.texture("/texture.png"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_texture: resource.texture("/texture.png") },
+     *
      *   init(self) {
      *     go.set("#model", "texture0", self.my_texture);
      *   },
@@ -1514,9 +1529,11 @@ declare global {
      * @example
      * ```ts
      * // Load tile source and set it to a tile map:
-     * go.property("my_tile_source", resource.tile_source("/tilesource.tilesource"));
-     *
      * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_tile_source: resource.tile_source("/tilesource.tilesource") },
+     *
      *   init(self) {
      *     go.set("#tilemap", "tile_source", self.my_tile_source);
      *   },