Skip to content

Commit caca67f

Browse files
defold-servicesdefold-services
committed
Site changes [skip-ci]
1 parent 2c228b4 commit caca67f

File tree

5 files changed

+52
-21
lines changed

5 files changed

+52
-21
lines changed

‎_data/ref/alpha/camera.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@
613613
],
614614
"info": {
615615
"brief": "Camera API documentation",
616-
"description": "Messages to control camera components and camera focus.",
616+
"description": "Camera functions, messages and constants.",
617617
"file": "",
618618
"group": "COMPONENTS",
619619
"language": "",

‎_data/ref/alpha/dmGameSystem.json

+5-6
Original file line numberDiff line numberDiff line change
@@ -514,14 +514,13 @@
514514
}
515515
],
516516
"info": {
517-
"brief": "SDK Gui Component API documentation",
518-
"description": "Built-in scripting functions.",
519-
"file": "dmsdk/gamesys/gui.h",
520-
"group": "DEFOLD SDK",
517+
"brief": "Component render constant API documentation",
518+
"description": "<span class=\"file\"><dmsdk/gamesystem/render_constants.h></span>\nApi for setting and updating component render constants",
519+
"file": "",
521520
"language": "",
522-
"name": "GameSystem Gui",
521+
"name": "Component Render Constants",
523522
"namespace": "dmGameSystem",
524523
"notes": [],
525-
"path": "engine/gamesys/src/dmsdk/gamesys/gui.h"
524+
"path": ""
526525
}
527526
}

‎_data/ref/alpha/dmGraphics.json

+6-5
Original file line numberDiff line numberDiff line change
@@ -2555,13 +2555,14 @@
25552555
}
25562556
],
25572557
"info": {
2558-
"brief": "Graphics API documentation",
2559-
"description": "<span class=\"file\"><dmsdk/graphics/graphics_webgpu.h></span>\nGraphics WebGPU API",
2560-
"file": "",
2558+
"brief": "SDK Graphics API documentation",
2559+
"description": "Platform specific native graphics functions.",
2560+
"file": "dmsdk/graphics/graphics_native.h",
2561+
"group": "DEFOLD SDK",
25612562
"language": "",
2562-
"name": "Graphics WebGPU",
2563+
"name": "Graphics",
25632564
"namespace": "dmGraphics",
25642565
"notes": [],
2565-
"path": ""
2566+
"path": "engine/dlib/src/dmsdk/graphics/graphics_native.h"
25662567
}
25672568
}

‎_data/ref/alpha/editor.json

+31
Original file line numberDiff line numberDiff line change
@@ -1002,6 +1002,37 @@
10021002
"tparams": [],
10031003
"type": "FUNCTION"
10041004
},
1005+
{
1006+
"brief": "create an editor command",
1007+
"description": "Create an editor command",
1008+
"error": "",
1009+
"examples": "Print Git history for a file:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">editor</span><span class=\"o\">.</span><span class=\"n\">command</span><span class=\"p\">({</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">label</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"s2\">&quot;Git History&quot;</span><span class=\"p\">,</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">query</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">selection</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">type</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"s2\">&quot;resource&quot;</span><span class=\"p\">,</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">cardinality</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"s2\">&quot;one&quot;</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"p\">}</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"p\">},</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">run</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"n\">function</span><span class=\"p\">(</span><span class=\"n\">opts</span><span class=\"p\">)</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">editor</span><span class=\"o\">.</span><span class=\"n\">execute</span><span class=\"p\">(</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"s2\">&quot;git&quot;</span><span class=\"p\">,</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"s2\">&quot;log&quot;</span><span class=\"p\">,</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"s2\">&quot;--follow&quot;</span><span class=\"p\">,</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"s2\">&quot;.&quot;</span><span class=\"w\"> </span><span class=\"o\">..</span><span class=\"w\"> </span><span class=\"n\">editor</span><span class=\"o\">.</span><span class=\"n\">get</span><span class=\"p\">(</span><span class=\"n\">opts</span><span class=\"o\">.</span><span class=\"n\">selection</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"s2\">&quot;path&quot;</span><span class=\"p\">),</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"p\">{</span><span class=\"n\">reload_resources</span><span class=\"o\">=</span><span class=\"bp\">false</span><span class=\"p\">})</span><span class=\"w\"></span>\n<span class=\"w\"> </span><span class=\"n\">end</span><span class=\"w\"></span>\n<span class=\"p\">})</span><span class=\"w\"></span>\n</code></pre></div>",
1010+
"language": "",
1011+
"members": [],
1012+
"name": "editor.command",
1013+
"notes": [],
1014+
"parameters": [
1015+
{
1016+
"doc": "A table with the following keys:<dl><dt><code>label <small>string</small></code></dt><dd>required, user-visible command name</dd><dt><code>locations <small>string[]</small></code></dt><dd>required, a non-empty list of locations where the command is displayed in the editor, values are either <code>\"Edit\"</code>, <code>\"View\"</code>, <code>\"Project\"</code>, <code>\"Debug\"</code> (the editor menubar), <code>\"Assets\"</code> (the assets pane), or <code>\"Outline\"</code> (the outline pane)</dd><dt><code>query <small>table</small></code></dt><dd>optional, a query that both controls the command availability and provides additional information to the command handler functions; a table with the following keys:<dl><dt><code>selection <small>table</small></code></dt><dd>current selection, a table with the following keys:<dl><dt><code>type <small>string</small></code></dt><dd>either <code>\"resource\"</code> (selected resource) or <code>\"outline\"</code> (selected outline node)</dd><dt><code>cardinality <small>string</small></code></dt><dd>either <code>\"one\"</code> (will use first selected item) or <code>\"many\"</code> (will use all selected items)</dd></dl></dd><dt><code>argument <small>table</small></code></dt><dd>the command argument</dd></dl></dd><dt><code>id <small>string</small></code></dt><dd>optional, keyword identifier that may be used for assigning a shortcut to a command; should be a dot-separated identifier string, e.g. <code>\"my-extension.do-stuff\"</code></dd><dt><code>active <small>function</small></code></dt><dd>optional function that additionally checks if a command is active in the current context; will receive opts table with values populated by the query; should be fast to execute since the editor might invoke it in response to UI interactions (on key typed, mouse clicked)</dd><dt><code>run <small>function</small></code></dt><dd>optional function that is invoked when the user decides to execute the command; will receive opts table with values populated by the query</dd></dl>",
1017+
"name": "opts",
1018+
"types": [
1019+
"table"
1020+
]
1021+
}
1022+
],
1023+
"replaces": "",
1024+
"returnvalues": [
1025+
{
1026+
"doc": "",
1027+
"name": "command",
1028+
"types": [
1029+
"command"
1030+
]
1031+
}
1032+
],
1033+
"tparams": [],
1034+
"type": "FUNCTION"
1035+
},
10051036
{
10061037
"brief": "create a directory if it does not exist, and all non-existent parent directories.",
10071038
"description": "Create a directory if it does not exist, and all non-existent parent directories.\nThrows an error if the directory can't be created.",

‎_data/refindex.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,14 @@
375375
"type": "defold",
376376
"url": "/ref/stable/physics"
377377
},
378+
{
379+
"branch": "alpha",
380+
"filename": "dmGameSystem",
381+
"name": "Component Render Constants",
382+
"namespace": "dmGameSystem",
383+
"type": "c",
384+
"url": "/ref/alpha/dmGameSystem"
385+
},
378386
{
379387
"branch": "alpha",
380388
"filename": "dmConditionVariable",
@@ -1363,14 +1371,6 @@
13631371
"type": "c",
13641372
"url": "/ref/stable/dmGameObject"
13651373
},
1366-
{
1367-
"branch": "alpha",
1368-
"filename": "dmGameSystem",
1369-
"name": "GameSystem Gui",
1370-
"namespace": "dmGameSystem",
1371-
"type": "c",
1372-
"url": "/ref/alpha/dmGameSystem"
1373-
},
13741374
{
13751375
"branch": "beta",
13761376
"filename": "dmGameSystem",
@@ -1390,7 +1390,7 @@
13901390
{
13911391
"branch": "alpha",
13921392
"filename": "dmGraphics",
1393-
"name": "Graphics WebGPU",
1393+
"name": "Graphics",
13941394
"namespace": "dmGraphics",
13951395
"type": "c",
13961396
"url": "/ref/alpha/dmGraphics"

0 commit comments

Comments
 (0)