@defold-typescript/library-types 0.22.0 → 0.24.0

package/api-doc/orthographic.json

@@ -0,0 +1,602 @@
+{
+  "info": {
+    "namespace": "orthographic",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_view",
+      "description": "Get the current view of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "view",
+          "doc": "The current view",
+          "types": [
+            "matrix"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_viewport",
+      "description": "Get the current viewport of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "x",
+          "doc": "The viewport left position",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "y",
+          "doc": "The viewport bottom position",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "w",
+          "doc": "The viewport width",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "h",
+          "doc": "The viewport height",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_projection",
+      "description": "Get the current projection of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "projection",
+          "doc": "The current projection",
+          "types": [
+            "matrix"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.shake",
+      "description": "Shake the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "",
+          "types": [
+            "hash",
+            "url"
+          ]
+        },
+        {
+          "name": "intensity",
+          "doc": "Intensity of the shake, in percent of screen. Defaults to 0.05",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "duration",
+          "doc": "Duration of the shake, in seconds. Defaults to 0.5",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "direction",
+          "doc": "Direction of the shake. Possible values: `both`, `horizontal`, `vertical`. Defaults to `both`.",
+          "types": [
+            "hash"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "cb",
+          "doc": "Function to call when the shake has finished. Optional.",
+          "types": [
+            "function"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.stop_shaking",
+      "description": "Stop shaking the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "",
+          "types": [
+            "hash",
+            "url"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.recoil",
+      "description": "Apply a recoil effect to the camera. The recoil will decay using linear interpolation.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "",
+          "types": [
+            "hash",
+            "url"
+          ]
+        },
+        {
+          "name": "offset",
+          "doc": "Offset to apply to the camera. Defaults to 0.05",
+          "types": [
+            "vector3"
+          ]
+        },
+        {
+          "name": "duration",
+          "doc": "Duration of the recoil, in seconds. Defaults to 0.5",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_offset",
+      "description": "Get the current offset of the camera (caused by shake or recoil)",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "offset",
+          "doc": "The current offset of the camera",
+          "types": [
+            "vector3"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_zoom",
+      "description": "Get the current zoom level of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "zoom",
+          "doc": "The current zoom of the camera",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.set_zoom",
+      "description": "Change the zoom level of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "zoom",
+          "doc": "The new zoom level of the camera",
+          "types": [
+            "number"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_automatic_zoom",
+      "description": "Get if the camera is configured to use automatic zoom level.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "auto_zoom",
+          "doc": "True if automatic zoom is enabled",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.set_automatic_zoom",
+      "description": "Set if the camera should use automatic zoom level.",
+      "parameters": [
+        {
+          "name": "enabled",
+          "doc": "True if automatic zoom should be enabled",
+          "types": [
+            "boolean"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.follow",
+      "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",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "targets",
+          "doc": "Game object(s) to follow",
+          "types": [
+            "hash",
+            "url",
+            "table"
+          ]
+        },
+        {
+          "name": "options",
+          "doc": "Options (see below)",
+          "types": [
+            "table"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.follow_offset",
+      "description": "Change the camera follow offset.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "offset",
+          "doc": "Camera offset from target position.",
+          "types": [
+            "vector3"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.unfollow",
+      "description": "Stop following a game object.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.deadzone",
+      "description": "If following a game object this will add a deadzone around the camera position where the camera position will not update. If the target moves to the edge of the deadzone the camera will start to follow until the target returns within the bounds of the deadzone.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "left",
+          "doc": "Number of pixels to the left of the camera",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "top",
+          "doc": "Number of pixels above the camera",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "right",
+          "doc": "Number of pixels to the right of the camera",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "bottom",
+          "doc": "Number of pixels below the camera",
+          "types": [
+            "number"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.bounds",
+      "description": "Limits the camera position to within the specified rectangle.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "left",
+          "doc": "Left edge of the camera bounds",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "top",
+          "doc": "Top edge of camera bounds",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "right",
+          "doc": "Right edge of camera bounds",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "bottom",
+          "doc": "Bottom edge of camera bounds",
+          "types": [
+            "number"
+          ]
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.screen_to_world",
+      "description": "Translate screen coordinates to world coordinates, based on the view and projection of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "screen",
+          "doc": "Screen coordinates to convert",
+          "types": [
+            "vector3"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "world_coords",
+          "doc": "World coordinates",
+          "types": [
+            "vector3"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.screen_to_world_bounds",
+      "description": "Translate screen boundaries (corners) to world coordinates, based on the view and projection of the camera.",
+      "parameters": [
+        {
+          "name": "camera_id",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "bounds",
+          "doc": "Screen bounds (x = left, y = top, z = right, w = bottom)",
+          "types": [
+            "vector4"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.world_to_screen",
+      "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",
+          "doc": "nil for the first camera",
+          "types": [
+            "hash",
+            "url",
+            "nil"
+          ]
+        },
+        {
+          "name": "world",
+          "doc": "World coordinates to convert",
+          "types": [
+            "vector3"
+          ]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "screen_coords",
+          "doc": "Screen coordinates",
+          "types": [
+            "vector3"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_window_size",
+      "description": "Get the current window size. The default values will be the ones specified in game.project.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "width",
+          "doc": "Current window width.",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "height",
+          "doc": "Current window height.",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "orthographic.get_display_size",
+      "description": "Get the display size, as specified in game.project.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "width",
+          "doc": "Display width.",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "height",
+          "doc": "Display height.",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    }
+  ]
+}