@defold-typescript/library-types 0.22.0 → 0.24.0

package/api-doc/orthographic.camera.json

@@ -8,8 +8,8 @@
     {
       "type": "FUNCTION",
       "name": "follow",
-      "brief": "Follow a game object.",
-      "description": "Follow a game object.",
+      "brief": "Follow one or more game objects. When following multiple objects the camera will follow the center point between the objects.",
+      "description": "Follow one or more game objects. When following multiple objects the camera will follow the center point between the objects.",
       "parameters": [
         {
           "name": "camera_id",
@@ -20,10 +20,10 @@
           "is_optional": "False"
         },
         {
-          "name": "target",
-          "doc": "Game object to follow",
+          "name": "targets",
+          "doc": "Game object(s) to follow",
           "types": [
-            "Hash | Url"
+            "Hash | Url | (Hash | Url)[]"
           ],
           "is_optional": "False"
         },
@@ -130,6 +130,56 @@
       ],
       "returnvalues": []
     },
+    {
+      "type": "FUNCTION",
+      "name": "get_automatic_zoom",
+      "brief": "Get if the camera is configured to use automatic zoom level.",
+      "description": "Get if the camera is configured to use automatic zoom level.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "undefined for the first camera",
+          "types": [
+            "Hash | Url | undefined"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "set_automatic_zoom",
+      "brief": "Set if the camera should use automatic zoom level.",
+      "description": "Set if the camera should use automatic zoom level.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "undefined for the first camera",
+          "types": [
+            "Hash | Url | undefined"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "enabled",
+          "doc": "True if automatic zoom should be enabled",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
     {
       "type": "FUNCTION",
       "name": "shake",
@@ -411,31 +461,6 @@
         }
       ]
     },
-    {
-      "type": "FUNCTION",
-      "name": "get_projection_id",
-      "brief": "Get the current projection id of the camera.",
-      "description": "Get the current projection id of the camera.",
-      "parameters": [
-        {
-          "name": "camera_id",
-          "doc": "undefined for the first camera",
-          "types": [
-            "Hash | Url | undefined"
-          ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": [
-        {
-          "name": "",
-          "doc": "",
-          "types": [
-            "Hash"
-          ]
-        }
-      ]
-    },
     {
       "type": "FUNCTION",
       "name": "recoil",
@@ -662,8 +687,8 @@
     {
       "type": "FUNCTION",
       "name": "world_to_screen",
-      "brief": "Translate world coordinates to screen coordinates, based on the view and projection of the camera, optionally taking into account an adjust mode. This is useful when manually culling game objects and you need to determine if a world coordinate will be visible or not. It can also be used to position gui nodes on top of game objects.",
-      "description": "Translate world coordinates to screen coordinates, based on the view and projection of the camera, optionally taking into account an adjust mode. This is useful when manually culling game objects and you need to determine if a world coordinate will be visible or not. It can also be used to position gui nodes on top of game objects.",
+      "brief": "Translate world coordinates to screen coordinates, based on the view and projection of the camera. This is useful when manually culling game objects and you need to determine if a world coordinate will be visible or not. It can also be used to position gui nodes on top of game objects.",
+      "description": "Translate world coordinates to screen coordinates, based on the view and projection of the camera. This is useful when manually culling game objects and you need to determine if a world coordinate will be visible or not. It can also be used to position gui nodes on top of game objects.",
       "parameters": [
         {
           "name": "camera_id",
@@ -680,14 +705,6 @@
             "Vector3"
           ],
           "is_optional": "False"
-        },
-        {
-          "name": "adjust_mode",
-          "doc": "One of gui.ADJUST_FIT, gui.ADJUST_ZOOM and gui.ADJUST_STRETCH, or undefined to not take into account the adjust mode.",
-          "types": [
-            "typeof gui.ADJUST_FIT | typeof gui.ADJUST_STRETCH | typeof gui.ADJUST_ZOOM"
-          ],
-          "is_optional": "True"
         }
       ],
       "returnvalues": [
@@ -782,56 +799,6 @@
         }
       ]
     },
-    {
-      "type": "FUNCTION",
-      "name": "add_projector",
-      "brief": "Add a custom projector that can be used by cameras in your project (see configuration above).",
-      "description": "Add a custom projector that can be used by cameras in your project (see configuration above).",
-      "parameters": [
-        {
-          "name": "projector_id",
-          "doc": "Id of the projector. Used as a value in the projection field of the camera script.",
-          "types": [
-            "Hash"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "projector_fn",
-          "doc": "The function to call when a projection matrix is needed for the camera. The function will receive the id, near_z and far_z values of the camera.",
-          "types": [
-            "(id: Hash, near_z: number, far_z: number) => void"
-          ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": []
-    },
-    {
-      "type": "FUNCTION",
-      "name": "use_projector",
-      "brief": "Set a specific projector for a camera. This must be either one of the predefined projectors (see above) or a custom projector added using `camera.add_projector()`.",
-      "description": "Set a specific projector for a camera. This must be either one of the predefined projectors (see above) or a custom projector added using `camera.add_projector()`.",
-      "parameters": [
-        {
-          "name": "camera_id",
-          "doc": "undefined for the first camera",
-          "types": [
-            "Hash | Url | undefined"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "projector_id",
-          "doc": "Id of the projector.",
-          "types": [
-            "Hash"
-          ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": []
-    },
     {
       "type": "FUNCTION",
       "name": "set_window_scaling_factor",
@@ -852,6 +819,8 @@
     {
       "type": "VARIABLE",
       "name": "PROJECTOR",
+      "brief": "",
+      "description": "",
       "types": [
         "{ FIXED_ZOOM: Hash; DEFAULT: Hash; FIXED_AUTO: Hash; }"
       ],
@@ -885,6 +854,8 @@
     {
       "type": "VARIABLE",
       "name": "SHAKE_BOTH",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -892,6 +863,8 @@
     {
       "type": "VARIABLE",
       "name": "SHAKE_VERTICAL",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -899,20 +872,17 @@
     {
       "type": "VARIABLE",
       "name": "SHAKE_HORIZONTAL",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
     },
-    {
-      "type": "VARIABLE",
-      "name": "ORTHOGRAPHIC_RENDER_SCRIPT_USED",
-      "types": [
-        "boolean"
-      ]
-    },
     {
       "type": "VARIABLE",
       "name": "MSG_DISABLE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -920,6 +890,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_UNFOLLOW",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -927,6 +899,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_FOLLOW",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -934,6 +908,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_FOLLOW_OFFSET",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -941,6 +917,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_RECOIL",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -948,6 +926,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_SHAKE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -955,6 +935,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_SHAKE_COMPLETED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -962,6 +944,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_STOP_SHAKING",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -969,6 +953,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_DEADZONE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -976,6 +962,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_BOUNDS",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -983,6 +971,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_UPDATE_CAMERA",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -990,13 +980,17 @@
     {
       "type": "VARIABLE",
       "name": "MSG_ZOOM_TO",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
     },
     {
       "type": "VARIABLE",
-      "name": "MSG_USE_PROJECTION",
+      "name": "MSG_SET_AUTOMATIC_ZOOM",
+      "brief": "Posted to a camera to turn automatic zoom on or off.",
+      "description": "Posted to a camera to turn automatic zoom on or off.",
       "types": [
         "Hash"
       ]
@@ -1004,6 +998,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_VIEWPORT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -1011,6 +1007,8 @@
     {
       "type": "VARIABLE",
       "name": "MSG_ENABLE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]