@defold-typescript/types 0.53.0 → 0.54.0

package/fixtures/defold-1.13.1/collectionfactory_doc.json

@@ -0,0 +1,219 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "collectionfactory.get_status",
+      "brief": "Get collection factory status",
+      "description": "This returns status of the collection factory.\nCalling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.",
+      "returnvalues": [
+        {
+          "name": "status",
+          "doc": "status of the collection factory component\n<ul>\n<li><code>collectionfactory.STATUS_UNLOADED</code></li>\n<li><code>collectionfactory.STATUS_LOADING</code></li>\n<li><code>collectionfactory.STATUS_LOADED</code></li>\n</ul>",
+          "types": ["constant"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection factory component to get status from",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionfactory.STATUS_UNLOADED",
+      "brief": "unloaded",
+      "description": "unloaded",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionfactory.STATUS_LOADING",
+      "brief": "loading",
+      "description": "loading",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionfactory.STATUS_LOADED",
+      "brief": "loaded",
+      "description": "loaded",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "collectionfactory.unload",
+      "brief": "Unload resources previously loaded using collectionfactory.load",
+      "description": "This decreases the reference count for each resource loaded with collectionfactory.load. If reference is zero, the resource is destroyed.\nCalling this function when the factory is not marked as dynamic loading does nothing.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection factory component to unload",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to unload resources of a collection factory prototype loaded with collectionfactory.load\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">unload</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "collectionfactory.load",
+      "brief": "Load resources of a collection factory prototype.",
+      "description": "Resources loaded are referenced by the collection factory component until the existing (parent) collection is destroyed or collectionfactory.unload is called.\nCalling this function when the factory is not marked as dynamic loading does nothing.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection factory component to load",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        },
+        {
+          "name": "complete_function",
+          "doc": "function to call when resources are loaded.\n<dl>\n<dt><code>self</code></dt>\n<dd><span class=\"type\">object</span> The current object.</dd>\n<dt><code>url</code></dt>\n<dd><span class=\"type\">url</span> url of the collection factory component</dd>\n<dt><code>result</code></dt>\n<dd><span class=\"type\">boolean</span> True if resource were loaded successfully</dd>\n</dl>",
+          "types": ["function(self, url, result)"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to load resources of a collection factory prototype.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">load</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&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\">url</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span> <span class=\"kr\">end</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "collectionfactory.create",
+      "brief": "Spawn a new instance of a collection into the existing collection.",
+      "description": "The URL identifies the collectionfactory component that should do the spawning.\nSpawning is instant, but spawned game objects get their first update calls the following frame. The supplied parameters for position, rotation and scale\nwill be applied to the whole collection when spawned.\nScript properties in the created game objects can be overridden through\na properties-parameter table. The table should contain game object ids\n(hash) as keys and property tables as values to be used when initiating each\nspawned game object.\nSee go.property for more information on script properties.\nThe function returns a table that contains a key for each game object\nid (hash), as addressed if the collection file was top level, and the\ncorresponding spawned instance id (hash) as value with a unique path\nprefix added to each instance.\n<span class=\"icon-attention\"></span> Calling <a href=\"/ref/collectionfactory#collectionfactory.create\">collectionfactory.create</a> create on a collection factory that is marked as dynamic without having loaded resources\nusing <a href=\"/ref/collectionfactory#collectionfactory.load\">collectionfactory.load</a> will synchronously load and create resources which may affect application performance.",
+      "returnvalues": [
+        {
+          "name": "ids",
+          "doc": "a table mapping the id:s from the collection to the new instance id:s",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection factory component to be used",
+          "types": ["string", "hash", "url"],
+          "is_optional": "False"
+        },
+        {
+          "name": "position",
+          "doc": "position to assign to the newly spawned collection",
+          "types": ["vector3"],
+          "is_optional": "True"
+        },
+        {
+          "name": "rotation",
+          "doc": "rotation to assign to the newly spawned collection",
+          "types": ["quaternion"],
+          "is_optional": "True"
+        },
+        {
+          "name": "properties",
+          "doc": "table of script properties to propagate to any new game object instances",
+          "types": ["table"],
+          "is_optional": "True"
+        },
+        {
+          "name": "scale",
+          "doc": "uniform scaling to apply to the newly spawned collection (must be greater than 0).",
+          "types": ["number", "vector3"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to spawn a collection of game objects:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n  <span class=\"c1\">-- Spawn a small group of enemies.</span>\n  <span class=\"kd\">local</span> <span class=\"n\">pos</span> <span class=\"o\">=</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">vector3</span><span class=\"p\">(</span><span class=\"mi\">100</span><span class=\"p\">,</span> <span class=\"mf\">12.5</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">)</span>\n  <span class=\"kd\">local</span> <span class=\"n\">rot</span> <span class=\"o\">=</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">quat_rotation_z</span><span class=\"p\">(</span><span class=\"nb\">math.pi</span> <span class=\"o\">/</span> <span class=\"mi\">2</span><span class=\"p\">)</span>\n  <span class=\"kd\">local</span> <span class=\"n\">scale</span> <span class=\"o\">=</span> <span class=\"mf\">0.5</span>\n  <span class=\"kd\">local</span> <span class=\"n\">props</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n  <span class=\"n\">props</span><span class=\"p\">[</span><span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/enemy_leader&quot;</span><span class=\"p\">)]</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">health</span> <span class=\"o\">=</span> <span class=\"mf\">1000.0</span> <span class=\"p\">}</span>\n  <span class=\"n\">props</span><span class=\"p\">[</span><span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/enemy_1&quot;</span><span class=\"p\">)]</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">health</span> <span class=\"o\">=</span> <span class=\"mf\">200.0</span> <span class=\"p\">}</span>\n  <span class=\"n\">props</span><span class=\"p\">[</span><span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/enemy_2&quot;</span><span class=\"p\">)]</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">health</span> <span class=\"o\">=</span> <span class=\"mf\">400.0</span><span class=\"p\">,</span> <span class=\"n\">color</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;green&quot;</span><span class=\"p\">)</span> <span class=\"p\">}</span>\n\n  <span class=\"kd\">local</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">enemy_ids</span> <span class=\"o\">=</span> <span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">create</span><span class=\"p\">(</span><span class=\"s2\">&quot;#enemyfactory&quot;</span><span class=\"p\">,</span> <span class=\"n\">pos</span><span class=\"p\">,</span> <span class=\"n\">rot</span><span class=\"p\">,</span> <span class=\"n\">props</span><span class=\"p\">,</span> <span class=\"n\">scale</span><span class=\"p\">)</span>\n  <span class=\"c1\">-- enemy_ids now map to the spawned instance ids:</span>\n  <span class=\"c1\">--</span>\n  <span class=\"c1\">-- pprint(self.enemy_ids)</span>\n  <span class=\"c1\">--</span>\n  <span class=\"c1\">-- DEBUG:SCRIPT:</span>\n  <span class=\"c1\">-- {</span>\n  <span class=\"c1\">--   hash: [/enemy_leader] = hash: [/collection0/enemy_leader],</span>\n  <span class=\"c1\">--   hash: [/enemy_1] = hash: [/collection0/enemy_1],</span>\n  <span class=\"c1\">--   hash: [/enemy_2] = hash: [/collection0/enemy_2]</span>\n  <span class=\"c1\">-- }</span>\n\n  <span class=\"c1\">-- Send &quot;attack&quot; message to the leader. First look up its instance id.</span>\n  <span class=\"kd\">local</span> <span class=\"n\">leader_id</span> <span class=\"o\">=</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">enemy_ids</span><span class=\"p\">[</span><span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;/enemy_leader&quot;</span><span class=\"p\">)]</span>\n  <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">leader_id</span><span class=\"p\">,</span> <span class=\"s2\">&quot;attack&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nHow to delete a spawned collection:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">delete</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">enemy_ids</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "collectionfactory.set_prototype",
+      "brief": "changes the prototype for the collection factory",
+      "description": "Changes the prototype for the collection factory.\nSetting the prototype to \"nil\" will revert back to the original prototype.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection factory component",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        },
+        {
+          "name": "prototype",
+          "doc": "the path to the new prototype, or <code>nil</code>",
+          "types": ["string", "nil"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to unload the previous prototypes resources, and then spawn a new collection\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">unload</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">)</span> <span class=\"c1\">-- unload the previous resources</span>\n<span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">set_prototype</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;/main/levels/level1.collectionc&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">ids</span> <span class=\"o\">=</span> <span class=\"n\">collectionfactory</span><span class=\"p\">.</span><span class=\"n\">create</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">get_world_position</span><span class=\"p\">(),</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">quat</span><span class=\"p\">())</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "- Requires the factory to have the \"Dynamic Prototype\" set\n  - Cannot be set when the state is COMP_FACTORY_STATUS_LOADING\n  - Setting the prototype to \"nil\" will revert back to the original prototype."
+      ],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "collectionfactory",
+    "name": "Collection factory",
+    "brief": "Collection factory API documentation",
+    "description": "Functions for controlling collection factory components which are\nused to dynamically spawn collections into the runtime.",
+    "path": "engine/gamesys/src/gamesys/scripts/script_collection_factory.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}