@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.12.4/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"
+  }
+}

package/fixtures/defold-1.12.4/collectionproxy_doc.json

@@ -0,0 +1,289 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "collectionproxy.set_collection",
+      "brief": "changes the collection for a collection proxy.",
+      "description": "The collection should be loaded by the collection proxy.\nSetting the collection to \"nil\" will revert it back to the original collection.\nThe collection proxy shouldn't be loaded and should have the 'Exclude' checkbox checked.\nThis functionality is designed to simplify the management of Live Update resources.",
+      "returnvalues": [
+        {
+          "name": "success",
+          "doc": "collection change was successful",
+          "types": ["boolean"]
+        },
+        {
+          "name": "code",
+          "doc": "one of the collectionproxy.RESULT_* codes if unsuccessful",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the collection proxy component",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        },
+        {
+          "name": "prototype",
+          "doc": "the path to the new collection, or <code>nil</code>",
+          "types": ["string", "nil"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "The example assume the script belongs to an instance with collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">ok</span><span class=\"p\">,</span> <span class=\"nb\">error</span> <span class=\"o\">=</span> <span class=\"n\">collectionproxy</span><span class=\"p\">.</span><span class=\"n\">set_collection</span><span class=\"p\">(</span><span class=\"s2\">&quot;/go#collectionproxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;/LU/3.collectionc&quot;</span><span class=\"p\">)</span>\n <span class=\"kr\">if</span> <span class=\"n\">ok</span> <span class=\"kr\">then</span>\n     <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"s2\">&quot;The collection has been changed to /LU/3.collectionc&quot;</span><span class=\"p\">)</span>\n <span class=\"kr\">else</span>\n     <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"s2\">&quot;Error changing collection to /LU/3.collectionc &quot;</span><span class=\"p\">,</span> <span class=\"nb\">error</span><span class=\"p\">)</span>\n <span class=\"kr\">end</span>\n <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;/go#collectionproxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;load&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=\"s2\">&quot;/go#collectionproxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;init&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=\"s2\">&quot;/go#collectionproxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;enable&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionproxy.RESULT_LOADING",
+      "brief": "collection proxy is loading now",
+      "description": "It's impossible to change the collection while the collection proxy is loading.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionproxy.RESULT_ALREADY_LOADED",
+      "brief": "collection proxy is already loaded",
+      "description": "It's impossible to change the collection if the collection is already loaded.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "collectionproxy.RESULT_NOT_EXCLUDED",
+      "brief": "collection proxy isn't excluded",
+      "description": "It's impossible to change the collection for a proxy that isn't excluded.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "set_time_step",
+      "brief": "sets the time-step for update",
+      "description": "Post this message to a collection-proxy-component to modify the time-step used when updating the collection controlled by the proxy.\nThe time-step is modified by a scaling <code>factor</code> and can be incremented either continuously or in discrete steps.\nThe continuous mode can be used for slow-motion or fast-forward effects.\nThe discrete mode is only useful when scaling the time-step to pass slower than real time (<code>factor</code> is below 1).\nThe time-step will then be set to 0 for as many frames as the scaling demands and then take on the full real-time-step for one frame,\nto simulate pulses. E.g. if <code>factor</code> is set to <code>0.1</code> the time-step would be 0 for 9 frames, then be 1/60 for one\nframe, 0 for 9 frames, and so on. The result in practice is that the game looks like it's updated at a much lower frequency than 60 Hz,\nwhich can be useful for debugging when each frame needs to be inspected.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "factor",
+          "doc": "time-step scaling factor",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "mode",
+          "doc": "time-step mode: 0 for continuous and 1 for discrete",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "The examples assumes the script belongs to an instance with a collection-proxy-component with id \"proxy\".\nUpdate the collection twice as fast:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;set_time_step&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">factor</span> <span class=\"o\">=</span> <span class=\"mi\">2</span><span class=\"p\">,</span> <span class=\"n\">mode</span> <span class=\"o\">=</span> <span class=\"mi\">0</span><span class=\"p\">})</span>\n</code></pre></div>\n\nUpdate the collection twice as slow:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;set_time_step&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">factor</span> <span class=\"o\">=</span> <span class=\"mf\">0.5</span><span class=\"p\">,</span> <span class=\"n\">mode</span> <span class=\"o\">=</span> <span class=\"mi\">0</span><span class=\"p\">})</span>\n</code></pre></div>\n\nSimulate 1 FPS for the collection:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;set_time_step&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">factor</span> <span class=\"o\">=</span> <span class=\"mi\">1</span><span class=\"o\">/</span><span class=\"mi\">60</span><span class=\"p\">,</span> <span class=\"n\">mode</span> <span class=\"o\">=</span> <span class=\"mi\">1</span><span class=\"p\">})</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "load",
+      "brief": "tells a collection proxy to start loading the referenced collection",
+      "description": "Post this message to a collection-proxy-component to start the loading of the referenced collection.\nWhen the loading has completed, the message <a href=\"#proxy_loaded\">proxy_loaded</a> will be sent back to the script.\nA loaded collection must be initialized (message <a href=\"#init\">init</a>) and enabled (message <a href=\"#enable\">enable</a>) in order to be simulated and drawn.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assume the script belongs to an instance with collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;start_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- some script tells us to start loading the level</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;load&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_loaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- enable the collection and let the loader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">sender</span><span class=\"p\">,</span> <span class=\"s2\">&quot;enable&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\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "async_load",
+      "brief": "tells a collection proxy to start asynchronous loading of the referenced collection",
+      "description": "Post this message to a collection-proxy-component to start background loading of the referenced collection.\nWhen the loading has completed, the message <a href=\"#proxy_loaded\">proxy_loaded</a> will be sent back to the script.\nA loaded collection must be initialized (message <a href=\"#init\">init</a>) and enabled (message <a href=\"#enable\">enable</a>) in order to be simulated and drawn.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assume the script belongs to an instance with collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;start_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- some script tells us to start loading the level</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;async_load&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_loaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- enable the collection and let the loader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">sender</span><span class=\"p\">,</span> <span class=\"s2\">&quot;enable&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\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "proxy_loaded",
+      "brief": "reports that a collection proxy has loaded its referenced collection",
+      "description": "This message is sent back to the script that initiated a collection proxy load when the referenced\ncollection is loaded. See documentation for <a href=\"#load\">load</a> for examples how to use.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "init",
+      "brief": "tells a collection proxy to initialize the loaded collection",
+      "description": "Post this message to a collection-proxy-component to initialize the game objects and components in the referenced collection.\nSending <a href=\"#enable\">enable</a> to an uninitialized collection proxy automatically initializes it.\nThe <a href=\"#init\">init</a> message simply provides a higher level of control.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assume the script belongs to an instance with collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;load_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- some script tells us to start loading the level</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;load&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_loaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- only initialize the proxy at this point since we want to enable it at a later time for some reason</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">sender</span><span class=\"p\">,</span> <span class=\"s2\">&quot;init&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- let loader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "enable",
+      "brief": "tells a collection proxy to enable the referenced collection",
+      "description": "Post this message to a collection-proxy-component to enable the referenced collection, which in turn enables the contained game objects and components.\nIf the referenced collection was not initialized prior to this call, it will automatically be initialized.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assume the script belongs to an instance with collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;start_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- some script tells us to start loading the level</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;load&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_loaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- enable the collection and let the loader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">sender</span><span class=\"p\">,</span> <span class=\"s2\">&quot;enable&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\">self</span><span class=\"p\">.</span><span class=\"n\">loader</span><span class=\"p\">,</span> <span class=\"s2\">&quot;level_started&quot;</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "disable",
+      "brief": "tells a collection proxy to disable the referenced collection",
+      "description": "Post this message to a collection-proxy-component to disable the referenced collection, which in turn disables the contained game objects and components.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assumes the script belongs to an instance with a collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;end_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"kd\">local</span> <span class=\"n\">proxy</span> <span class=\"o\">=</span> <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">url</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;disable&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;final&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;unload&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_unloaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- let unloader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span><span class=\"p\">,</span> <span class=\"s2\">&quot;level_ended&quot;</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "final",
+      "brief": "tells a collection proxy to finalize the referenced collection",
+      "description": "Post this message to a collection-proxy-component to finalize the referenced collection, which in turn finalizes the contained game objects and components.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assumes the script belongs to an instance with a collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;end_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"kd\">local</span> <span class=\"n\">proxy</span> <span class=\"o\">=</span> <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">url</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;disable&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;final&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;unload&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_unloaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- let unloader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span><span class=\"p\">,</span> <span class=\"s2\">&quot;level_ended&quot;</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "unload",
+      "brief": "tells a collection proxy to start unloading the referenced collection",
+      "description": "Post this message to a collection-proxy-component to start the unloading of the referenced collection.\nWhen the unloading has completed, the message <a href=\"#proxy_unloaded\">proxy_unloaded</a> will be sent back to the script.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "In this example we use a collection proxy to load/unload a level (collection).\nThe example assumes the script belongs to an instance with a collection-proxy-component with id \"proxy\".\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;end_level&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"kd\">local</span> <span class=\"n\">proxy</span> <span class=\"o\">=</span> <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">url</span><span class=\"p\">(</span><span class=\"s2\">&quot;#proxy&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;disable&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;final&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\">proxy</span><span class=\"p\">,</span> <span class=\"s2\">&quot;unload&quot;</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- store sender for later notification</span>\n        <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span> <span class=\"o\">=</span> <span class=\"n\">sender</span>\n    <span class=\"kr\">elseif</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;proxy_unloaded&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"c1\">-- let unloader know</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">unloader</span><span class=\"p\">,</span> <span class=\"s2\">&quot;level_ended&quot;</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "proxy_unloaded",
+      "brief": "reports that a collection proxy has unloaded its referenced collection",
+      "description": "This message is sent back to the script that initiated an unload with a collection proxy when\nthe referenced collection is unloaded. See documentation for <a href=\"#unload\">unload</a> for examples how to use.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "collectionproxy.get_resources",
+      "brief": "return an indexed table of all the resources of a collection proxy",
+      "description": "return an indexed table of resources for a collection proxy where the\nreferenced collection has been excluded using LiveUpdate. Each entry is a\nhexadecimal string that represents the data of the specific resource.\nThis representation corresponds with the filename for each individual\nresource that is exported when you bundle an application with LiveUpdate\nfunctionality.",
+      "returnvalues": [
+        {
+          "name": "resources",
+          "doc": "the resources, or an empty list if the\ncollection was not excluded.",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "collectionproxy",
+          "doc": "the collectionproxy to check for resources.",
+          "types": ["url"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"kr\">function</span> <span class=\"nf\">print_resources</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">cproxy</span><span class=\"p\">)</span>\n    <span class=\"kd\">local</span> <span class=\"n\">resources</span> <span class=\"o\">=</span> <span class=\"n\">collectionproxy</span><span class=\"p\">.</span><span class=\"n\">get_resources</span><span class=\"p\">(</span><span class=\"n\">cproxy</span><span class=\"p\">)</span>\n    <span class=\"kr\">for</span> <span class=\"n\">_</span><span class=\"p\">,</span> <span class=\"n\">v</span> <span class=\"kr\">in</span> <span class=\"nb\">ipairs</span><span class=\"p\">(</span><span class=\"n\">resources</span><span class=\"p\">)</span> <span class=\"kr\">do</span>\n        <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"s2\">&quot;Resource: &quot;</span> <span class=\"o\">..</span> <span class=\"n\">v</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "collectionproxy",
+    "name": "Collection proxy",
+    "brief": "Collection proxy API documentation",
+    "description": "Messages for controlling and interacting with collection proxies\nwhich are used to dynamically load collections into the runtime.",
+    "path": "engine/gamesys/src/gamesys/scripts/script_collectionproxy.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}