@defold-typescript/types 0.50.1 → 0.52.0

package/generated/buffer.d.ts

@@ -6,7 +6,7 @@ declare global {
    * Functions for manipulating buffers and streams
    */
   namespace buffer {
-    type buffer_data = Opaque<"buffer">;
+    type buffer_data = Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     type buffer_stream = Opaque<"bufferstream"> & { [index: number]: number; length: LuaLengthMethod<number> };
     type ValueType = typeof buffer.VALUE_TYPE_FLOAT32 | typeof buffer.VALUE_TYPE_INT16 | typeof buffer.VALUE_TYPE_INT32 | typeof buffer.VALUE_TYPE_INT64 | typeof buffer.VALUE_TYPE_INT8 | typeof buffer.VALUE_TYPE_UINT16 | typeof buffer.VALUE_TYPE_UINT32 | typeof buffer.VALUE_TYPE_UINT64 | typeof buffer.VALUE_TYPE_UINT8;
     type VALUE_TYPE = typeof buffer.VALUE_TYPE_FLOAT32 | typeof buffer.VALUE_TYPE_INT16 | typeof buffer.VALUE_TYPE_INT32 | typeof buffer.VALUE_TYPE_INT64 | typeof buffer.VALUE_TYPE_INT8 | typeof buffer.VALUE_TYPE_UINT16 | typeof buffer.VALUE_TYPE_UINT32 | typeof buffer.VALUE_TYPE_UINT64 | typeof buffer.VALUE_TYPE_UINT8;
@@ -71,7 +71,7 @@ declare global {
      * buffer.copy_buffer(dstbuffer, 0, srcbuffer, element_count - 10, 10);
      * ```
      */
-    function copy_buffer(dst: Opaque<"buffer">, dstoffset: number, src: Opaque<"buffer">, srcoffset: number, count: number): void;
+    function copy_buffer(dst: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, dstoffset: number, src: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, srcoffset: number, count: number): void;
     /**
      * Copy a specified amount of data from one stream to another.
      * The value type and size must match between source and destination streams.
@@ -132,15 +132,15 @@ declare global {
      * });
      * ```
      */
-    function create(element_count: number, declaration: ({ name: Hash | string; type: buffer.VALUE_TYPE; count: number })[]): Opaque<"buffer">;
+    function create(element_count: number, declaration: [({ name: Hash | string; type: buffer.VALUE_TYPE; count: number }), ...({ name: Hash | string; type: buffer.VALUE_TYPE; count: number })[]]): Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     /**
-     * Get a copy of all the bytes from a specified stream as a Lua string.
+     * Get a copy of all the bytes of the buffer, every stream included, as a Lua string.
      *
      * @param buffer - the source buffer
-     * @param stream_name - the name of the stream
+     * @param stream_name - the name of the stream; the engine ignores it and returns every byte of the buffer
      * @returns the buffer data as a Lua string
      */
-    function get_bytes(buffer: Opaque<"buffer">, stream_name: Hash | string): string;
+    function get_bytes(buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, stream_name?: Hash | string): string;
     /**
      * Get a named metadata entry from a buffer along with its type.
      *
@@ -156,7 +156,7 @@ declare global {
      * if (values) print(`${values.length} values in 'somefloats'`);
      * ```
      */
-    function get_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, buffer.VALUE_TYPE | undefined]>;
+    function get_metadata(buf: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, buffer.VALUE_TYPE | undefined]>;
     /**
      * Get a specified stream from a buffer.
      *
@@ -164,7 +164,7 @@ declare global {
      * @param stream_name - the stream name
      * @returns the data stream
      */
-    function get_stream(buffer: Opaque<"buffer">, stream_name: Hash | string): Opaque<"bufferstream"> & { [index: number]: number; length: LuaLengthMethod<number> };
+    function get_stream(buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, stream_name: Hash | string): Opaque<"bufferstream"> & { [index: number]: number; length: LuaLengthMethod<number> };
     /**
      * Creates or updates a metadata array entry on a buffer.
      * The value type and count given when updating the entry should match those used when first creating it.
@@ -185,7 +185,7 @@ declare global {
      * buffer.set_metadata(buf, hash("somefloats"), [-2.5, 10.0, 32.2], buffer.VALUE_TYPE_FLOAT32);
      * ```
      */
-    function set_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string, values: number[], value_type: buffer.VALUE_TYPE): void;
+    function set_metadata(buf: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, metadata_name: Hash | string, values: [number, ...number[]], value_type: Exclude<buffer.VALUE_TYPE, typeof buffer.VALUE_TYPE_INT64 | typeof buffer.VALUE_TYPE_UINT64>): void;
   }
 }
 

package/generated/builtin-messages.d.ts

@@ -9,10 +9,10 @@ declare global {
     apply_force: { force: Vector3; position: Vector3 };
     async_load: Record<string, never>;
     clear_color: { color: Vector4 };
-    collision_event: { a: Record<string | number, unknown>; b: Record<string | number, unknown> };
-    collision_response: { other_id: Hash; other_position: Vector3; other_group: Hash; own_group: Hash };
-    contact_point_event: { applied_impulse: number; distance: number; a: Record<string | number, unknown>; b: Record<string | number, unknown> };
-    contact_point_response: { position: Vector3; normal: Vector3; relative_velocity: Vector3; distance: number; applied_impulse: number; life_time: number; mass: number; other_mass: number; other_id: Hash; other_position: Vector3; other_group: Hash; own_group: Hash };
+    collision_event: { a: { position: Vector3; id: Hash; group: Hash }; b: { position: Vector3; id: Hash; group: Hash } };
+    collision_response: { other_id: Hash; other_position: Vector3; other_group: Hash; own_group: Hash; group: Hash };
+    contact_point_event: { applied_impulse: number; distance: number; a: { position: Vector3; instance_position: Vector3; normal: Vector3; relative_velocity: Vector3; mass: number; id: Hash; group: Hash }; b: { position: Vector3; instance_position: Vector3; normal: Vector3; relative_velocity: Vector3; mass: number; id: Hash; group: Hash } };
+    contact_point_response: { position: Vector3; normal: Vector3; relative_velocity: Vector3; distance: number; applied_impulse: number; life_time: number; mass: number; other_mass: number; other_id: Hash; other_position: Vector3; other_group: Hash; own_group: Hash; group: Hash };
     disable: Record<string, never>;
     draw_debug_text: { position: Vector3; text: string; color: Vector4 };
     draw_line: { start_point: Vector3; end_point: Vector3; color: Vector4 };
@@ -23,23 +23,25 @@ declare global {
     layout_changed: { id: Hash; previous_id: Hash };
     load: Record<string, never>;
     model_animation_done: { animation_id: Hash; playback: number };
-    play_animation: { id: Hash };
-    play_sound: { delay?: number; gain?: number; play_id?: number; start_time?: number; start_frame?: number };
+    pause_sound: { pause?: boolean };
+    play_animation: { id: Hash; offset?: number; playback_rate?: number };
+    play_sound: { delay?: number; gain?: number; play_id?: number; start_time?: number; start_frame?: number; pan?: number; speed?: number };
     proxy_error: { code: number };
     proxy_loaded: Record<string, never>;
     proxy_loading: { progress: number };
     proxy_ready: Record<string, never>;
     proxy_unloaded: Record<string, never>;
-    ray_cast_missed: { group: Hash; request_id: number };
+    ray_cast_missed: { request_id: number };
     ray_cast_response: { fraction: number; position: Vector3; normal: Vector3; id: Hash; group: Hash; request_id: number };
-    reboot: { arg1: string; arg2: string; arg3: string; arg4: string; arg5: string; arg6: string };
+    reboot: { arg1?: string; arg2?: string; arg3?: string; arg4?: string; arg5?: string; arg6?: string };
     /** @deprecated since 1.13.0 */
     release_camera_focus: Record<string, never>;
     release_input_focus: Record<string, never>;
     resize: { height: number; width: number };
     resume_rendering: Record<string, never>;
-    set_camera: { aspect_ratio: number; fov: number; near_z: number; far_z: number; orthographic_projection: number; orthographic_zoom: number; orthographic_mode: number };
-    set_gain: { gain: number };
+    set_camera: { aspect_ratio: number; fov: number; near_z: number; far_z: number; orthographic_projection?: number; orthographic_zoom?: number; orthographic_mode?: number };
+    set_gain: { gain?: number };
+    set_pan: { pan?: number };
     set_parent: { parent_id?: Hash; keep_world_transform?: 0 | 1 };
     set_time_step: { factor: number; mode: number };
     set_update_frequency: { frequency: number };
@@ -47,16 +49,16 @@ declare global {
     set_vsync: { swap_interval: number };
     sound_done: { play_id: number };
     sound_stopped: { play_id: number };
-    start_record: { file_name: string; frame_period: number; fps: number };
+    start_record: { file_name: string; frame_period?: number; fps?: number };
     stop_record: Record<string, never>;
-    stop_sound: Record<string, never>;
+    stop_sound: { play_id?: number };
     text_object_clicked: { id: Hash; type: Hash; src: string };
     text_object_hovered: { id: Hash; type: Hash; src: string };
     text_object_unhovered: { id: Hash; type: Hash; src: string };
     toggle_physics_debug: Record<string, never>;
     toggle_profile: Record<string, never>;
-    trigger_event: { enter: boolean; a: Record<string | number, unknown>; b: Record<string | number, unknown> };
-    trigger_response: { other_id: Hash; enter: boolean; other_group: Hash; own_group: Hash };
+    trigger_event: { enter: boolean; a: { id: Hash; group: Hash }; b: { id: Hash; group: Hash } };
+    trigger_response: { other_id: Hash; enter: boolean; other_group: Hash; own_group: Hash; group: Hash };
     unload: Record<string, never>;
     window_resized: { height: number; width: number };
   }

package/generated/bullet3d_collision_object.d.ts

@@ -298,7 +298,7 @@ declare global {
      * @param object - collision object
      * @returns rigid body state
      */
-    function is_rigid_body(object: Opaque<"btCollisionObject" | "btRigidBody">): boolean;
+    function is_rigid_body(object: Opaque<"btCollisionObject" | "btRigidBody">): object is Opaque<"btRigidBody">;
     /**
      * Test whether the object is static
      *

package/generated/bullet3d_constraint.d.ts

@@ -246,7 +246,16 @@ declare global {
      * @param params - local frames and options
      * @returns cone-twist constraint
      */
-    function create_cone_twist(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.cone_twist_params): bullet3d.constraint.btTypedConstraint;
+    function create_cone_twist(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.cone_twist_params & Required<Pick<bullet3d.constraint.cone_twist_params, "frame_b_position" | "frame_b_rotation">>): bullet3d.constraint.btTypedConstraint;
+    /**
+     * The world is derived from `body_a`.
+     *
+     * @param body_a - first body
+     * @param body_b - second body or world
+     * @param params - local frames and options
+     * @returns cone-twist constraint
+     */
+    function create_cone_twist(body_a: Opaque<"btRigidBody">, body_b: undefined, params: bullet3d.constraint.cone_twist_params): bullet3d.constraint.btTypedConstraint;
     /**
      * The params table requires local frame A and, for a two-body constraint,
      * local frame B. It optionally accepts `collide_connected`. The world is
@@ -259,7 +268,20 @@ declare global {
      * @param params - local frames and options
      * @returns generic 6-DOF constraint
      */
-    function create_generic_6dof(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.generic_6dof_params): bullet3d.constraint.btTypedConstraint;
+    function create_generic_6dof(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.generic_6dof_params & Required<Pick<bullet3d.constraint.generic_6dof_params, "frame_b_position" | "frame_b_rotation">>): bullet3d.constraint.btTypedConstraint;
+    /**
+     * The params table requires local frame A and, for a two-body constraint,
+     * local frame B. It optionally accepts `collide_connected`. The world is
+     * derived from `body_a`. The active 6-DOF solver ignores its legacy
+     * linear-reference-frame selector, so that field is rejected rather than
+     * silently accepted.
+     *
+     * @param body_a - first body
+     * @param body_b - second body or world
+     * @param params - local frames and options
+     * @returns generic 6-DOF constraint
+     */
+    function create_generic_6dof(body_a: Opaque<"btRigidBody">, body_b: undefined, params: bullet3d.constraint.generic_6dof_params): bullet3d.constraint.btTypedConstraint;
     /**
      * Both bodies and both local frames are required. The params table optionally
      * accepts `collide_connected`. The world is derived from `body_a`. The active
@@ -339,7 +361,44 @@ declare global {
      * });
      * ```
      */
-    function create_hinge(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.hinge_params): bullet3d.constraint.btTypedConstraint;
+    function create_hinge(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.hinge_params & Required<Pick<bullet3d.constraint.hinge_params, "frame_b_position" | "frame_b_rotation">>): bullet3d.constraint.btTypedConstraint;
+    /**
+     * The world is derived from `body_a`.
+     *
+     * @param body_a - first body
+     * @param body_b - second body or world
+     * @param params - local frames and options
+     * @returns hinge constraint
+     * @example
+     * ```ts
+     * // Create a motorized hinge with a 90-degree range:
+     * export default defineScript({
+     *   init() {
+     *     const body_a = bullet3d.get_rigid_body("/door#collisionobject");
+     *     const body_b = bullet3d.get_rigid_body("/frame#collisionobject");
+     *     let hinge: bullet3d.constraint.btTypedConstraint | undefined;
+     *     if (body_a !== undefined) {
+     *       hinge = bullet3d.constraint.create_hinge(body_a, body_b, {
+     *         frame_a_position: vmath.vector3(-0.5, 0, 0),
+     *         frame_a_rotation: vmath.quat(),
+     *         frame_b_position: vmath.vector3(0.5, 0, 0),
+     *         frame_b_rotation: vmath.quat(),
+     *       });
+     *       bullet3d.constraint.set_hinge_limits(hinge, -math.pi / 4, math.pi / 4);
+     *       bullet3d.constraint.set_hinge_motor(hinge, true, 1.5, 2.5);
+     *     }
+     *     return { hinge };
+     *   },
+     *
+     *   final(self) {
+     *     if (self.hinge !== undefined && bullet3d.constraint.is_valid(self.hinge)) {
+     *       bullet3d.constraint.destroy(self.hinge);
+     *     }
+     *   },
+     * });
+     * ```
+     */
+    function create_hinge(body_a: Opaque<"btRigidBody">, body_b: undefined, params: bullet3d.constraint.hinge_params): bullet3d.constraint.btTypedConstraint;
     /**
      * Both bodies are required. Its initial linear suspension travel is one Defold
      * unit in either direction. The world is derived from `body_a`.
@@ -383,7 +442,50 @@ declare global {
      * });
      * ```
      */
-    function create_point_to_point(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.point_to_point_params): bullet3d.constraint.btTypedConstraint;
+    function create_point_to_point(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.point_to_point_params & Required<Pick<bullet3d.constraint.point_to_point_params, "pivot_b">>): bullet3d.constraint.btTypedConstraint;
+    /**
+     * The world is derived from `body_a`; both bodies must belong to that same world.
+     *
+     * @param body_a - first body
+     * @param body_b - second body or world
+     * @param params - pivots and options
+     * @returns point-to-point constraint
+     * @example
+     * ```ts
+     * // Join two bodies at matching local pivots and explicitly destroy the
+     * // constraint when the script is finalized:
+     * export default defineScript({
+     *   init() {
+     *     const body_a = bullet3d.get_rigid_body("/body_a#collisionobject");
+     *     const body_b = bullet3d.get_rigid_body("/body_b#collisionobject");
+     *     let constraint: bullet3d.constraint.btTypedConstraint | undefined;
+     *     if (body_a !== undefined) {
+     *       constraint = bullet3d.constraint.create_point_to_point(body_a, body_b, {
+     *         pivot_a: vmath.vector3(0.5, 0, 0),
+     *         pivot_b: vmath.vector3(-0.5, 0, 0),
+     *       });
+     *     }
+     *     return { constraint };
+     *   },
+     *
+     *   final(self) {
+     *     if (self.constraint !== undefined && bullet3d.constraint.is_valid(self.constraint)) {
+     *       bullet3d.constraint.destroy(self.constraint);
+     *     }
+     *   },
+     * });
+     * ```
+     */
+    function create_point_to_point(body_a: Opaque<"btRigidBody">, body_b: undefined, params: bullet3d.constraint.point_to_point_params): bullet3d.constraint.btTypedConstraint;
+    /**
+     * The world is derived from `body_a`.
+     *
+     * @param body_a - first body
+     * @param body_b - second body or world
+     * @param params - local frames and options
+     * @returns slider constraint
+     */
+    function create_slider(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.slider_params & Required<Pick<bullet3d.constraint.slider_params, "frame_b_position" | "frame_b_rotation">>): bullet3d.constraint.btTypedConstraint;
     /**
      * The world is derived from `body_a`.
      *
@@ -392,7 +494,7 @@ declare global {
      * @param params - local frames and options
      * @returns slider constraint
      */
-    function create_slider(body_a: Opaque<"btRigidBody">, body_b: Opaque<"btRigidBody"> | undefined, params: bullet3d.constraint.slider_params): bullet3d.constraint.btTypedConstraint;
+    function create_slider(body_a: Opaque<"btRigidBody">, body_b: undefined, params: bullet3d.constraint.slider_params): bullet3d.constraint.btTypedConstraint;
     /**
      * Both bodies are required. The world is derived from `body_a`.
      *
@@ -567,7 +669,7 @@ declare global {
      * @param constraint - slider constraint
      * @param motor - `linear` or `angular`
      */
-    function get_slider_motor(constraint: bullet3d.constraint.btTypedConstraint, motor: string): LuaMultiReturn<[boolean, number, number]>;
+    function get_slider_motor(constraint: bullet3d.constraint.btTypedConstraint, motor: "linear" | "angular"): LuaMultiReturn<[boolean, number, number]>;
     /**
      * Get the current slider position
      *
@@ -781,7 +883,7 @@ declare global {
      * @param target_velocity - linear or angular target velocity
      * @param max_force - non-negative maximum linear force or angular torque
      */
-    function set_slider_motor(constraint: bullet3d.constraint.btTypedConstraint, motor: string, enabled: boolean, target_velocity: number, max_force: number): void;
+    function set_slider_motor(constraint: bullet3d.constraint.btTypedConstraint, motor: "linear" | "angular", enabled: boolean, target_velocity: number, max_force: number): void;
     /**
      * Generic spring 6-DOF constraints use a scale-independent damping factor from
      * 0 to 1, where 1 means no damping. Hinge2 constraints use a damping coefficient

package/generated/bullet3d_shape.d.ts

@@ -11,7 +11,7 @@ declare global {
    */
   namespace bullet3d.shape {
     type btCollisionShape = Opaque<"btCollisionShape">;
-    type definition = { type: bullet3d.shape.SHAPE_TYPE; diameter: number; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: bullet3d.shape.SHAPE_TYPE; dimensions: Vector3; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: bullet3d.shape.SHAPE_TYPE; diameter: number; height: number; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: bullet3d.shape.SHAPE_TYPE; vertices: Vector3[]; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion };
+    type definition = { type: typeof bullet3d.shape.SHAPE_TYPE_SPHERE; diameter: number; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: typeof bullet3d.shape.SHAPE_TYPE_BOX; dimensions: Vector3; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: typeof bullet3d.shape.SHAPE_TYPE_CAPSULE; diameter: number; height: number; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion } | { type: typeof bullet3d.shape.SHAPE_TYPE_HULL; vertices: Vector3[]; position?: Vector3; rotation?: Quaternion; target_rotation?: Quaternion };
     type SHAPE_TYPE = typeof bullet3d.shape.SHAPE_TYPE_BOX | typeof bullet3d.shape.SHAPE_TYPE_CAPSULE | typeof bullet3d.shape.SHAPE_TYPE_HULL | typeof bullet3d.shape.SHAPE_TYPE_MESH | typeof bullet3d.shape.SHAPE_TYPE_SPHERE;
     /**
      * Box shape type Value `1`. Shape data contains positive vector3 `dimensions` in Defold units.
@@ -66,7 +66,7 @@ declare global {
      * @param shape - shape handle
      * @returns typed shape geometry in Defold units
      */
-    function get_shape(shape: bullet3d.shape.btCollisionShape): bullet3d.shape.definition;
+    function get_shape(shape: bullet3d.shape.btCollisionShape): bullet3d.shape.definition | { type: typeof bullet3d.shape.SHAPE_TYPE_MESH };
     /**
      * Get the normalized Defold shape type.
      *

package/generated/collectionfactory.d.ts

@@ -86,7 +86,7 @@ declare global {
      * }
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<Hash, Record<string | number, unknown>> | Record<string, Record<string | number, unknown>>, scale?: number | Vector3): LuaTable<Hash, Hash>;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<Hash, Record<string | number, unknown>> | Record<string, Record<string | number, unknown>>, scale?: number | Vector3): LuaTable<Hash, Hash> & { get: LuaTableGetMethod<string, Hash> };
     /**
      * This returns status of the collection factory.
      * Calling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.

package/generated/collectionproxy.d.ts

@@ -78,7 +78,7 @@ declare global {
      * });
      * ```
      */
-    function load(url: string | Hash | Url, options: {} | undefined, callback: (self: unknown, message_id: Hash, message: Record<string | number, unknown>, sender: Url) => void): void;
+    function load(url: string | Hash | Url, options: {} | undefined, callback: (self: unknown, message_id: Hash, message: collectionproxy.load_data, sender: Url) => void): void;
     /**
      * The collection should be loaded by the collection proxy.
      * Setting the collection to "nil" will revert it back to the original collection.
@@ -102,7 +102,7 @@ declare global {
      * msg.post("/go#collectionproxy", "enable");
      * ```
      */
-    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, collectionproxy.RESULT]>;
+    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, collectionproxy.RESULT | undefined]>;
   }
 }
 

package/generated/factory.d.ts

@@ -43,7 +43,9 @@ declare global {
      *     // create a new game object and provide property values
      *     const created = factory.create("#factory", undefined, undefined, { my_value: 1 });
      *     // communicate with the object
-     *     msg.post(created, "hello");
+     *     if (created !== undefined) {
+     *       msg.post(created, "hello");
+     *     }
      *   },
      * });
      * ```
@@ -59,7 +61,7 @@ declare global {
      * });
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<string | Hash, unknown> | Record<string, unknown>, scale?: number | Vector3): Hash;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<string | Hash, unknown> | Record<string, unknown>, scale?: number | Vector3): Hash | undefined;
     /**
      * This returns status of the factory.
      * Calling this function when the factory is not marked as dynamic loading always returns