@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.14.0/font_doc.json

@@ -0,0 +1,230 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "font.set_style",
+      "brief": "sets a named rich-text render style on a font",
+      "description": "Named object styles are resolved by text layouts without reshaping text.\nA <code>link</code> tag uses <code>link</code> by default. Callers may select another named style,\nsuch as <code>link:hover</code> or <code>link:active</code>, in response to input.\nFont collections initially define these named styles. Each default contains\na normalized RGBA face color and no effects. Style RGB overrides the base\ntext color, while alpha uses the lower of the style and base text alpha.\nGradients override RGB and use the lower alpha in the same way. Inline colors\nand gradients take precedence over object styles, which take precedence over\nthe named base style. Nested color or gradient tags override enclosing RGB\nin inline markup and named style definitions. The default <code>link</code> style also\nuses a solid underline, which remains when hover or active colors are applied:\n<ul>\n<li><code>link</code>: <code>(0.10, 0.45, 0.90, 1.0)</code>, solid underline</li>\n<li><code>link:hover</code>: <code>(0.30, 0.65, 1.00, 1.0)</code></li>\n<li><code>link:active</code>: <code>(0.05, 0.30, 0.70, 1.0)</code></li>\n</ul>\nThe definition is an opening-only sequence of rich-text tags. Tags are\nimplicitly closed in reverse order. Calling this function replaces the\nnamed render properties and effects. Resource-defined decorations, such as\nthe default <code>link</code> underline, remain unchanged.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "fontc",
+          "doc": "The path to the <code>.fontc</code> resource.",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        },
+        {
+          "name": "name",
+          "doc": "Style name, for example <code>link:hover</code>.",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "style",
+          "doc": "Opening-only render-style markup.",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">font</span><span class=\"p\">.</span><span class=\"n\">set_style</span><span class=\"p\">(</span><span class=\"s2\">&quot;/fonts/ui.fontc&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;link:hover&quot;</span><span class=\"p\">,</span>\n    <span class=\"s2\">&quot;&lt;color=#66b3ff&gt;&lt;outline color=#000000 size=1&gt;&lt;shake amplitude=0.2&gt;&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "font.add_font",
+      "brief": "associates a TTF or OTF resource to a .fontc file.",
+      "description": "associates a TTF or OTF resource to a .fontc file.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "fontc",
+          "doc": "The path to the .fontc resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        },
+        {
+          "name": "font",
+          "doc": "The path to the .ttf or .otf resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">font_hash</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/fonts/roboto.fontc&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">ttf_hash</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/fonts/Roboto/Roboto-Bold.ttf&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">font</span><span class=\"p\">.</span><span class=\"n\">add_font</span><span class=\"p\">(</span><span class=\"n\">font_hash</span><span class=\"p\">,</span> <span class=\"n\">ttf_hash</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "The font is loaded via the resource system. There are a few ways it can be accessed:\n    - It was already loaded in the resource system\n    - It is bundled via our game data\n    - It is accessible via a live update mount",
+        "The reference count will increase for the .ttf or .otf font"
+      ],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "font.remove_font",
+      "brief": "associates a TTF or OTF resource to a .fontc file",
+      "description": "associates a TTF or OTF resource to a .fontc file",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "fontc",
+          "doc": "The path to the .fontc resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        },
+        {
+          "name": "font",
+          "doc": "The path to the .ttf or .otf resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">font_hash</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/fonts/roboto.fontc&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">ttf_hash</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/fonts/Roboto/Roboto-Bold.ttf&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">font</span><span class=\"p\">.</span><span class=\"n\">remove_font</span><span class=\"p\">(</span><span class=\"n\">font_hash</span><span class=\"p\">,</span> <span class=\"n\">ttf_hash</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": ["The reference count will decrease for the .ttf or .otf font"],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "font.prewarm_text",
+      "brief": "prepopulates the font glyph cache with rasterised ...",
+      "description": "prepopulates the font glyph cache with rasterised glyphs",
+      "returnvalues": [
+        {
+          "name": "request_id",
+          "doc": "Returns the asynchronous request id",
+          "types": ["integer"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "fontc",
+          "doc": "The path to the .fontc resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        },
+        {
+          "name": "text",
+          "doc": "The text to layout",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "callback",
+          "doc": "(optional) A callback function that is called after the request is finished\n<dl>\n<dt><code>self</code></dt>\n<dd><span class=\"type\">script_instance</span> The current script instance.</dd>\n<dt><code>request_id</code></dt>\n<dd><span class=\"type\">integer</span> The request id</dd>\n<dt><code>result</code></dt>\n<dd><span class=\"type\">boolean</span> True if request was succesful</dd>\n<dt><code>errstring</code></dt>\n<dd><span class=\"type\">string</span> <code>nil</code> if the request was successful</dd>\n</dl>",
+          "types": [
+            "fun(self:script_instance, request_id:integer, result:boolean, errstring?:string)"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">font_hash</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/fonts/roboto.fontc&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">font</span><span class=\"p\">.</span><span class=\"n\">prewarm_text</span><span class=\"p\">(</span><span class=\"n\">font_hash</span><span class=\"p\">,</span> <span class=\"s2\">&quot;Some text&quot;</span><span class=\"p\">,</span> <span class=\"kr\">function</span> <span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">request_id</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">,</span> <span class=\"n\">errstring</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- cache is warm, show the text!</span>\n    <span class=\"kr\">end</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "font.file_info",
+      "brief": "Associated font file information",
+      "description": "Associated font file information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "path",
+          "doc": "path to the <code>.ttf</code> or <code>.otf</code> font file",
+          "type": "string"
+        },
+        {
+          "name": "path_hash",
+          "doc": "hashed font-file path",
+          "type": "hash"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "font.info",
+      "brief": "Font resource information",
+      "description": "Font resource information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "path",
+          "doc": "path hash of the <code>.fontc</code> resource",
+          "type": "hash"
+        },
+        {
+          "name": "fonts",
+          "doc": "associated font files",
+          "type": "font.file_info[]"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "font.get_info",
+      "brief": "Gets information about a font, such as the associa...",
+      "description": "Gets information about a font, such as the associated font files",
+      "returnvalues": [
+        {
+          "name": "info",
+          "doc": "font resource information",
+          "types": ["font.info"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "fontc",
+          "doc": "The path to the .fontc resource",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "font",
+    "name": "Font",
+    "brief": "Font API documentation",
+    "description": "Functions, messages and properties used to manipulate font resources.",
+    "path": "engine/gamesys/src/gamesys/scripts/script_font.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.14.0/globals_doc.json

@@ -0,0 +1,64 @@
+{
+  "info": {
+    "namespace": "globals",
+    "version": "1.14.0",
+    "brief": "Prefixless global symbols available to every Defold script.",
+    "description": "The functions Defold exposes to every script without a namespace prefix. The global *types* (`Hash`, `Vector3`, ...) have their own reference pages. The Lua base globals (`print`, `pcall`, `pairs`, `assert`, ...) come from the `lua-types` dependency and are documented on the [base reference page](/api/base), not duplicated here."
+  },
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "hash",
+      "brief": "hash a string into a hash value",
+      "description": "Hashes a string into a hash value. The hash can be used to reference resources and identifiers in the Defold engine without carrying the original string around.",
+      "parameters": [
+        {
+          "name": "s",
+          "doc": "the string to hash, or a hash value, which is returned unchanged",
+          "types": ["string", "hash"]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "hash",
+          "doc": "the hash value",
+          "types": ["hash"]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "hash_to_hex",
+      "brief": "get hex representation of a hash value as a string",
+      "description": "Returns a hexadecimal representation of a hash value. The returned string is always padded with leading zeros.",
+      "parameters": [
+        {
+          "name": "h",
+          "doc": "hash value to get hex string for",
+          "types": ["hash"]
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "hex",
+          "doc": "hex representation of the hash",
+          "types": ["string"]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "pprint",
+      "brief": "pretty printing",
+      "description": "Pretty printing of Lua values. This function prints Lua values in a manner similar to +print()+, but will also recurse into tables and pretty print their contents.",
+      "parameters": [
+        {
+          "name": "...args",
+          "doc": "values to print",
+          "types": ["any"]
+        }
+      ],
+      "returnvalues": []
+    }
+  ]
+}

package/fixtures/defold-1.14.0/go-instance-functions.json

@@ -0,0 +1,106 @@
+{
+  "b2d.get_body": ["CheckGOInstance"],
+  "b2d.get_world": ["CheckGOInstance"],
+  "bullet3d.get_collision_object": ["CheckGOInstance"],
+  "bullet3d.get_rigid_body": ["CheckGOInstance"],
+  "bullet3d.get_world": ["CheckGOInstance"],
+  "collectionfactory.create": ["CheckGOInstance"],
+  "collectionfactory.get_status": ["CheckGOInstance"],
+  "collectionfactory.load": ["CheckGOInstance"],
+  "collectionfactory.set_prototype": ["CheckGOInstance"],
+  "collectionfactory.unload": ["CheckGOInstance"],
+  "collectionproxy.get_resources": ["CheckGOInstance"],
+  "collectionproxy.load": ["CheckGOInstance"],
+  "collectionproxy.set_collection": ["CheckGOInstance"],
+  "factory.create": ["CheckGOInstance"],
+  "factory.get_status": ["CheckGOInstance"],
+  "factory.load": ["CheckGOInstance"],
+  "factory.set_prototype": ["CheckGOInstance"],
+  "factory.unload": ["CheckGOInstance"],
+  "go.animate": ["ScriptInstance_Check"],
+  "go.cancel_animations": ["ScriptInstance_Check"],
+  "go.delete": ["ScriptInstance_Check"],
+  "go.exists": ["ScriptInstance_Check"],
+  "go.get": ["ScriptInstance_Check"],
+  "go.get_id": ["ScriptInstance_Check"],
+  "go.get_parent": ["ScriptInstance_Check"],
+  "go.get_position": ["ScriptInstance_Check"],
+  "go.get_rotation": ["ScriptInstance_Check"],
+  "go.get_scale": ["ScriptInstance_Check"],
+  "go.get_scale_uniform": ["ScriptInstance_Check"],
+  "go.get_world_position": ["ScriptInstance_Check"],
+  "go.get_world_rotation": ["ScriptInstance_Check"],
+  "go.get_world_scale": ["ScriptInstance_Check"],
+  "go.get_world_scale_uniform": ["ScriptInstance_Check"],
+  "go.get_world_transform": ["ScriptInstance_Check"],
+  "go.set": ["ScriptInstance_Check"],
+  "go.set_parent": ["ScriptInstance_Check"],
+  "go.set_position": ["ScriptInstance_Check"],
+  "go.set_rotation": ["ScriptInstance_Check"],
+  "go.set_scale": ["ScriptInstance_Check"],
+  "go.set_scale_xy": ["ScriptInstance_Check"],
+  "go.update_world_transform": ["ScriptInstance_Check"],
+  "go.world_to_local_position": ["ScriptInstance_Check"],
+  "go.world_to_local_transform": ["ScriptInstance_Check"],
+  "label.get_layout_objects": ["CheckGOInstance"],
+  "label.get_text": ["CheckGOInstance"],
+  "label.set_text": ["CheckGOInstance"],
+  "model.cancel": ["CheckGOInstance"],
+  "model.get_aabb": ["CheckGOInstance"],
+  "model.get_blend_weights": ["CheckGOInstance"],
+  "model.get_go": ["CheckGOInstance"],
+  "model.get_mesh_aabb": ["CheckGOInstance"],
+  "model.get_mesh_enabled": ["CheckGOInstance"],
+  "model.play_anim": ["CheckGOInstance"],
+  "model.reset_constant": ["CheckGOInstance"],
+  "model.set_blend_weights": ["CheckGOInstance"],
+  "model.set_mesh_enabled": ["CheckGOInstance"],
+  "particlefx.play": ["CheckGOInstance"],
+  "particlefx.reset_constant": ["CheckGOInstance"],
+  "particlefx.set_constant": ["CheckGOInstance"],
+  "particlefx.stop": ["CheckGOInstance"],
+  "physics.create_joint": ["CheckGOInstance"],
+  "physics.destroy_joint": ["CheckGOInstance"],
+  "physics.get_gravity": ["CheckGOInstance"],
+  "physics.get_group": ["CheckGOInstance"],
+  "physics.get_joint_properties": ["CheckGOInstance"],
+  "physics.get_joint_reaction_force": ["CheckGOInstance"],
+  "physics.get_joint_reaction_torque": ["CheckGOInstance"],
+  "physics.get_maskbit": ["CheckGOInstance"],
+  "physics.get_shape": ["CheckGOInstance"],
+  "physics.raycast": ["CheckGOInstance"],
+  "physics.raycast_async": ["CheckGOInstance"],
+  "physics.set_event_listener": ["CheckGOInstance"],
+  "physics.set_gravity": ["CheckGOInstance"],
+  "physics.set_group": ["CheckGOInstance"],
+  "physics.set_hflip": ["CheckGOInstance"],
+  "physics.set_joint_properties": ["CheckGOInstance"],
+  "physics.set_maskbit": ["CheckGOInstance"],
+  "physics.set_shape": ["CheckGOInstance"],
+  "physics.set_vflip": ["CheckGOInstance"],
+  "physics.update_mass": ["CheckGOInstance"],
+  "physics.wakeup": ["CheckGOInstance"],
+  "resource.create_atlas": ["CheckGOInstance"],
+  "resource.create_buffer": ["CheckGOInstance"],
+  "resource.create_sound_data": ["CheckGOInstance"],
+  "resource.create_texture": ["CheckGOInstance"],
+  "resource.create_texture_async": ["CheckGOInstance"],
+  "resource.release": ["CheckGOInstance"],
+  "sound.pause": ["CheckGOInstance"],
+  "sound.play": ["CheckGOInstance"],
+  "sound.set_gain": ["CheckGOInstance"],
+  "sound.set_pan": ["CheckGOInstance"],
+  "sound.stop": ["CheckGOInstance"],
+  "sprite.play_flipbook": ["CheckGOInstance"],
+  "sprite.reset_constant": ["CheckGOInstance"],
+  "sprite.set_hflip": ["CheckGOInstance"],
+  "sprite.set_scale": ["CheckGOInstance"],
+  "sprite.set_vflip": ["CheckGOInstance"],
+  "tilemap.get_bounds": ["CheckGOInstance"],
+  "tilemap.get_tile": ["CheckGOInstance"],
+  "tilemap.get_tile_info": ["CheckGOInstance"],
+  "tilemap.get_tiles": ["CheckGOInstance"],
+  "tilemap.reset_constant": ["CheckGOInstance"],
+  "tilemap.set_tile": ["CheckGOInstance"],
+  "tilemap.set_visible": ["CheckGOInstance"]
+}