@kitionstage/sdk 0.0.0-stage → 0.5.2-stage.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (258) hide show
  1. package/README.md +69 -2
  2. package/dist/LICENSE +177 -0
  3. package/dist/THIRD_PARTY_NOTICES +28 -0
  4. package/dist/lib/assets/kitEngine.worker-9haDiVHZ.js +13220 -0
  5. package/dist/lib/chunks/batch-BWpAyHvP.js +789 -0
  6. package/dist/lib/chunks/canonical-BIWfVCL-.js +87 -0
  7. package/dist/lib/chunks/envelope-D6MGY-ZN.js +61 -0
  8. package/dist/lib/chunks/replica-D8w3I4sn.js +2472 -0
  9. package/dist/lib/chunks/runtime-BVJHE1Pg.js +997 -0
  10. package/dist/lib/chunks/session-BqXC9a1-.js +281 -0
  11. package/dist/lib/chunks/toolIds-BCeSGHpV.js +821 -0
  12. package/dist/lib/chunks/workspaceTree-Destqupf.js +23 -0
  13. package/dist/lib/convergence/index.js +1035 -0
  14. package/dist/lib/convergence/node.js +8 -0
  15. package/dist/lib/embed-server/callbacks.js +37 -0
  16. package/dist/lib/embed-server/cli.js +19 -0
  17. package/dist/lib/embed-server/index.js +272 -0
  18. package/dist/lib/extensions/index.js +439 -0
  19. package/dist/lib/extensions/panel.html +208 -0
  20. package/dist/lib/extensions/runtime.js +198 -0
  21. package/dist/lib/extensions/sandbox.html +35 -0
  22. package/dist/lib/kdm/index.js +437 -0
  23. package/dist/lib/kit-dev-host/checkUiIds.mjs +44 -0
  24. package/dist/lib/kit-dev-host/index.js +308 -0
  25. package/dist/lib/kit-dev-host/lineRow.mjs +47 -0
  26. package/dist/lib/kit-dev-host/modeSmoke.mjs +178 -0
  27. package/dist/lib/kit-editor/index.js +6489 -0
  28. package/dist/lib/kit-editor/styles.css +807 -0
  29. package/dist/lib/kit-editor/workspaceTree.js +1 -0
  30. package/dist/lib/kit-engine/index.js +7 -0
  31. package/dist/lib/kit-host/index.js +530 -0
  32. package/dist/lib/kit-ui-protocol/index.js +336 -0
  33. package/dist/lib/node-only/embed-server-callbacks.js +2 -0
  34. package/dist/lib/node-only/embed-server.js +2 -0
  35. package/dist/lib/sync/index.js +1008 -0
  36. package/dist/lib/sync/openToken.js +201 -0
  37. package/dist/lib/sync/replicaVersions.js +51 -0
  38. package/dist/standalone/chunks/batch-CAGYk6m4.js +789 -0
  39. package/dist/standalone/chunks/client-B9xkOcvf.js +772 -0
  40. package/dist/standalone/chunks/collab-B5TbpTyO.js +1022 -0
  41. package/dist/standalone/chunks/comment-Ds9t8xSE.js +94 -0
  42. package/dist/standalone/chunks/comments-uVDS8Wxp.js +41 -0
  43. package/dist/standalone/chunks/document-CuIGSDsY.js +324 -0
  44. package/dist/standalone/chunks/envelope-GX4Cynkx.js +7612 -0
  45. package/dist/standalone/chunks/index-BEgEEnhU.js +287 -0
  46. package/dist/standalone/chunks/index-Blc_B6iX.js +1967 -0
  47. package/dist/standalone/chunks/kits-Cp51mDlw.js +9 -0
  48. package/dist/standalone/chunks/replica-Di2iCPiD.js +3281 -0
  49. package/dist/standalone/chunks/replicaVersions-C3rJxnk9.js +50 -0
  50. package/dist/standalone/chunks/touched-T9jKJjxn.js +78 -0
  51. package/dist/standalone/index.js +12 -0
  52. package/dist/standalone/script/index.js +339 -0
  53. package/dist/standalone/script/kits/board.js +5 -0
  54. package/dist/standalone/script/kits/cad.js +5 -0
  55. package/dist/standalone/script/kits/design.js +5 -0
  56. package/dist/standalone/script/kits/doc.js +5 -0
  57. package/dist/standalone/script/kits/film.js +5 -0
  58. package/dist/standalone/script/kits/html.js +5 -0
  59. package/dist/standalone/script/kits/index.js +38 -0
  60. package/dist/standalone/script/kits/layout.js +5 -0
  61. package/dist/standalone/script/kits/motion.js +5 -0
  62. package/dist/standalone/script/kits/note.js +5 -0
  63. package/dist/standalone/script/kits/pdf.js +5 -0
  64. package/dist/standalone/script/kits/photo.js +5 -0
  65. package/dist/standalone/script/kits/scene.js +5 -0
  66. package/dist/standalone/script/kits/sheet.js +5 -0
  67. package/dist/standalone/script/kits/slide.js +5 -0
  68. package/dist/standalone/script/kits/table.js +5 -0
  69. package/dist/standalone/script/kits/vector.js +5 -0
  70. package/dist/standalone/script/node.js +401 -0
  71. package/dist/standalone/script/proxy.js +254 -0
  72. package/dist/types/convergence/src/adapter.d.ts +131 -0
  73. package/dist/types/convergence/src/engine.d.ts +66 -0
  74. package/dist/types/convergence/src/index.d.ts +21 -0
  75. package/dist/types/convergence/src/net.d.ts +52 -0
  76. package/dist/types/convergence/src/node.d.ts +6 -0
  77. package/dist/types/convergence/src/report.d.ts +56 -0
  78. package/dist/types/convergence/src/rng.d.ts +12 -0
  79. package/dist/types/convergence/src/scenarios.d.ts +15 -0
  80. package/dist/types/convergence/src/state.d.ts +67 -0
  81. package/dist/types/embed/src/agent.d.ts +88 -0
  82. package/dist/types/embed/src/blobs.d.ts +2 -0
  83. package/dist/types/embed/src/collab.d.ts +250 -0
  84. package/dist/types/embed/src/comments.d.ts +30 -0
  85. package/dist/types/embed/src/errors.d.ts +24 -0
  86. package/dist/types/embed/src/handlers.d.ts +92 -0
  87. package/dist/types/embed/src/index.d.ts +20 -0
  88. package/dist/types/embed/src/mount.d.ts +39 -0
  89. package/dist/types/embed/src/replicaStore.d.ts +3 -0
  90. package/dist/types/embed/src/rooms.d.ts +40 -0
  91. package/dist/types/embed/src/schemas.d.ts +7 -0
  92. package/dist/types/embed/src/syncClients.d.ts +28 -0
  93. package/dist/types/embed/src/theme.d.ts +7 -0
  94. package/dist/types/embed/src/types.d.ts +596 -0
  95. package/dist/types/embed/src/ui.d.ts +33 -0
  96. package/dist/types/embed/src/version.d.ts +2 -0
  97. package/dist/types/embed-server/src/callbacks.d.ts +30 -0
  98. package/dist/types/embed-server/src/cli.d.ts +1 -0
  99. package/dist/types/embed-server/src/index.d.ts +19 -0
  100. package/dist/types/embed-server/src/page.d.ts +15 -0
  101. package/dist/types/embed-server/src/server.d.ts +39 -0
  102. package/dist/types/embed-server/src/session.d.ts +22 -0
  103. package/dist/types/extensions/src/gate.d.ts +17 -0
  104. package/dist/types/extensions/src/generated/runtime.d.ts +8 -0
  105. package/dist/types/extensions/src/host.d.ts +135 -0
  106. package/dist/types/extensions/src/index.d.ts +13 -0
  107. package/dist/types/extensions/src/manifest.d.ts +82 -0
  108. package/dist/types/extensions/src/protocol.d.ts +159 -0
  109. package/dist/types/extensions/src/rpc.d.ts +52 -0
  110. package/dist/types/extensions/src/runtime/document.d.ts +40 -0
  111. package/dist/types/extensions/src/runtime/index.d.ts +10 -0
  112. package/dist/types/extensions/src/runtime/panel.d.ts +19 -0
  113. package/dist/types/extensions/src/runtime/runtime.d.ts +54 -0
  114. package/dist/types/extensions/src/runtime/worker.d.ts +1 -0
  115. package/dist/types/extensions/src/sandbox.d.ts +41 -0
  116. package/dist/types/kdm/src/args.d.ts +12 -0
  117. package/dist/types/kdm/src/batch.d.ts +118 -0
  118. package/dist/types/kdm/src/canonical.d.ts +25 -0
  119. package/dist/types/kdm/src/comment.d.ts +114 -0
  120. package/dist/types/kdm/src/diff.d.ts +125 -0
  121. package/dist/types/kdm/src/envelope.d.ts +27 -0
  122. package/dist/types/kdm/src/errors.d.ts +28 -0
  123. package/dist/types/kdm/src/footprint.d.ts +21 -0
  124. package/dist/types/kdm/src/ids.d.ts +57 -0
  125. package/dist/types/kdm/src/index.d.ts +18 -0
  126. package/dist/types/kdm/src/marks.d.ts +32 -0
  127. package/dist/types/kdm/src/op.d.ts +124 -0
  128. package/dist/types/kdm/src/origin.d.ts +41 -0
  129. package/dist/types/kdm/src/overlay.d.ts +92 -0
  130. package/dist/types/kdm/src/projection.d.ts +29 -0
  131. package/dist/types/kdm/src/read.d.ts +90 -0
  132. package/dist/types/kdm/src/replica.d.ts +403 -0
  133. package/dist/types/kdm/src/schema.d.ts +185 -0
  134. package/dist/types/kdm/src/testing.d.ts +28 -0
  135. package/dist/types/kdm/src/toolIds.d.ts +61 -0
  136. package/dist/types/kdm/src/touched.d.ts +24 -0
  137. package/dist/types/kdm/src/tx.d.ts +215 -0
  138. package/dist/types/kdm/src/value.d.ts +23 -0
  139. package/dist/types/kit-dev-host/src/checkNoPaths.d.ts +19 -0
  140. package/dist/types/kit-dev-host/src/checkUiIds.d.mts +2 -0
  141. package/dist/types/kit-dev-host/src/index.d.ts +179 -0
  142. package/dist/types/kit-dev-host/src/lineRow.d.mts +14 -0
  143. package/dist/types/kit-dev-host/src/memoryFiles.d.ts +15 -0
  144. package/dist/types/kit-dev-host/src/modeSmoke.d.mts +8 -0
  145. package/dist/types/kit-editor/src/CommandDialog.d.ts +22 -0
  146. package/dist/types/kit-editor/src/CommentsPanel.d.ts +45 -0
  147. package/dist/types/kit-editor/src/CustomizeDialog.d.ts +32 -0
  148. package/dist/types/kit-editor/src/HostButtons.d.ts +11 -0
  149. package/dist/types/kit-editor/src/RenderFailure.d.ts +7 -0
  150. package/dist/types/kit-editor/src/TextSink.d.ts +6 -0
  151. package/dist/types/kit-editor/src/brand.d.ts +2 -0
  152. package/dist/types/kit-editor/src/catalogMenus.d.ts +27 -0
  153. package/dist/types/kit-editor/src/chart.d.ts +138 -0
  154. package/dist/types/kit-editor/src/conflicts.d.ts +12 -0
  155. package/dist/types/kit-editor/src/drawing.d.ts +83 -0
  156. package/dist/types/kit-editor/src/editor.d.ts +544 -0
  157. package/dist/types/kit-editor/src/engine/KitCanvas.d.ts +70 -0
  158. package/dist/types/kit-editor/src/engine/backdrop.d.ts +32 -0
  159. package/dist/types/kit-editor/src/engine/createKitFile.d.ts +12 -0
  160. package/dist/types/kit-editor/src/engine/decorations.d.ts +14 -0
  161. package/dist/types/kit-editor/src/engine/engineOverlays.d.ts +197 -0
  162. package/dist/types/kit-editor/src/engine/engineTools.d.ts +116 -0
  163. package/dist/types/kit-editor/src/engine/kitDraft.d.ts +70 -0
  164. package/dist/types/kit-editor/src/engine/kitEngine.d.ts +390 -0
  165. package/dist/types/kit-editor/src/engine/kitEngine.worker.d.ts +30 -0
  166. package/dist/types/kit-editor/src/engine/kitHost.d.ts +41 -0
  167. package/dist/types/kit-editor/src/engine/kitModel.d.ts +32 -0
  168. package/dist/types/kit-editor/src/engine/kitModelRunner.d.ts +99 -0
  169. package/dist/types/kit-editor/src/engine/kitModule.d.ts +185 -0
  170. package/dist/types/kit-editor/src/engine/kitShortcuts.d.ts +32 -0
  171. package/dist/types/kit-editor/src/engine/kitTools.d.ts +79 -0
  172. package/dist/types/kit-editor/src/engine/lazyFonts.d.ts +34 -0
  173. package/dist/types/kit-editor/src/engine/lentFiles.d.ts +29 -0
  174. package/dist/types/kit-editor/src/engine/rasterViewport.d.ts +178 -0
  175. package/dist/types/kit-editor/src/engine/readOnly.d.ts +78 -0
  176. package/dist/types/kit-editor/src/engine/refusal.d.ts +39 -0
  177. package/dist/types/kit-editor/src/engine/replica.d.ts +23 -0
  178. package/dist/types/kit-editor/src/engine/useKitDocument.d.ts +154 -0
  179. package/dist/types/kit-editor/src/engine/workerRelay.d.ts +62 -0
  180. package/dist/types/kit-editor/src/files.d.ts +74 -0
  181. package/dist/types/kit-editor/src/frame/EditorFrame.d.ts +74 -0
  182. package/dist/types/kit-editor/src/frame/FocusBar.d.ts +10 -0
  183. package/dist/types/kit-editor/src/frame/MenuNodes.d.ts +20 -0
  184. package/dist/types/kit-editor/src/frame/MenuRibbon.d.ts +8 -0
  185. package/dist/types/kit-editor/src/frame/ModeButton.d.ts +7 -0
  186. package/dist/types/kit-editor/src/frame/menus.d.ts +64 -0
  187. package/dist/types/kit-editor/src/frame/modes.d.ts +51 -0
  188. package/dist/types/kit-editor/src/frame/useFrameLayout.d.ts +34 -0
  189. package/dist/types/kit-editor/src/host.d.ts +127 -0
  190. package/dist/types/kit-editor/src/index.d.ts +85 -0
  191. package/dist/types/kit-editor/src/ink.d.ts +26 -0
  192. package/dist/types/kit-editor/src/lease.d.ts +53 -0
  193. package/dist/types/kit-editor/src/oneInFlight.d.ts +7 -0
  194. package/dist/types/kit-editor/src/phrases.d.ts +25 -0
  195. package/dist/types/kit-editor/src/presence.d.ts +79 -0
  196. package/dist/types/kit-editor/src/strings.d.ts +6 -0
  197. package/dist/types/kit-editor/src/toolIcons.d.ts +32 -0
  198. package/dist/types/kit-editor/src/uiCatalog.d.ts +59 -0
  199. package/dist/types/kit-editor/src/uiConfig.d.ts +53 -0
  200. package/dist/types/kit-editor/src/uiContext.d.ts +65 -0
  201. package/dist/types/kit-editor/src/uiStore.d.ts +20 -0
  202. package/dist/types/kit-editor/src/useCommentAnchors.d.ts +29 -0
  203. package/dist/types/kit-editor/src/useKitSession.d.ts +115 -0
  204. package/dist/types/kit-editor/src/workspaceTree.d.ts +5 -0
  205. package/dist/types/kit-engine/src/contract.d.ts +154 -0
  206. package/dist/types/kit-engine/src/index.d.ts +2 -0
  207. package/dist/types/kit-engine/src/session.d.ts +133 -0
  208. package/dist/types/kit-host/src/files.d.ts +163 -0
  209. package/dist/types/kit-host/src/index.d.ts +315 -0
  210. package/dist/types/kit-ui-protocol/src/index.d.ts +1145 -0
  211. package/dist/types/loro-crdt.d.ts +9 -0
  212. package/dist/types/script/kits/board.d.ts +534 -0
  213. package/dist/types/script/kits/cad.d.ts +2937 -0
  214. package/dist/types/script/kits/design.d.ts +3213 -0
  215. package/dist/types/script/kits/doc.d.ts +2575 -0
  216. package/dist/types/script/kits/film.d.ts +4067 -0
  217. package/dist/types/script/kits/html.d.ts +38 -0
  218. package/dist/types/script/kits/index.d.ts +20 -0
  219. package/dist/types/script/kits/layout.d.ts +3483 -0
  220. package/dist/types/script/kits/motion.d.ts +4826 -0
  221. package/dist/types/script/kits/note.d.ts +631 -0
  222. package/dist/types/script/kits/pdf.d.ts +829 -0
  223. package/dist/types/script/kits/photo.d.ts +7574 -0
  224. package/dist/types/script/kits/scene.d.ts +2962 -0
  225. package/dist/types/script/kits/sheet.d.ts +2419 -0
  226. package/dist/types/script/kits/slide.d.ts +1894 -0
  227. package/dist/types/script/kits/table.d.ts +654 -0
  228. package/dist/types/script/kits/vector.d.ts +5167 -0
  229. package/dist/types/script/src/agentRelay.d.ts +48 -0
  230. package/dist/types/script/src/capabilities.d.ts +21 -0
  231. package/dist/types/script/src/document.d.ts +87 -0
  232. package/dist/types/script/src/drafts.d.ts +141 -0
  233. package/dist/types/script/src/exchange.d.ts +30 -0
  234. package/dist/types/script/src/headless.d.ts +190 -0
  235. package/dist/types/script/src/index.d.ts +15 -0
  236. package/dist/types/script/src/kitModel.d.ts +17 -0
  237. package/dist/types/script/src/kits.d.ts +8 -0
  238. package/dist/types/script/src/node.d.ts +42 -0
  239. package/dist/types/script/src/port.d.ts +89 -0
  240. package/dist/types/script/src/proxy.d.ts +132 -0
  241. package/dist/types/script/src/room.d.ts +162 -0
  242. package/dist/types/script/src/sources.d.ts +73 -0
  243. package/dist/types/sync/src/backoff.d.ts +9 -0
  244. package/dist/types/sync/src/blobSection.d.ts +23 -0
  245. package/dist/types/sync/src/capabilities.d.ts +20 -0
  246. package/dist/types/sync/src/client.d.ts +253 -0
  247. package/dist/types/sync/src/framing.d.ts +35 -0
  248. package/dist/types/sync/src/hash.d.ts +2 -0
  249. package/dist/types/sync/src/index.d.ts +19 -0
  250. package/dist/types/sync/src/leases.d.ts +82 -0
  251. package/dist/types/sync/src/openToken.d.ts +104 -0
  252. package/dist/types/sync/src/protocol.d.ts +484 -0
  253. package/dist/types/sync/src/relay.d.ts +52 -0
  254. package/dist/types/sync/src/replicaVersions.d.ts +17 -0
  255. package/dist/types/sync/src/saveMachine.d.ts +83 -0
  256. package/dist/types/sync/src/saveRun.d.ts +52 -0
  257. package/dist/types/sync/src/transport.d.ts +19 -0
  258. package/package.json +229 -4
@@ -0,0 +1,2962 @@
1
+ import type { CommandMap, ModelDocument, ModelList, ModelMap, ModelObject, RequestContext } from '../src/index.js';
2
+ import { type KitDescriptor } from '../src/kits.js';
3
+ type Json = null | boolean | number | string | Json[] | {
4
+ [key: string]: Json;
5
+ };
6
+ type BlobRef = {
7
+ hash: string;
8
+ mime: string;
9
+ size: number;
10
+ };
11
+ /** kit.scene: registered with @kition/script when this module loads. */
12
+ export declare const sceneKit: KitDescriptor;
13
+ /** The fields a new `Scene` takes (`list.add(fields)`). */
14
+ export type SceneFields = {
15
+ world: Json;
16
+ render: Json;
17
+ camera?: number | null;
18
+ timeline: Json;
19
+ physics?: Json | null;
20
+ actions?: Json | null;
21
+ keyingSets?: Json | null;
22
+ };
23
+ /** A `Scene` of kit.scene. */
24
+ export interface Scene extends ModelObject {
25
+ readonly objects: ModelList<Object, ObjectFields>;
26
+ readonly materials: ModelList<Material, MaterialFields>;
27
+ readonly images: ModelList<Image, ImageFields>;
28
+ world: Json;
29
+ render: Json;
30
+ camera: number | null;
31
+ timeline: Json;
32
+ physics: Json | null;
33
+ actions: Json | null;
34
+ keyingSets: Json | null;
35
+ readonly keys: ModelMap<Json>;
36
+ }
37
+ /** The fields a new `Object` takes (`list.add(fields)`). */
38
+ export type ObjectFields = {
39
+ name: string;
40
+ data: Json;
41
+ mesh?: BlobRef | null;
42
+ location: Json;
43
+ rotation: Json;
44
+ scale: Json;
45
+ parentInverse?: Json | null;
46
+ hidden: boolean;
47
+ modifiers: Json;
48
+ constraints?: Json | null;
49
+ physics?: Json | null;
50
+ particles?: Json | null;
51
+ hair?: BlobRef | null;
52
+ animation: Json;
53
+ nla?: Json | null;
54
+ tweak?: Json | null;
55
+ };
56
+ /** A `Object` of kit.scene. */
57
+ export interface Object extends ModelObject {
58
+ /** Read-only: the kit keeps it as it is. */
59
+ readonly key: number | null;
60
+ name: string;
61
+ /** Read-only: the kit keeps it as it is. */
62
+ readonly kind: "mesh" | "light" | "camera" | "empty" | "armature" | "curve" | "text" | "lattice";
63
+ data: Json;
64
+ mesh: BlobRef | null;
65
+ location: Json;
66
+ rotation: Json;
67
+ scale: Json;
68
+ /** Read-only: the kit keeps it as it is. */
69
+ readonly parent: number | null;
70
+ parentInverse: Json | null;
71
+ hidden: boolean;
72
+ /** Read-only: the kit keeps it as it is. */
73
+ readonly material: number | null;
74
+ modifiers: Json;
75
+ constraints: Json | null;
76
+ physics: Json | null;
77
+ particles: Json | null;
78
+ hair: BlobRef | null;
79
+ animation: Json;
80
+ nla: Json | null;
81
+ tweak: Json | null;
82
+ }
83
+ /** The fields a new `Material` takes (`list.add(fields)`). */
84
+ export type MaterialFields = {
85
+ name: string;
86
+ data: Json;
87
+ animation: Json;
88
+ };
89
+ /** A `Material` of kit.scene. */
90
+ export interface Material extends ModelObject {
91
+ /** Read-only: the kit keeps it as it is. */
92
+ readonly key: number | null;
93
+ name: string;
94
+ data: Json;
95
+ animation: Json;
96
+ }
97
+ /** The fields a new `NodeGroup` takes (`list.add(fields)`). */
98
+ export type NodeGroupFields = {
99
+ name: string;
100
+ tree?: string | null;
101
+ inputs?: Json | null;
102
+ outputs?: Json | null;
103
+ };
104
+ /** A `NodeGroup` of kit.scene. */
105
+ export interface NodeGroup extends ModelObject {
106
+ /** Read-only: the kit keeps it as it is. */
107
+ readonly key: number | null;
108
+ name: string;
109
+ tree: string | null;
110
+ inputs: Json | null;
111
+ outputs: Json | null;
112
+ readonly nodes: ModelList<Node, NodeFields>;
113
+ readonly links: ModelList<Link, LinkFields>;
114
+ }
115
+ /** The fields a new `Node` takes (`list.add(fields)`). */
116
+ export type NodeFields = {
117
+ kind: string;
118
+ location: Json;
119
+ };
120
+ /** A `Node` of kit.scene. */
121
+ export interface Node extends ModelObject {
122
+ /** Read-only: the kit keeps it as it is. */
123
+ readonly key: number | null;
124
+ kind: string;
125
+ location: Json;
126
+ readonly values: ModelMap<Json>;
127
+ }
128
+ /** The fields a new `Link` takes (`list.add(fields)`). */
129
+ export type LinkFields = {
130
+ from: number;
131
+ fromSocket: string;
132
+ to: number;
133
+ toSocket: string;
134
+ };
135
+ /** A `Link` of kit.scene. */
136
+ export interface Link extends ModelObject {
137
+ from: number;
138
+ fromSocket: string;
139
+ to: number;
140
+ toSocket: string;
141
+ }
142
+ /** The fields a new `Image` takes (`list.add(fields)`). */
143
+ export type ImageFields = {
144
+ name: string;
145
+ format: string;
146
+ bytes: BlobRef;
147
+ };
148
+ /** A `Image` of kit.scene. */
149
+ export interface Image extends ModelObject {
150
+ /** Read-only: the kit keeps it as it is. */
151
+ readonly hash: string;
152
+ name: string;
153
+ format: string;
154
+ bytes: BlobRef;
155
+ }
156
+ /** Every command of kit.scene, by id, with its parameters. */
157
+ export interface SceneCommands extends CommandMap {
158
+ /** Undo. Takes back the caller's last edit (the person's, or the agent's with `scope: "agent"`), leaving the other's edits in place. Changes the document. */
159
+ "edit.undo": {
160
+ scope?: "person" | "agent";
161
+ };
162
+ /** Redo. Applies again the edit the caller's last undo took back, in the same scope as `edit.undo`. Changes the document. */
163
+ "edit.redo": {
164
+ scope?: "person" | "agent";
165
+ };
166
+ /** Delete. Deletes `objects` (names or ids; the selection without it) from the scene. Acts on `objects`. Reads the selection. Changes the document. */
167
+ "edit.delete": {
168
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
169
+ pick?: Array<number>;
170
+ };
171
+ /** Duplicate. Duplicates `objects` (the selection without it), moved by `offset`, and answers the copies' ids; a person's duplicate selects the copies, an agent's given `objects` leaves the selection as it was. Acts on `objects`. Reads the selection. Changes the document. */
172
+ "edit.duplicate": {
173
+ objects?: Json; /** Move the copies by this much, in metres [x, y, z] */
174
+ offset?: Array<number>; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
175
+ pick?: Array<number>;
176
+ };
177
+ /** Select All. Selects every object in object mode (or every element in edit mode); `action: "toggle"`/`"deselect"` changes that. Answers whether the selection changed. Reads the selection. */
178
+ "select.all": {
179
+ action?: "select" | "deselect" | "invert";
180
+ };
181
+ /** Select None. Clears the selection. Answers whether it changed. Reads the selection. */
182
+ "select.none": Record<string, never>;
183
+ /** Select Objects. Selects the objects in `objects` (names or ids), adding with `extend` or removing with `deselect`, for selection-based commands. Acts on `objects`. Reads the selection. */
184
+ "select.objects": {
185
+ deselect?: boolean; /** Add to the selection instead of replacing it */
186
+ extend?: boolean; /** The objects to select */
187
+ objects: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
188
+ pick?: Array<number>;
189
+ };
190
+ /** Plane. Adds a plane mesh of `size` at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
191
+ "add.plane": {
192
+ location?: Array<number>; /** The object's name */
193
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
194
+ rotation?: Array<number>; /** Scale [x, y, z] */
195
+ scale?: Array<number>; /** Side length in metres (2) */
196
+ size?: number;
197
+ };
198
+ /** Backdrop. Adds a backdrop (a cyclorama): a floor curving up into a wall, smooth, so renders show no horizon. `width`, `depth` (floor in front of the curve, centred on the origin), `height`, and `radius` in metres, `segments` round the curve. Changes the document. */
199
+ "add.backdrop": {
200
+ depth?: number; /** Height of the wall in metres (8) */
201
+ height?: number; /** Where to put it, in metres (the origin when left out) [x, y, z] */
202
+ location?: Array<number>; /** The object's name */
203
+ name?: string; /** Radius of the curve from floor to wall in metres (3) */
204
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
205
+ rotation?: Array<number>; /** Scale [x, y, z] */
206
+ scale?: Array<number>; /** Faces round the curve, 1 to 256 (16) */
207
+ segments?: number; /** Width across X in metres (20) */
208
+ width?: number;
209
+ };
210
+ /** Cube. Adds a cube mesh of `size` at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
211
+ "add.cube": {
212
+ location?: Array<number>; /** The object's name */
213
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
214
+ rotation?: Array<number>; /** Scale [x, y, z] */
215
+ scale?: Array<number>; /** Side length in metres (2) */
216
+ size?: number;
217
+ };
218
+ /** Circle. Adds a circle mesh of `radius` and vertex count, optionally filled at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
219
+ "add.circle": {
220
+ fill?: "nothing" | "ngon" | "triangleFan"; /** Where to put it, in metres (the origin when left out) [x, y, z] */
221
+ location?: Array<number>; /** The object's name */
222
+ name?: string; /** Radius in metres (1) */
223
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
224
+ rotation?: Array<number>; /** Scale [x, y, z] */
225
+ scale?: Array<number>; /** Vertices (32) */
226
+ vertices?: number;
227
+ };
228
+ /** UV Sphere. Adds a UV sphere mesh of `radius` with segments and rings at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
229
+ "add.uvSphere": {
230
+ location?: Array<number>; /** The object's name */
231
+ name?: string; /** Radius in metres (1) */
232
+ radius?: number; /** Rings from pole to pole (16) */
233
+ rings?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
234
+ rotation?: Array<number>; /** Scale [x, y, z] */
235
+ scale?: Array<number>; /** Segments around (32) */
236
+ segments?: number;
237
+ };
238
+ /** Ico Sphere. Adds a icosphere mesh of `radius` and subdivision level at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
239
+ "add.icoSphere": {
240
+ location?: Array<number>; /** The object's name */
241
+ name?: string; /** Radius in metres (1) */
242
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
243
+ rotation?: Array<number>; /** Scale [x, y, z] */
244
+ scale?: Array<number>; /** Subdivisions, 1 to 8 (2) */
245
+ subdivisions?: number;
246
+ };
247
+ /** Cylinder. Adds a cylinder mesh of `radius` and `depth` at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
248
+ "add.cylinder": {
249
+ depth?: number; /** How the ends are closed */
250
+ fill?: "nothing" | "ngon" | "triangleFan"; /** Where to put it, in metres (the origin when left out) [x, y, z] */
251
+ location?: Array<number>; /** The object's name */
252
+ name?: string; /** Radius in metres (1) */
253
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
254
+ rotation?: Array<number>; /** Scale [x, y, z] */
255
+ scale?: Array<number>; /** Vertices around (32) */
256
+ vertices?: number;
257
+ };
258
+ /** Cone. Adds a cone mesh with bottom and top radii and `depth` at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
259
+ "add.cone": {
260
+ depth?: number; /** How the ends are closed */
261
+ fill?: "nothing" | "ngon" | "triangleFan"; /** Where to put it, in metres (the origin when left out) [x, y, z] */
262
+ location?: Array<number>; /** The object's name */
263
+ name?: string; /** Bottom radius in metres (1) */
264
+ radius1?: number; /** Top radius in metres (0) */
265
+ radius2?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
266
+ rotation?: Array<number>; /** Scale [x, y, z] */
267
+ scale?: Array<number>; /** Vertices around (32) */
268
+ vertices?: number;
269
+ };
270
+ /** Torus. Adds a torus mesh with major and minor radii and segments at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
271
+ "add.torus": {
272
+ location?: Array<number>; /** Ring radius in metres (1) */
273
+ majorRadius?: number; /** Segments around the ring (48) */
274
+ majorSegments?: number; /** Tube radius in metres (0.25) */
275
+ minorRadius?: number; /** Segments around the tube (12) */
276
+ minorSegments?: number; /** The object's name */
277
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
278
+ rotation?: Array<number>; /** Scale [x, y, z] */
279
+ scale?: Array<number>;
280
+ };
281
+ /** Grid. Adds a grid mesh of `size` with x and y subdivisions at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
282
+ "add.grid": {
283
+ location?: Array<number>; /** The object's name */
284
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
285
+ rotation?: Array<number>; /** Scale [x, y, z] */
286
+ scale?: Array<number>; /** Side length in metres (2) */
287
+ size?: number; /** Faces along X (10) */
288
+ xSubdivisions?: number; /** Faces along Y (10) */
289
+ ySubdivisions?: number;
290
+ };
291
+ /** Light. Adds a light (point, sun, spot or area) with color and power at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
292
+ "add.light": {
293
+ color?: Json; /** The kind of light */
294
+ kind?: "point" | "sun" | "spot" | "area"; /** Where to put it, in metres (the origin when left out) [x, y, z] */
295
+ location?: Array<number>; /** The object's name */
296
+ name?: string; /** Watts (W/m? for a sun) */
297
+ power?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
298
+ rotation?: Array<number>; /** Scale [x, y, z] */
299
+ scale?: Array<number>;
300
+ };
301
+ /** Camera. Adds a camera with a lens in millimetres at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
302
+ "add.camera": {
303
+ lens?: number; /** Where to put it, in metres (the origin when left out) [x, y, z] */
304
+ location?: Array<number>; /** The object's name */
305
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
306
+ rotation?: Array<number>; /** Scale [x, y, z] */
307
+ scale?: Array<number>;
308
+ };
309
+ /** Empty. Adds a empty (an axis marker for parenting and targets) at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
310
+ "add.empty": {
311
+ location?: Array<number>; /** The object's name */
312
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
313
+ rotation?: Array<number>; /** Scale [x, y, z] */
314
+ scale?: Array<number>; /** Axis length in metres (1) */
315
+ size?: number;
316
+ };
317
+ /** Set Transform. Sets location, rotation (degrees) and/or scale of `objects` (names or ids; the selection without it) absolutely. Acts on `objects`. Reads the selection. Changes the document. */
318
+ "object.transform": {
319
+ location?: Array<number>; /** The objects; the selection when left out */
320
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
321
+ pick?: Array<number>; /** Rotation in degrees, XYZ Euler [x, y, z] */
322
+ rotation?: Array<number>; /** Scale [x, y, z] */
323
+ scale?: Array<number>;
324
+ };
325
+ /** Move. Moves `objects` (names or ids; the selection without it) by `offset` [x, y, z]. Acts on `objects`. Reads the selection. Changes the document. */
326
+ "object.translate": {
327
+ objects?: Json; /** How far, in metres [x, y, z] */
328
+ offset: Array<number>; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
329
+ pick?: Array<number>;
330
+ };
331
+ /** Rotate. Rotates `objects` (names or ids; the selection without it) by `angle` degrees about `axis` (x, y or z). Acts on `objects`. Reads the selection. Changes the document. */
332
+ "object.rotate": {
333
+ angle: number; /** The world axis to turn about */
334
+ axis: "x" | "y" | "z"; /** The objects; the selection when left out */
335
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
336
+ pick?: Array<number>;
337
+ };
338
+ /** Scale. Scales `objects` (names or ids; the selection without it) by `factor` (a number or [x, y, z]). Acts on `objects`. Reads the selection. Changes the document. */
339
+ "object.scale": {
340
+ factor: Json; /** The objects; the selection when left out */
341
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
342
+ pick?: Array<number>;
343
+ };
344
+ /** Apply Transform. Bakes the location, rotation and/or scale of `objects` (names or ids; the selection without it) into the mesh data and resets them. Acts on `objects`. Reads the selection. Changes the document. */
345
+ "object.applyTransform": {
346
+ location?: boolean; /** The objects; the selection when left out */
347
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
348
+ pick?: Array<number>; /** Apply the rotation (true) */
349
+ rotation?: boolean; /** Apply the scale (true) */
350
+ scale?: boolean;
351
+ };
352
+ /** Origin to Geometry. Moves the origin of `objects` (names or ids; the selection without it) to the centre of their geometry without moving the geometry. Acts on `objects`. Reads the selection. Changes the document. */
353
+ "object.originToGeometry": {
354
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
355
+ pick?: Array<number>;
356
+ };
357
+ /** Move in Outliner. Moves `object` to position `index` among its siblings in the outliner. Acts on `object`. Reads the selection. Changes the document. */
358
+ "object.order": {
359
+ index: number; /** The object to move */
360
+ object: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
361
+ pick?: Array<number>;
362
+ };
363
+ /** Rename. Renames `object` (name or id) to `name`. Acts on `object`. Reads the selection. Changes the document. */
364
+ "object.rename": {
365
+ name: string; /** The object; the active one when left out */
366
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
367
+ pick?: Array<number>;
368
+ };
369
+ /** Parent. Parents `objects` (names or ids; the selection without it) to `parent`, keeping their world transform. Acts on `objects`. Reads the selection. Changes the document. */
370
+ "object.parent": {
371
+ objects?: Json; /** The parent; the active object when left out */
372
+ parent?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
373
+ pick?: Array<number>;
374
+ };
375
+ /** Clear Parent. Clears the parent of `objects` (names or ids; the selection without it), keeping their world transform. Acts on `objects`. Reads the selection. Changes the document. */
376
+ "object.clearParent": {
377
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
378
+ pick?: Array<number>;
379
+ };
380
+ /** Hide. Hides `objects` (names or ids; the selection without it) in the viewport and renders. Acts on `objects`. Reads the selection. Changes the document. */
381
+ "object.hide": {
382
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
383
+ pick?: Array<number>;
384
+ };
385
+ /** Show Hidden. Shows `objects` (names or ids; the selection without it) again, or every hidden object without it. Acts on `objects`. Changes the document. */
386
+ "object.reveal": {
387
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
388
+ pick?: Array<number>;
389
+ };
390
+ /** Shade Smooth. Shades the meshes of `objects` (names or ids; the selection without it) smooth. Acts on `objects`. Reads the selection. Changes the document. */
391
+ "object.shadeSmooth": {
392
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
393
+ pick?: Array<number>;
394
+ };
395
+ /** Shade Smooth by Angle. Shades the meshes of `objects` (names or ids; the selection without it) smooth, keeping edges sharper than `angle` degrees (30) sharp. Acts on `objects`. Reads the selection. Changes the document. */
396
+ "object.shadeSmoothByAngle": {
397
+ angle?: number; /** The objects; the selection when left out */
398
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
399
+ pick?: Array<number>;
400
+ };
401
+ /** Shade Flat. Shades the meshes of `objects` (names or ids; the selection without it) flat. Acts on `objects`. Reads the selection. Changes the document. */
402
+ "object.shadeFlat": {
403
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
404
+ pick?: Array<number>;
405
+ };
406
+ /** Join. Joins the selected meshes into the active one. Reads the selection. Changes the document. */
407
+ "object.join": Record<string, never>;
408
+ /** Set Active Camera. Makes camera `object` the scene's active camera for renders. Acts on `object`. Reads the selection. Changes the document. */
409
+ "object.setCamera": {
410
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
411
+ pick?: Array<number>;
412
+ };
413
+ /** Look At. Rotates `object` so it points at `target` [x, y, z] (cameras and lights look along -Z). Acts on `object`. Reads the selection. Changes the document. */
414
+ "object.lookAt": {
415
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
416
+ pick?: Array<number>; /** The point to look at, in metres [x, y, z] */
417
+ target: Array<number>;
418
+ };
419
+ /** Toggle Edit Mode. Toggles the active mesh between object mode and edit mode. Reads the selection. */
420
+ "mode.toggle": Record<string, never>;
421
+ /** Set Mode. Sets object or edit mode for `object` (else the active object). Edit-mode mesh commands need `mode: "edit"` first. Acts on `object`. Reads the selection. */
422
+ "mode.set": {
423
+ mode: "object" | "edit"; /** The mesh to edit; the active one when left out */
424
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
425
+ pick?: Array<number>;
426
+ };
427
+ /** Select Mode. Sets edit mode's element selection to vertices, edges or faces. */
428
+ "mesh.selectMode": {
429
+ mode: "vertex" | "edge" | "face";
430
+ };
431
+ /** Vertex Select. Switches edit mode to vertex selection. */
432
+ "mesh.selectVertexMode": Record<string, never>;
433
+ /** Edge Select. Switches edit mode to edge selection. */
434
+ "mesh.selectEdgeMode": Record<string, never>;
435
+ /** Face Select. Switches edit mode to face selection. */
436
+ "mesh.selectFaceMode": Record<string, never>;
437
+ /** Select Elements. Selects vertices and/or faces of the edited mesh by index (or all), adding with `extend` or removing with `deselect`. */
438
+ "mesh.select": {
439
+ deselect?: boolean; /** Add to the selection instead of replacing it */
440
+ extend?: boolean; /** Face indices (selects their vertices) */
441
+ faces?: Array<number>; /** Vertex indices */
442
+ vertices?: Array<number>;
443
+ };
444
+ /** Extrude Faces. Extrudes the selected faces (or loose vertices and edges) along their normals by `distance`, plus `offset`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
445
+ "mesh.extrude": {
446
+ distance?: number; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
447
+ elements?: {
448
+ faces?: Array<number>;
449
+ object?: Json;
450
+ vertices?: Array<number>;
451
+ }; /** An extra offset in metres [x, y, z] */
452
+ offset?: Array<number>;
453
+ };
454
+ /** Inset Faces. Insets the selected faces by `thickness`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
455
+ "mesh.inset": {
456
+ elements?: {
457
+ faces?: Array<number>;
458
+ object?: Json;
459
+ vertices?: Array<number>;
460
+ }; /** How far in, in metres (0.1) */
461
+ thickness?: number;
462
+ };
463
+ /** Bevel Edges. Bevels the selected edges with `width` and `segments`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
464
+ "mesh.bevel": {
465
+ elements?: {
466
+ faces?: Array<number>;
467
+ object?: Json;
468
+ vertices?: Array<number>;
469
+ }; /** Segments across the bevel (1) */
470
+ segments?: number; /** The bevel's width in metres (0.1) */
471
+ width?: number;
472
+ };
473
+ /** Subdivide. Subdivides the selected edges and faces, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
474
+ "mesh.subdivide": {
475
+ elements?: {
476
+ faces?: Array<number>;
477
+ object?: Json;
478
+ vertices?: Array<number>;
479
+ };
480
+ };
481
+ /** Loop Cut. Adds `cuts` edge loops across the ring of edge `edge` [vertex, vertex] at `factor` in the edited mesh. Changes the document. */
482
+ "mesh.loopCut": {
483
+ cuts?: number; /** The edge the cut crosses, as [vertex, vertex] */
484
+ edge: Array<number>; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
485
+ elements?: {
486
+ faces?: Array<number>;
487
+ object?: Json;
488
+ vertices?: Array<number>;
489
+ }; /** Where a single loop goes between the sides, 0 to 1 (0.5) */
490
+ factor?: number;
491
+ };
492
+ /** Merge at Center. Merges the selected vertices at their centre, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
493
+ "mesh.merge": {
494
+ elements?: {
495
+ faces?: Array<number>;
496
+ object?: Json;
497
+ vertices?: Array<number>;
498
+ };
499
+ };
500
+ /** Delete Faces. Deletes the selected faces, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
501
+ "mesh.deleteFaces": {
502
+ elements?: {
503
+ faces?: Array<number>;
504
+ object?: Json;
505
+ vertices?: Array<number>;
506
+ };
507
+ };
508
+ /** Delete Vertices. Deletes the selected vertices and the faces using them, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
509
+ "mesh.deleteVertices": {
510
+ elements?: {
511
+ faces?: Array<number>;
512
+ object?: Json;
513
+ vertices?: Array<number>;
514
+ };
515
+ };
516
+ /** Fill Face. Makes a face from the vertices in `vertices` (else the selection) of the edited mesh. Changes the document. */
517
+ "mesh.fill": {
518
+ elements?: {
519
+ faces?: Array<number>;
520
+ object?: Json;
521
+ vertices?: Array<number>;
522
+ }; /** The face's corners in order; the selection when left out */
523
+ vertices?: Array<number>;
524
+ };
525
+ /** Flip Normals. Flips the normals of the selected faces, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
526
+ "mesh.flip": {
527
+ elements?: {
528
+ faces?: Array<number>;
529
+ object?: Json;
530
+ vertices?: Array<number>;
531
+ };
532
+ };
533
+ /** Recalculate Outside. Recalculates the normals of `objects` (names or ids; the selection without it) so they point outside. Acts on `objects`. Reads the selection. Changes the document. */
534
+ "mesh.recalculateNormals": {
535
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
536
+ pick?: Array<number>;
537
+ };
538
+ /** Move Elements. Moves the selected elements by `offset`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
539
+ "mesh.translate": {
540
+ elements?: {
541
+ faces?: Array<number>;
542
+ object?: Json;
543
+ vertices?: Array<number>;
544
+ }; /** How far in the object's own axes, in metres [x, y, z] */
545
+ offset: Array<number>;
546
+ };
547
+ /** Scale Elements. Scales the selected elements by `factor` about `pivot`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
548
+ "mesh.scale": {
549
+ elements?: {
550
+ faces?: Array<number>;
551
+ object?: Json;
552
+ vertices?: Array<number>;
553
+ }; /** A number, or [x, y, z] */
554
+ factor: Json; /** The point to scale about; the selection's centre when left out [x, y, z] */
555
+ pivot?: Array<number>;
556
+ };
557
+ /** Set Geometry. Replaces the mesh of `object` with `positions` and `faces` (vertex index lists), optionally smooth-shaded. Acts on `object`. Reads the selection. Changes the document. */
558
+ "mesh.setGeometry": {
559
+ faces: Array<Json>; /** The mesh object; the active one when left out */
560
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
561
+ pick?: Array<number>; /** Vertex positions as [x, y, z], in the object's own axes */
562
+ positions: Array<Json>; /** Smooth shading */
563
+ smooth?: boolean;
564
+ };
565
+ /** Add Modifier. Adds a modifier (subdivision, mirror, array, bevel, solidify, boolean, displace, ...) with its settings to `object`. Acts on `object`. Reads the selection. Changes the document. */
566
+ "modifier.add": {
567
+ angle?: number; /** bevel: edges sharper than this many degrees are bevelled; decimate planar: faces flatter than this join (5) */
568
+ angleLimit?: number; /** mirror: [x, y, z] axes to mirror across */
569
+ axes?: Array<boolean>; /** screw and simpleDeform: the local axis */
570
+ axis?: "x" | "y" | "z"; /** array: an extra offset in metres [x, y, z] */
571
+ constantOffset?: Array<number>; /** displace: where the image is looked up (local: -1 to 1 in object axes covers it once) */
572
+ coordinates?: "local" | "global" | "uv"; /** array: the number of copies */
573
+ count?: number; /** displace: where to push */
574
+ direction?: "normal" | "x" | "y" | "z"; /** weld: the distance that joins vertices */
575
+ distance?: number; /** armature: vertices in no bone's group follow the bones whose envelopes reach them (false) */
576
+ envelopes?: boolean; /** smooth: how far each vertex moves towards its neighbours */
577
+ factor?: number; /** geometryNodes: the node group's id (nodes.newGroup makes one) */
578
+ group?: number; /** displace: an image's hash (from image.add) whose brightness pushes; null for none */
579
+ image?: string; /** geometryNodes: the group's inputs by name */
580
+ inputs?: {
581
+ [key: string]: Json;
582
+ }; /** armature: use one minus that group's weights */
583
+ invertVertexGroup?: boolean; /** decimate unsubdivide: half steps of subdivision to undo, 0 to 16 */
584
+ iterations?: number; /** subdivision: levels, 0 to 6; multires: the level shown (at most the mesh's levels) */
585
+ levels?: number; /** simpleDeform: [low, high], the share of the range that deforms, 0 to 1 */
586
+ limits?: Array<number>; /** mirror and array: join vertices where copies meet */
587
+ merge?: boolean; /** mirror: the distance that joins vertices on the plane */
588
+ mergeThreshold?: number; /** displace: the value that does not move (0.5) */
589
+ midLevel?: number; /** simpleDeform: what it does; decimate: collapse, unsubdivide, or planar */
590
+ mode?: "twist" | "bend" | "taper" | "stretch" | "collapse" | "unsubdivide" | "planar"; /** armature: deform what the Armature modifier above got and mix over its result by the group */
591
+ multiModifier?: boolean; /** shrinkwrap project: cast against it (false) */
592
+ negative?: boolean; /** displace: noise feature size in metres; 0 pushes every vertex alike */
593
+ noiseScale?: number; /** The mesh object; the active one when left out */
594
+ object?: Json; /** solidify: -1 grows inwards, 1 outwards; wireframe: -1 to 1; shrinkwrap: metres kept from the surface */
595
+ offset?: number; /** boolean and shrinkwrap: the other mesh object; lattice: the lattice object; armature: the armature */
596
+ operand?: Json; /** boolean: what to keep */
597
+ operation?: "difference" | "union" | "intersect"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
598
+ pick?: Array<number>; /** shrinkwrap project: cast along the vertex normal (true) */
599
+ positive?: boolean; /** armature: blend the bones as dual quaternions, so joints keep their volume (false) */
600
+ preserveVolume?: boolean; /** decimate collapse: the share of triangles to keep, 0 to 1 */
601
+ ratio?: number; /** array: the offset between copies as a fraction of the mesh size [x, y, z] */
602
+ relativeOffset?: Array<number>; /** solidify: close the open edges */
603
+ rim?: boolean; /** screw: how far along the axis one turn moves, metres */
604
+ screwOffset?: number; /** multires: the level sculpt mode shows and sculpts */
605
+ sculptLevels?: number; /** bevel: segments across each bevel (1 is a flat chamfer) */
606
+ segments?: number; /** screw: steps around one turn */
607
+ steps?: number; /** displace: how far, in metres, at full value; lattice: how much of the bend (1) */
608
+ strength?: number; /** solidify: the shell's thickness in metres */
609
+ thickness?: number; /** The modifier */
610
+ type: "mirror" | "array" | "subdivision" | "solidify" | "triangulate" | "weld" | "smooth" | "bevel" | "boolean" | "screw" | "displace" | "decimate" | "wireframe" | "simpleDeform" | "cast" | "multires" | "shrinkwrap" | "lattice" | "geometryNodes"; /** armature: a group whose weights say how much of the deformation each vertex takes; null for all */
611
+ vertexGroup?: string; /** armature: vertices follow the bones of their groups (true) */
612
+ vertexGroups?: boolean; /** bevel: the bevel's width in metres */
613
+ width?: number; /** shrinkwrap: where vertices go */
614
+ wrapMethod?: "nearestSurface" | "project" | "nearestVertex";
615
+ };
616
+ /** Change Modifier. Changes the settings of modifier `index` or `name` on `object`. Acts on `object`. Reads the selection. Changes the document. */
617
+ "modifier.set": {
618
+ angle?: number; /** bevel: edges sharper than this many degrees are bevelled; decimate planar: faces flatter than this join (5) */
619
+ angleLimit?: number; /** mirror: [x, y, z] axes to mirror across */
620
+ axes?: Array<boolean>; /** screw and simpleDeform: the local axis */
621
+ axis?: "x" | "y" | "z"; /** array: an extra offset in metres [x, y, z] */
622
+ constantOffset?: Array<number>; /** displace: where the image is looked up (local: -1 to 1 in object axes covers it once) */
623
+ coordinates?: "local" | "global" | "uv"; /** array: the number of copies */
624
+ count?: number; /** displace: where to push */
625
+ direction?: "normal" | "x" | "y" | "z"; /** weld: the distance that joins vertices */
626
+ distance?: number; /** Shown in the viewport and renders */
627
+ enabled?: boolean; /** armature: vertices in no bone's group follow the bones whose envelopes reach them (false) */
628
+ envelopes?: boolean; /** smooth: how far each vertex moves towards its neighbours */
629
+ factor?: number; /** geometryNodes: the node group's id (nodes.newGroup makes one) */
630
+ group?: number; /** displace: an image's hash (from image.add) whose brightness pushes; null for none */
631
+ image?: string; /** The modifier's position in the stack, from 0 */
632
+ index?: number; /** geometryNodes: the group's inputs by name */
633
+ inputs?: {
634
+ [key: string]: Json;
635
+ }; /** armature: use one minus that group's weights */
636
+ invertVertexGroup?: boolean; /** decimate unsubdivide: half steps of subdivision to undo, 0 to 16 */
637
+ iterations?: number; /** subdivision: levels, 0 to 6; multires: the level shown (at most the mesh's levels) */
638
+ levels?: number; /** simpleDeform: [low, high], the share of the range that deforms, 0 to 1 */
639
+ limits?: Array<number>; /** mirror and array: join vertices where copies meet */
640
+ merge?: boolean; /** mirror: the distance that joins vertices on the plane */
641
+ mergeThreshold?: number; /** displace: the value that does not move (0.5) */
642
+ midLevel?: number; /** simpleDeform: what it does; decimate: collapse, unsubdivide, or planar */
643
+ mode?: "twist" | "bend" | "taper" | "stretch" | "collapse" | "unsubdivide" | "planar"; /** armature: deform what the Armature modifier above got and mix over its result by the group */
644
+ multiModifier?: boolean; /** The modifier's name (instead of index) */
645
+ name?: string; /** shrinkwrap project: cast against it (false) */
646
+ negative?: boolean; /** displace: noise feature size in metres; 0 pushes every vertex alike */
647
+ noiseScale?: number; /** The mesh object; the active one when left out */
648
+ object?: Json; /** solidify: -1 grows inwards, 1 outwards; wireframe: -1 to 1; shrinkwrap: metres kept from the surface */
649
+ offset?: number; /** boolean and shrinkwrap: the other mesh object; lattice: the lattice object; armature: the armature */
650
+ operand?: Json; /** boolean: what to keep */
651
+ operation?: "difference" | "union" | "intersect"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
652
+ pick?: Array<number>; /** shrinkwrap project: cast along the vertex normal (true) */
653
+ positive?: boolean; /** armature: blend the bones as dual quaternions, so joints keep their volume (false) */
654
+ preserveVolume?: boolean; /** decimate collapse: the share of triangles to keep, 0 to 1 */
655
+ ratio?: number; /** array: the offset between copies as a fraction of the mesh size [x, y, z] */
656
+ relativeOffset?: Array<number>; /** A new name */
657
+ rename?: string; /** solidify: close the open edges */
658
+ rim?: boolean; /** screw: how far along the axis one turn moves, metres */
659
+ screwOffset?: number; /** multires: the level sculpt mode shows and sculpts */
660
+ sculptLevels?: number; /** bevel: segments across each bevel (1 is a flat chamfer) */
661
+ segments?: number; /** screw: steps around one turn */
662
+ steps?: number; /** displace: how far, in metres, at full value; lattice: how much of the bend (1) */
663
+ strength?: number; /** solidify: the shell's thickness in metres */
664
+ thickness?: number; /** armature: a group whose weights say how much of the deformation each vertex takes; null for all */
665
+ vertexGroup?: string; /** armature: vertices follow the bones of their groups (true) */
666
+ vertexGroups?: boolean; /** bevel: the bevel's width in metres */
667
+ width?: number; /** shrinkwrap: where vertices go */
668
+ wrapMethod?: "nearestSurface" | "project" | "nearestVertex";
669
+ };
670
+ /** Remove Modifier. Removes modifier `index` or `name` from `object`. Acts on `object`. Reads the selection. Changes the document. */
671
+ "modifier.remove": {
672
+ index?: number; /** The modifier's name (instead of index) */
673
+ name?: string; /** The mesh object; the active one when left out */
674
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
675
+ pick?: Array<number>;
676
+ };
677
+ /** Apply Modifier. Applies modifier `index` or `name` to `object`'s mesh and removes it. Acts on `object`. Reads the selection. Changes the document. */
678
+ "modifier.apply": {
679
+ index?: number; /** The modifier's name (instead of index) */
680
+ name?: string; /** The mesh object; the active one when left out */
681
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
682
+ pick?: Array<number>;
683
+ };
684
+ /** Move Modifier. Moves modifier `index` or `name` to position `to` in `object`'s stack. Acts on `object`. Reads the selection. Changes the document. */
685
+ "modifier.move": {
686
+ index?: number; /** The modifier's name (instead of index) */
687
+ name?: string; /** The mesh object; the active one when left out */
688
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
689
+ pick?: Array<number>; /** The new position, from 0 */
690
+ to: number;
691
+ };
692
+ /** New Material. Creates a material with base color, metallic and roughness and answers its id. It is given to the selected objects (in Edit mode, to the object edited) unless `assign: false`; the answer lists them. Reads the selection. Changes the document. */
693
+ "material.new": {
694
+ assign?: boolean; /** Base colour */
695
+ baseColor?: Json; /** 0 to 1 */
696
+ metallic?: number; /** The material's name */
697
+ name?: string; /** 0 to 1 */
698
+ roughness?: number;
699
+ };
700
+ /** Change Material. Changes material `material` (name or id): base color, metallic, roughness, emission, alpha, transmission and more. Changes the document. */
701
+ "material.set": {
702
+ alphaCutoff?: number; /** How the base colour's alpha is used */
703
+ alphaMode?: "opaque" | "clip" | "blend"; /** Base colour */
704
+ baseColor?: Json; /** Emission colour */
705
+ emission?: Json; /** Emission strength */
706
+ emissionStrength?: number; /** Index of refraction (1.5) */
707
+ ior?: number; /** The material's id or name */
708
+ material: Json; /** 0 to 1 */
709
+ metallic?: number; /** A new name */
710
+ name?: string; /** How strongly the normal map bends the surface (1) */
711
+ normalStrength?: number; /** 0 to 1 */
712
+ roughness?: number; /** A shader group (id or name) giving the surface and volume in path-traced renders, or null to let go of it */
713
+ shader?: Json; /** How much light passes through, 0 to 1 (glass at 1) */
714
+ transmission?: number;
715
+ };
716
+ /** Assign Material. Assigns material `material` to `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
717
+ "material.assign": {
718
+ material: Json; /** The objects; the selection when left out */
719
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
720
+ pick?: Array<number>;
721
+ };
722
+ /** Remove Material. Removes the materials from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
723
+ "material.clear": {
724
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
725
+ pick?: Array<number>;
726
+ };
727
+ /** Delete Material. Deletes material `material`; refused while objects use it unless `force`. Changes the document. */
728
+ "material.delete": {
729
+ force?: boolean; /** The material's id or name */
730
+ material: Json;
731
+ };
732
+ /** Light Settings. Changes light `object` (else the selected light): kind, color, power, radius, spot size. Acts on `object`. Reads the selection. Changes the document. */
733
+ "light.set": {
734
+ color?: Json; /** The kind of light */
735
+ kind?: "point" | "sun" | "spot" | "area"; /** The light; the active object when left out */
736
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
737
+ pick?: Array<number>; /** Watts (W/m? for a sun) */
738
+ power?: number; /** Soft shadow radius in metres */
739
+ radius?: number; /** Spot cone angle in degrees */
740
+ spotSize?: number;
741
+ };
742
+ /** Camera Settings. Changes camera `object`: lens, clipping, sensor width (`sensor`), `sensorHeight` (1?200 mm), `sensorFit` (auto, horizontal, vertical), depth of field and aperture blades. Auto fits sensor width to the longer render dimension; Horizontal holds width; Vertical holds sensor height. Orthographic scale follows the same fitted dimension. Square render pixels only. Acts on `object`. Reads the selection. Changes the document. */
743
+ "camera.set": {
744
+ bladeRotation?: number; /** The opening's blades: 0 for round (the default), 3 to 64 for a polygon */
745
+ blades?: number; /** Farthest distance drawn, metres */
746
+ clipEnd?: number; /** Nearest distance drawn, metres */
747
+ clipStart?: number; /** Blur what is out of focus in path-traced renders */
748
+ depthOfField?: boolean; /** Aperture as an f-number (2.8); smaller blurs more */
749
+ fStop?: number; /** Metres in front of the camera that are sharp (10) */
750
+ focusDistance?: number; /** An object to keep in focus (an id or a name), or null for the distance */
751
+ focusObject?: Json; /** Focal length in millimetres */
752
+ lens?: number; /** The camera; the active object when left out */
753
+ object?: Json; /** Span along the fitted frame dimension, metres */
754
+ orthoScale?: number; /** Orthographic instead of perspective */
755
+ orthographic?: boolean; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
756
+ pick?: Array<number>; /** The opening's height over its width for anamorphic bokeh (1); above 1 narrows it */
757
+ ratio?: number; /** Sensor width in millimetres, used by Auto and Horizontal */
758
+ sensor?: number; /** Frame dimension held by the sensor or orthographic scale; Auto holds the longer dimension */
759
+ sensorFit?: "auto" | "horizontal" | "vertical"; /** Sensor height in millimetres, 1 to 200; used by Vertical */
760
+ sensorHeight?: number;
761
+ };
762
+ /** World Settings. Sets the world background color and strength, rotation and volume. Changes the document. */
763
+ "world.set": {
764
+ color?: Json; /** Degrees the world image is turned about the up axis */
765
+ rotation?: number; /** How strongly it (or its image) lights the scene */
766
+ strength?: number; /** A shader group (id or name) whose Volume fills the world in path-traced renders, or null for none */
767
+ volume?: Json;
768
+ };
769
+ /** Render Settings. Sets render width and height, motion blur and shutter, ambient occlusion (on, distance, strength), and colour management (view transform, look, exposure). Changes the document. */
770
+ "render.set": {
771
+ ao?: boolean; /** How far around a point surfaces occlude it, in metres (up to 1000); null works it out from the scene's size (6 % of its diagonal, 0.05 to 2 m) */
772
+ aoDistance?: Json; /** How much of the occlusion shows, 0 to 4 (1) */
773
+ aoStrength?: number; /** Stops of exposure before the view transform, -32 to 32 (0) */
774
+ exposure?: number; /** Pixels */
775
+ height?: number; /** A grade after the view transform (none) */
776
+ look?: "none" | "punchy" | "greyscale" | "high-contrast" | "low-contrast"; /** Blur what moves while the shutter is open, in path-traced renders */
777
+ motionBlur?: boolean; /** How long the shutter is open, in frames (0.5) */
778
+ shutter?: number; /** Where the shutter opens around the frame (center) */
779
+ shutterPosition?: "center" | "start" | "end"; /** Colour management's view transform (standard): standard clips at white, agx and khronos-pbr-neutral roll highlights off */
780
+ view?: "standard" | "agx" | "khronos-pbr-neutral"; /** Pixels */
781
+ width?: number;
782
+ };
783
+ /** Render Image. Renders the active camera's view (at `frame`, with `samples`) and answers it as a base64 PNG with its size. Does not change the scene. Reads the time. */
784
+ "render.image": {
785
+ frame?: number; /** Samples per pixel side, 1 to 4 (2) */
786
+ samples?: number;
787
+ };
788
+ /** Export. Exports the scene (or `selectedOnly`) as glTF/GLB, OBJ, STL, FBX, USD (usda, usdc, usdz) or a PNG render and answers the file as base64. Does not change the scene. Reads the selection, time. */
789
+ "file.export": {
790
+ format: "glb" | "gltf" | "obj" | "stl" | "fbx" | "usda" | "usdc" | "usdz" | "png"; /** png: the frame to render (the current frame when left out) */
791
+ frame?: number; /** png: samples per pixel side, 1 to 4 (2) */
792
+ samples?: number; /** Only the selected objects */
793
+ selectedOnly?: boolean;
794
+ };
795
+ /** Import. Imports a glTF/GLB, OBJ, STL, FBX, USD or .blend file from the workspace (`path`) or base64 into the scene. Reads the time. Changes the document. */
796
+ "file.import": {
797
+ base64?: string; /** The format of base64 bytes */
798
+ format?: "glb" | "gltf" | "obj" | "stl" | "fbx" | "usd" | "usda" | "usdc" | "usdz" | "blend"; /** A .glb, .gltf, .obj, .stl, .fbx, .usd, .usda, .usdc, .usdz, or .blend file, relative to this scene's folder */
799
+ path?: Json;
800
+ };
801
+ /** Viewport Shading. Sets the viewport shading to wireframe, solid, material preview or rendered. */
802
+ "view.shading": {
803
+ mode: "wireframe" | "solid" | "material" | "rendered";
804
+ };
805
+ /** Wireframe. Sets the viewport shading to wireframe. */
806
+ "view.wireframe": Record<string, never>;
807
+ /** Solid. Sets the viewport shading to solid. */
808
+ "view.solid": Record<string, never>;
809
+ /** Material Preview. Sets the viewport shading to material preview. */
810
+ "view.material": Record<string, never>;
811
+ /** Rendered. Shows progressive path tracing of the viewport with scene lights, materials and editor overlays. */
812
+ "view.rendered": Record<string, never>;
813
+ /** Continue Rendered Viewport. Advances the rendered viewport in bounded worker steps; a headless caller can wait for the completed preview. Sampling never changes the document or undo history. Reads the selection. */
814
+ "view.renderedStep": {
815
+ budgetMs?: number; /** Smooth the remaining noise away once the preview is done (false) */
816
+ denoise?: boolean; /** The preview's longest side in pixels, 64 to 4096 (512, so a live view stays quick); the viewport's size at most */
817
+ maxSide?: number; /** Samples per preview pixel, 1 to 256 (32); changing this retains the compiled scene */
818
+ samples?: number; /** Finish the preview before answering, for headless callers (false) */
819
+ wait?: boolean;
820
+ };
821
+ /** Front. Looks at the scene from the front. */
822
+ "view.front": Record<string, never>;
823
+ /** Right. Looks at the scene from the right. */
824
+ "view.right": Record<string, never>;
825
+ /** Top. Looks at the scene from the top. */
826
+ "view.top": Record<string, never>;
827
+ /** Camera. Looks through the active camera. */
828
+ "view.camera": Record<string, never>;
829
+ /** Perspective/Orthographic. Toggles the viewport between perspective and orthographic. */
830
+ "view.perspective": Record<string, never>;
831
+ /** Frame All. Frames every object in the viewport. */
832
+ "view.frameAll": Record<string, never>;
833
+ /** Frame Selected. Frames the selected objects in the viewport. Reads the selection. */
834
+ "view.frameSelected": Record<string, never>;
835
+ /** Grid Floor. Shows or hides the grid floor in the viewport. */
836
+ "view.grid": {
837
+ on?: boolean;
838
+ };
839
+ /** Overlays. Shows or hides every overlay: the grid, lights, cameras, empties, origins, outlines and edit marks, so the viewport (a rendered camera view too) shows only the scene. */
840
+ "view.overlays": {
841
+ on?: boolean;
842
+ };
843
+ /** Orbit. Orbits the viewport by `turn` and `tilt` degrees. */
844
+ "view.orbit": {
845
+ tilt?: number; /** Degrees about the up axis */
846
+ turn?: number;
847
+ };
848
+ /** Pan. Pans the viewport by `right` and `up`. */
849
+ "view.pan": {
850
+ right?: number; /** Fraction of the view's height */
851
+ up?: number;
852
+ };
853
+ /** Zoom. Zooms the viewport by `factor` (above 1 zooms in). */
854
+ "view.zoom": {
855
+ factor: number;
856
+ };
857
+ /** Set View. Sets the viewport's target, distance, turn, tilt and projection at once. */
858
+ "view.set": {
859
+ distance?: number; /** Perspective or orthographic */
860
+ perspective?: boolean; /** The point the view turns around [x, y, z] */
861
+ target?: Array<number>; /** Degrees: 0 looks down, 90 level */
862
+ tilt?: number; /** Degrees about the up axis */
863
+ turn?: number;
864
+ };
865
+ /** Viewport Color Scheme. The editor's command for the host's color scheme: the viewport's background, grid and frame shade follow it; the scene, the file and renders do not change. */
866
+ "view.scheme": {
867
+ scheme: "light" | "dark";
868
+ };
869
+ /** Resize View. Sets the viewport size in pixels, which previews and the camera view use. */
870
+ "view.resize": {
871
+ height: number; /** Pixels */
872
+ width: number;
873
+ };
874
+ /** Extrude Individual Faces. Extrudes each selected face separately along its own normal by `distance`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
875
+ "mesh.extrudeIndividual": {
876
+ distance?: number; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
877
+ elements?: {
878
+ faces?: Array<number>;
879
+ object?: Json;
880
+ vertices?: Array<number>;
881
+ };
882
+ };
883
+ /** Dissolve Vertices. Dissolves the selected vertices, merging the faces around them, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
884
+ "mesh.dissolveVertices": {
885
+ elements?: {
886
+ faces?: Array<number>;
887
+ object?: Json;
888
+ vertices?: Array<number>;
889
+ };
890
+ };
891
+ /** Dissolve Edges. Dissolves the selected edges, merging the faces on both sides, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
892
+ "mesh.dissolveEdges": {
893
+ elements?: {
894
+ faces?: Array<number>;
895
+ object?: Json;
896
+ vertices?: Array<number>;
897
+ };
898
+ };
899
+ /** Dissolve Faces. Dissolves the selected faces into one face, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
900
+ "mesh.dissolveFaces": {
901
+ elements?: {
902
+ faces?: Array<number>;
903
+ object?: Json;
904
+ vertices?: Array<number>;
905
+ };
906
+ };
907
+ /** Bridge Edge Loops. Bridges two selected edge loops with faces, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
908
+ "mesh.bridge": {
909
+ elements?: {
910
+ faces?: Array<number>;
911
+ object?: Json;
912
+ vertices?: Array<number>;
913
+ };
914
+ };
915
+ /** Bisect. Cuts the whole edited mesh, whatever is selected, along the plane through `point` (the selection's centre when left out) with `normal`, optionally filling the cut and clearing one side. Changes the document. */
916
+ "mesh.bisect": {
917
+ clearInner?: boolean; /** Delete what lies in front of the plane */
918
+ clearOuter?: boolean; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
919
+ elements?: {
920
+ faces?: Array<number>;
921
+ object?: Json;
922
+ vertices?: Array<number>;
923
+ }; /** Close the cut with a face (with clearing) */
924
+ fill?: boolean; /** The plane's normal, in the object's own axes ([0, 0, 1]) [x, y, z] */
925
+ normal?: Array<number>; /** A point on the cutting plane, in the object's own axes (the selection's centre) [x, y, z] */
926
+ point?: Array<number>;
927
+ };
928
+ /** Separate Selection. Moves the selected elements of the edited mesh into a new object named `name`. Changes the document. */
929
+ "mesh.separate": {
930
+ elements?: {
931
+ faces?: Array<number>;
932
+ object?: Json;
933
+ vertices?: Array<number>;
934
+ }; /** The new object's name */
935
+ name?: string;
936
+ };
937
+ /** Symmetrize. Makes the whole edited mesh, whatever is selected, symmetric across `axis`, copying one side to the other. Changes the document. */
938
+ "mesh.symmetrize": {
939
+ axis?: "x" | "y" | "z"; /** Which side replaces the other (positive) */
940
+ direction?: "positive" | "negative"; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
941
+ elements?: {
942
+ faces?: Array<number>;
943
+ object?: Json;
944
+ vertices?: Array<number>;
945
+ };
946
+ };
947
+ /** Spin. Spins the selected elements `angle` degrees about `axis` through `center` in `steps`, making a lathe. Changes the document. */
948
+ "mesh.spin": {
949
+ angle?: number; /** The axis to sweep round ([0, 0, 1]) [x, y, z] */
950
+ axis?: Array<number>; /** A point on the axis, in the object's own axes (the origin) [x, y, z] */
951
+ center?: Array<number>; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
952
+ elements?: {
953
+ faces?: Array<number>;
954
+ object?: Json;
955
+ vertices?: Array<number>;
956
+ }; /** Steps (12) */
957
+ steps?: number;
958
+ };
959
+ /** Bevel Vertices. Bevels the selected vertices with `width`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
960
+ "mesh.bevelVertices": {
961
+ elements?: {
962
+ faces?: Array<number>;
963
+ object?: Json;
964
+ vertices?: Array<number>;
965
+ }; /** How far along each edge the cut is, metres (0.1) */
966
+ width?: number;
967
+ };
968
+ /** Rotate Elements. Rotates the selected elements by `angle` degrees about `axis` through `pivot`, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
969
+ "mesh.rotate": {
970
+ angle: number; /** The object's axis to turn round */
971
+ axis: "x" | "y" | "z"; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
972
+ elements?: {
973
+ faces?: Array<number>;
974
+ object?: Json;
975
+ vertices?: Array<number>;
976
+ }; /** The point to turn about; the selection's centre when left out [x, y, z] */
977
+ pivot?: Array<number>;
978
+ };
979
+ /** Proportional Editing. Turns proportional editing on or off and sets its falloff and radius; answers the setting. */
980
+ "mesh.proportional": {
981
+ connected?: boolean; /** How the pull fades with distance */
982
+ falloff?: "smooth" | "sphere" | "root" | "linear" | "sharp" | "constant"; /** On or off; toggles when left out */
983
+ on?: boolean; /** How far, in metres, unselected vertices follow (1) */
984
+ radius?: number;
985
+ };
986
+ /** Smart UV Project. Unwraps `objects` (names or ids; the selection without it) with smart UV project (by angle limit, with margin). Acts on `objects`. Reads the selection. Changes the document. */
987
+ "uv.smartProject": {
988
+ angleLimit?: number; /** Space between islands, as a fraction of the texture (0.02) */
989
+ margin?: number; /** The mesh objects, in object mode; the selection when left out */
990
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
991
+ pick?: Array<number>;
992
+ };
993
+ /** Cube Projection. Projects UVs of `objects` (names or ids; the selection without it) from a cube of `size`. Acts on `objects`. Reads the selection. Changes the document. */
994
+ "uv.cubeProject": {
995
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
996
+ pick?: Array<number>; /** Metres one repeat of the texture covers (2) */
997
+ size?: number;
998
+ };
999
+ /** Cylinder Projection. Projects UVs of `objects` (names or ids; the selection without it) from a cylinder. Acts on `objects`. Reads the selection. Changes the document. */
1000
+ "uv.cylinderProject": {
1001
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1002
+ pick?: Array<number>;
1003
+ };
1004
+ /** Sphere Projection. Projects UVs of `objects` (names or ids; the selection without it) from a sphere. Acts on `objects`. Reads the selection. Changes the document. */
1005
+ "uv.sphereProject": {
1006
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1007
+ pick?: Array<number>;
1008
+ };
1009
+ /** Planar Projection. Projects UVs of `objects` (names or ids; the selection without it) flat along `axis`. Acts on `objects`. Reads the selection. Changes the document. */
1010
+ "uv.planarProject": {
1011
+ axis?: "x" | "y" | "z"; /** The mesh objects, in object mode; the selection when left out */
1012
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1013
+ pick?: Array<number>; /** Metres one repeat of the texture covers (2) */
1014
+ size?: number;
1015
+ };
1016
+ /** Reset. Resets the UVs of `objects` (names or ids; the selection without it) so each face fills the whole UV square. Acts on `objects`. Reads the selection. Changes the document. */
1017
+ "uv.reset": {
1018
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1019
+ pick?: Array<number>;
1020
+ };
1021
+ /** Clear UVs. Removes the UV maps of `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
1022
+ "uv.clear": {
1023
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1024
+ pick?: Array<number>;
1025
+ };
1026
+ /** Set Material Image. Sets an image (workspace `path` or base64) as a texture slot (base color, normal, roughness, ...) of `material`, or clears it. Changes the document. */
1027
+ "material.setTexture": {
1028
+ base64?: string; /** Take the image out of the slot */
1029
+ clear?: boolean; /** The material's id or name */
1030
+ material: Json; /** The image's name, with base64 bytes */
1031
+ name?: string; /** A .png or .jpg file, relative to this scene's folder */
1032
+ path?: Json; /** The image slot (baseColor) */
1033
+ slot?: "baseColor" | "metallicRoughness" | "normal";
1034
+ };
1035
+ /** Set Displace Image. Sets the image a displace modifier reads (workspace path or base64), or clears it. Acts on `object`. Reads the selection. Changes the document. */
1036
+ "modifier.setImage": {
1037
+ base64?: string; /** Take the image off the modifier */
1038
+ clear?: boolean; /** The image's name, with base64 bytes */
1039
+ imageName?: string; /** The Displace modifier's position in the stack, from 0 */
1040
+ index?: number; /** The Displace modifier's name (instead of index) */
1041
+ name?: string; /** The object; the active one when left out */
1042
+ object?: Json; /** A .png or .jpg file, relative to this scene's folder */
1043
+ path?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1044
+ pick?: Array<number>;
1045
+ };
1046
+ /** World Image. Sets an environment image (workspace path or base64) as the world background, with rotation and strength, or clears it. Changes the document. */
1047
+ "world.setImage": {
1048
+ base64?: string; /** Remove the image: the world colour shows and lights again */
1049
+ clear?: boolean; /** The image's name, with base64 */
1050
+ name?: string; /** An equirectangular .hdr, .png, or .jpg, relative to this scene's folder */
1051
+ path?: Json; /** Degrees the image is turned about the up axis */
1052
+ rotation?: number; /** How strongly the world lights the scene */
1053
+ strength?: number;
1054
+ };
1055
+ /** Path Trace. Starts a path-traced render (bounces, samples, denoise) in steps; answers its progress. Continue with `render.trace.step`. */
1056
+ "render.trace.start": {
1057
+ bounces?: number; /** Trace nothing here: merge the sums of workers' shards (false) */
1058
+ collect?: boolean; /** Smooth the remaining noise away (false) */
1059
+ denoise?: boolean; /** The frame to render; the current frame when left out */
1060
+ frame?: number; /** Samples per pixel, 1 to 4096 (64) */
1061
+ samples?: number; /** Changes the noise pattern (0) */
1062
+ seed?: number; /** How often light may scatter in a volume before the path ends (0: each point in a volume is lit directly only) */
1063
+ volumeBounces?: number; /** Render to the end and answer the image at once (false) */
1064
+ wait?: boolean;
1065
+ };
1066
+ /** Continue Path Trace. Continues the path-traced render for `budgetMs` and answers its progress, with the picture so far when `preview`. */
1067
+ "render.trace.step": {
1068
+ budgetMs?: number; /** Answer the picture so far as a PNG (false) */
1069
+ preview?: boolean;
1070
+ };
1071
+ /** Path Traced Image. Answers the path-traced picture so far as a base64 PNG. */
1072
+ "render.trace.image": Record<string, never>;
1073
+ /** Cancel Path Trace. Cancels the path-traced render under way. */
1074
+ "render.trace.cancel": Record<string, never>;
1075
+ /** Mark Seam. Marks the selected edges as UV seams, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
1076
+ "mesh.markSeam": {
1077
+ elements?: {
1078
+ faces?: Array<number>;
1079
+ object?: Json;
1080
+ vertices?: Array<number>;
1081
+ };
1082
+ };
1083
+ /** Clear Seam. Clears UV seams from the selected edges, in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
1084
+ "mesh.clearSeam": {
1085
+ elements?: {
1086
+ faces?: Array<number>;
1087
+ object?: Json;
1088
+ vertices?: Array<number>;
1089
+ };
1090
+ };
1091
+ /** Unwrap. Unwraps the edited mesh's selected faces along their seams (angle-based, conformal, or minimumStretch SLIM) with `margin`; minimum stretch uses 1 to 100 `iterations` and keeps pins fixed. Changes the document. */
1092
+ "uv.unwrap": {
1093
+ elements?: {
1094
+ faces?: Array<number>;
1095
+ object?: Json;
1096
+ vertices?: Array<number>;
1097
+ }; /** Minimum stretch iterations, 1 to 100 (30) */
1098
+ iterations?: number; /** Space between islands, as a fraction of the square (0.02) */
1099
+ margin?: number; /** How islands are flattened (angleBased) */
1100
+ method?: "angleBased" | "conformal" | "minimumStretch";
1101
+ };
1102
+ /** Live Unwrap. Sets local UV live unwrap preferences (`on`, `method`, `iterations`) without changing the scene. Pinned UV transforms relax their islands in one undo step. */
1103
+ "uv.liveUnwrap": {
1104
+ iterations?: number; /** Live relaxation method */
1105
+ method?: "angleBased" | "conformal" | "minimumStretch"; /** Enable live relaxation while pinned UVs move */
1106
+ on?: boolean;
1107
+ };
1108
+ /** Preview UV Move. Answers a UV layout after a proposed `offset`, including live relaxation (`source` rejects a stale drag), without changing the scene, selection, history, or preferences. */
1109
+ "uv.preview": {
1110
+ offset: Array<number>; /** Optional UV layout source token; reject a stale drag without changing the scene */
1111
+ source?: string;
1112
+ };
1113
+ /** Stitch. Stitches the selected UV edges to their neighbours in the UV editor. Changes the document. */
1114
+ "uv.stitch": {
1115
+ elements?: {
1116
+ faces?: Array<number>;
1117
+ object?: Json;
1118
+ vertices?: Array<number>;
1119
+ };
1120
+ };
1121
+ /** Pin. Pins the selected UVs so unwrapping keeps them in place. Changes the document. */
1122
+ "uv.pin": {
1123
+ elements?: {
1124
+ faces?: Array<number>;
1125
+ object?: Json;
1126
+ vertices?: Array<number>;
1127
+ };
1128
+ };
1129
+ /** Unpin. Unpins the selected UVs. Changes the document. */
1130
+ "uv.unpin": {
1131
+ elements?: {
1132
+ faces?: Array<number>;
1133
+ object?: Json;
1134
+ vertices?: Array<number>;
1135
+ };
1136
+ };
1137
+ /** Move UVs. Moves the selected UVs by `offset`. Changes the document. */
1138
+ "uv.translate": {
1139
+ elements?: {
1140
+ faces?: Array<number>;
1141
+ object?: Json;
1142
+ vertices?: Array<number>;
1143
+ }; /** How far in UV units [u, v] */
1144
+ offset: Array<number>; /** Optional UV layout source token; reject a stale drag without changing the scene */
1145
+ source?: string;
1146
+ };
1147
+ /** Rotate UVs. Rotates the selected UVs by `angle` degrees about `pivot`. Changes the document. */
1148
+ "uv.rotate": {
1149
+ angle: number; /** Runs the command in this mesh's edit mode on these elements and puts the mode and the selections back afterwards, so no `mode.set` or `mesh.select` step is needed: `object` (the mesh, an id or a name), `vertices` and `faces` (indices from 0, as `mesh.select` takes them; every vertex when both are left out) */
1150
+ elements?: {
1151
+ faces?: Array<number>;
1152
+ object?: Json;
1153
+ vertices?: Array<number>;
1154
+ }; /** The point in UV space to turn or scale about [u, v]; the moved coordinates' centre when left out */
1155
+ pivot?: Array<number>; /** Optional UV layout source token; reject a stale drag without changing the scene */
1156
+ source?: string;
1157
+ };
1158
+ /** Scale UVs. Scales the selected UVs by `factor` about `pivot`. Changes the document. */
1159
+ "uv.scale": {
1160
+ elements?: {
1161
+ faces?: Array<number>;
1162
+ object?: Json;
1163
+ vertices?: Array<number>;
1164
+ }; /** A number, or [u, v] */
1165
+ factor: Json; /** The point in UV space to turn or scale about [u, v]; the moved coordinates' centre when left out */
1166
+ pivot?: Array<number>; /** Optional UV layout source token; reject a stale drag without changing the scene */
1167
+ source?: string;
1168
+ };
1169
+ /** UV Layout. Answers the edited mesh's UV layout (faces and their UV coordinates), all faces or the selected ones. */
1170
+ "uv.layout": {
1171
+ all?: boolean;
1172
+ };
1173
+ /** Knife. Cuts the edited mesh along `points` (screen-space path), through the whole mesh with `through`. Changes the document. */
1174
+ "mesh.knife": {
1175
+ elements?: {
1176
+ faces?: Array<number>;
1177
+ object?: Json;
1178
+ vertices?: Array<number>;
1179
+ }; /** The cut line: view pixels [x, y], or points in the world [x, y, z], at least two */
1180
+ points?: Array<Json>; /** Cut faces turned away from the view too (false) */
1181
+ through?: boolean;
1182
+ };
1183
+ /** Edge Slide. Slides the selected edges along their neighbours by `factor` (-1 to 1), in edit mode on the edited mesh's selected elements (`mode.set {mode: "edit"}` and `mesh.select` first). Changes the document. */
1184
+ "mesh.edgeSlide": {
1185
+ elements?: {
1186
+ faces?: Array<number>;
1187
+ object?: Json;
1188
+ vertices?: Array<number>;
1189
+ }; /** How far towards the next edge loop, -1 to 1 */
1190
+ factor: number;
1191
+ };
1192
+ /** Render Preview. Renders a preview of the scene as a PNG without changing anything: from `target.view` (`camera`, the scene's active camera; `front`, `back`, `left`, `right`, `top`, `bottom` or `persp`, framed to fit the scene or `objectId`) or `target.camera` (another camera, by id or name), at `target.time` (seconds from the first frame; 0 without it), in `target.pass` (`color`, `id` with a legend of object colours, `depth` or `wireframe`). `target.views` (2 to 6) draws one labelled sheet of views; `target.range` [from, to] with `target.frames` (2 to 12) one labelled sheet of times from one view. Without a target it answers four views (the camera or `persp`, then front, right and top). It never reads or moves the viewport, the current frame, the mode or the selection. Params: {target?: {view?: camera|front|back|left|right|top|bottom|persp, views?: [2-6 views or {camera}], camera?: id or name, time?: seconds, range?: [from, to] seconds, frames?: 2-12, pass?: color|id|depth|wireframe, objectId?: id or name, path?: "object:<id>"}, scale?: >0-2 (default 1), maxSize?: 16-4096 (default 1024)} ? {png (base64), mimeType, width, height, scale, frames: [{time, frame, label, view, camera?}], columns, rows, legend?: [{id, name, color}]}. */
1193
+ "file.render": {
1194
+ maxSize?: number; /** Picture pixels per render pixel (the scene's render size), above 0 and at most 2 (default 1). Each cell of a sheet is drawn at it. Reduced so the picture fits `maxSize`. */
1195
+ scale?: number; /** What to show. One view (`view` or `camera`) at one `time`; a sheet of `views`; or a sheet over `range` from one view. Without a target, four views at the first frame. */
1196
+ target?: {
1197
+ camera?: Json;
1198
+ frames?: number;
1199
+ objectId?: Json;
1200
+ pass?: "color" | "id" | "depth" | "wireframe";
1201
+ path?: string;
1202
+ range?: Array<number>;
1203
+ time?: number;
1204
+ view?: "camera" | "front" | "back" | "left" | "right" | "top" | "bottom" | "persp";
1205
+ views?: Array<Json>;
1206
+ };
1207
+ };
1208
+ /** Insert Keyframe. Inserts keyframes for `properties` (location, rotation, scale, ...) or a keying set of `objects` (names or ids; the selection without it) at `frame`. Reads the selection, time. Changes the document. */
1209
+ "anim.insertKey": {
1210
+ frame?: number; /** insertKey: key what this keying set names instead (the active one is used when no properties are given) */
1211
+ keyingSet?: string; /** The objects; the selection when left out */
1212
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1213
+ pick?: Array<number>; /** What to key: location, rotation, scale, hidden; power and color of a light; lens of a camera; baseColor of the object's material (location, rotation, and scale when left out) */
1214
+ properties?: Array<"location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor">;
1215
+ };
1216
+ /** Delete Keyframe. Deletes the keyframes for `properties` of `objects` (names or ids; the selection without it) at `frame`. Reads the selection, time. Changes the document. */
1217
+ "anim.deleteKey": {
1218
+ frame?: number; /** insertKey: key what this keying set names instead (the active one is used when no properties are given) */
1219
+ keyingSet?: string; /** The objects; the selection when left out */
1220
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1221
+ pick?: Array<number>; /** What to key: location, rotation, scale, hidden; power and color of a light; lens of a camera; baseColor of the object's material (location, rotation, and scale when left out) */
1222
+ properties?: Array<"location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor">;
1223
+ };
1224
+ /** Clear Keyframes. Clears every keyframe (or those of `properties`) of `objects` (names or ids; the selection without it). Reads the selection. Changes the document. */
1225
+ "anim.clear": {
1226
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1227
+ pick?: Array<number>; /** Only these properties (every animated one when left out) */
1228
+ properties?: Array<string>;
1229
+ };
1230
+ /** Interpolation. Sets the interpolation (constant, linear, bezier, ...) of keyframes of `objects` (names or ids; the selection without it) at `frame`. Reads the selection. Changes the document. */
1231
+ "anim.setInterpolation": {
1232
+ frame?: number; /** How the curve runs from a key to the next */
1233
+ interpolation: "bezier" | "linear" | "constant"; /** insertKey: key what this keying set names instead (the active one is used when no properties are given) */
1234
+ keyingSet?: string; /** The objects; the selection when left out */
1235
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1236
+ pick?: Array<number>; /** What to key: location, rotation, scale, hidden; power and color of a light; lens of a camera; baseColor of the object's material (location, rotation, and scale when left out) */
1237
+ properties?: Array<"location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor">;
1238
+ };
1239
+ /** Go to Frame. Goes to frame `frame` and answers it; the scene shows its animated state there. Reads the time. */
1240
+ "frame.set": {
1241
+ frame: number;
1242
+ };
1243
+ /** Next Frame. Goes to the next frame and answers it. Reads the time. */
1244
+ "frame.next": Record<string, never>;
1245
+ /** Previous Frame. Goes to the previous frame (wrapping to the end) and answers it. Reads the time. */
1246
+ "frame.previous": Record<string, never>;
1247
+ /** Jump to Start. Goes to the first frame of the range and answers it. Reads the time. */
1248
+ "frame.start": Record<string, never>;
1249
+ /** Jump to End. Goes to the last frame of the range and answers it. Reads the time. */
1250
+ "frame.end": Record<string, never>;
1251
+ /** Jump to Next Keyframe. Goes to the next keyframe of the selected objects and answers its frame. Reads the time. */
1252
+ "anim.nextKey": Record<string, never>;
1253
+ /** Jump to Previous Keyframe. Goes to the previous keyframe of the selected objects and answers its frame. Reads the time. */
1254
+ "anim.previousKey": Record<string, never>;
1255
+ /** Frame Range. Sets the animation's start and end frames and frames per second. Changes the document. */
1256
+ "frame.range": {
1257
+ end?: number; /** Frames per second */
1258
+ fps?: number; /** The first frame */
1259
+ start?: number;
1260
+ };
1261
+ /** Render Animation. Renders frames `start` to `end` (every `step`) and answers them as pictures. Does not change the scene. Reads the time. */
1262
+ "render.animation": {
1263
+ end?: number; /** Samples per pixel side, 1 to 4 (1) */
1264
+ samples?: number; /** The first frame (the range's start when left out) */
1265
+ start?: number; /** Render every nth frame (1) */
1266
+ step?: number;
1267
+ };
1268
+ /** Add Driver. Adds a driver to a property (of an object, bone or shape key) computed from `expression` and its variables. Acts on `object`. Reads the selection, time. Changes the document. */
1269
+ "driver.add": {
1270
+ bone?: string; /** scripted: Python-style arithmetic over the variables and `frame` (+ - * / // % **, comparisons, and, or, not, a if c else b, sin, cos, min, max, clamp, lerp, radians, ...); angles in radians */
1271
+ expression?: string; /** The component (x 0, y 1, z 2, alpha 3); every component when left out */
1272
+ index?: number; /** How the variables combine (scripted evaluates `expression`) */
1273
+ kind?: "average" | "sum" | "min" | "max" | "scripted"; /** The object (or the armature of `bone`, the mesh of `shapeKey`, the owner of the material); the active object when left out */
1274
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1275
+ pick?: Array<number>; /** The driven property (bone ones name `bone`, shapeKey names `shapeKey`, baseColor is the object's material's) */
1276
+ property: "location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor" | "boneLocation" | "boneRotation" | "boneScale" | "shapeKey"; /** The shape key of a shapeKey property */
1277
+ shapeKey?: string; /** The variables, replacing any: { name, type: singleProperty, object, property, index, bone?, shapeKey? } | { name, type: transform, object, bone?, channel: locationX..scaleZ or scaleAverage, space: world, transform, or local } | { name, type: distance or rotationDifference, a, aBone?, b, bBone? } */
1278
+ variables?: Array<{
1279
+ a?: Json;
1280
+ b?: Json;
1281
+ object?: Json;
1282
+ }>;
1283
+ };
1284
+ /** Change Driver. Changes a driver's expression or variables. Acts on `object`. Reads the selection, time. Changes the document. */
1285
+ "driver.set": {
1286
+ bone?: string; /** scripted: Python-style arithmetic over the variables and `frame` (+ - * / // % **, comparisons, and, or, not, a if c else b, sin, cos, min, max, clamp, lerp, radians, ...); angles in radians */
1287
+ expression?: string; /** The component (x 0, y 1, z 2, alpha 3); every component when left out */
1288
+ index?: number; /** How the variables combine (scripted evaluates `expression`) */
1289
+ kind?: "average" | "sum" | "min" | "max" | "scripted"; /** The object (or the armature of `bone`, the mesh of `shapeKey`, the owner of the material); the active object when left out */
1290
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1291
+ pick?: Array<number>; /** The driven property (bone ones name `bone`, shapeKey names `shapeKey`, baseColor is the object's material's) */
1292
+ property: "location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor" | "boneLocation" | "boneRotation" | "boneScale" | "shapeKey"; /** The shape key of a shapeKey property */
1293
+ shapeKey?: string; /** The variables, replacing any: { name, type: singleProperty, object, property, index, bone?, shapeKey? } | { name, type: transform, object, bone?, channel: locationX..scaleZ or scaleAverage, space: world, transform, or local } | { name, type: distance or rotationDifference, a, aBone?, b, bBone? } */
1294
+ variables?: Array<{
1295
+ a?: Json;
1296
+ b?: Json;
1297
+ object?: Json;
1298
+ }>;
1299
+ };
1300
+ /** Remove Driver. Removes the driver from a property. Acts on `object`. Reads the selection. Changes the document. */
1301
+ "driver.remove": {
1302
+ bone?: string; /** The component (x 0, y 1, z 2, alpha 3); every component when left out */
1303
+ index?: number; /** The object (or the armature of `bone`, the mesh of `shapeKey`, the owner of the material); the active object when left out */
1304
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1305
+ pick?: Array<number>; /** The driven property (bone ones name `bone`, shapeKey names `shapeKey`, baseColor is the object's material's) */
1306
+ property: "location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor" | "boneLocation" | "boneRotation" | "boneScale" | "shapeKey"; /** The shape key of a shapeKey property */
1307
+ shapeKey?: string;
1308
+ };
1309
+ /** Add Keying Set. Adds a keying set named `name` to the scene. Changes the document. */
1310
+ "keyingSet.new": {
1311
+ name?: string;
1312
+ };
1313
+ /** Remove Keying Set. Removes keying set `name`. Changes the document. */
1314
+ "keyingSet.remove": {
1315
+ name?: string;
1316
+ };
1317
+ /** Add to Keying Set. Adds properties of objects or bones to keying set `name`. Reads the selection. Changes the document. */
1318
+ "keyingSet.addPaths": {
1319
+ bones?: Array<string>; /** The keying set; the active one of the scene's own when left out */
1320
+ name?: string; /** The objects; the selection when left out */
1321
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1322
+ pick?: Array<number>; /** The properties (location, rotation, and scale when left out; bone ones with `bones`) */
1323
+ properties?: Array<"location" | "rotation" | "scale" | "hidden" | "power" | "color" | "lens" | "baseColor" | "boneLocation" | "boneRotation" | "boneScale" | "shapeKey">;
1324
+ };
1325
+ /** Remove from Keying Set. Removes path `index` from keying set `name`. Changes the document. */
1326
+ "keyingSet.removePath": {
1327
+ index: number; /** The keying set; the active one when left out */
1328
+ name?: string;
1329
+ };
1330
+ /** Active Keying Set. Makes keying set `name` the one `anim.insertKey` uses by default. Changes the document. */
1331
+ "keyingSet.setActive": {
1332
+ name?: string;
1333
+ };
1334
+ /** New Action. Creates an action named `name` and assigns it to `object`. Acts on `object`. Changes the document. */
1335
+ "action.new": {
1336
+ name?: string; /** An object whose keys (an armature's bones' too) the action takes; an empty action when left out */
1337
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1338
+ pick?: Array<number>;
1339
+ };
1340
+ /** Assign Action. Assigns action `action` to `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection, time. Changes the document. */
1341
+ "action.assign": {
1342
+ action: string; /** The objects; the selection when left out */
1343
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1344
+ pick?: Array<number>;
1345
+ };
1346
+ /** Remove Action. Deletes action `name` from the file; objects using it lose their animation. Changes the document. */
1347
+ "action.remove": {
1348
+ name: string;
1349
+ };
1350
+ /** Rename Action. Renames action `name` to `to`. Changes the document. */
1351
+ "action.rename": {
1352
+ name: string; /** The new name */
1353
+ to: string;
1354
+ };
1355
+ /** Push Down. Pushes `object`'s active action down into a new NLA strip. Acts on `object`. Reads the selection. Changes the document. */
1356
+ "nla.pushDown": {
1357
+ name?: string; /** The object; the active one when left out */
1358
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1359
+ pick?: Array<number>;
1360
+ };
1361
+ /** Add NLA Track. Adds an NLA track to `object` at `index`. Acts on `object`. Reads the selection. Changes the document. */
1362
+ "nla.addTrack": {
1363
+ index?: number; /** Its name (NlaTrack) */
1364
+ name?: string; /** The object; the active one when left out */
1365
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1366
+ pick?: Array<number>;
1367
+ };
1368
+ /** Remove NLA Track. Removes NLA track `track` from `object`. Acts on `object`. Reads the selection. Changes the document. */
1369
+ "nla.removeTrack": {
1370
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1371
+ pick?: Array<number>; /** The track, from 0 at the bottom */
1372
+ track: number;
1373
+ };
1374
+ /** NLA Track Settings. Changes NLA track `track`: name, mute, solo, position. Acts on `object`. Reads the selection. Changes the document. */
1375
+ "nla.setTrack": {
1376
+ moveTo?: number; /** Does nothing */
1377
+ muted?: boolean; /** Its name */
1378
+ name?: string; /** The object; the active one when left out */
1379
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1380
+ pick?: Array<number>; /** The only track evaluated (one at a time) */
1381
+ solo?: boolean; /** The track, from 0 at the bottom */
1382
+ track: number;
1383
+ };
1384
+ /** Add Action Strip. Adds a strip of action `action` to NLA track `track` of `object` at frame `start`. Acts on `object`. Reads the selection, time. Changes the document. */
1385
+ "nla.addStrip": {
1386
+ action: string; /** The object; the active one when left out */
1387
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1388
+ pick?: Array<number>; /** The frame it starts at; the current frame when left out */
1389
+ start?: number; /** The track; the top one when it has room, else a new one */
1390
+ track?: number;
1391
+ };
1392
+ /** Action Strip Settings. Changes NLA strip `strip` of track `track`: action range, blending, repeats, scale; a meta uses `start` and `end` to move or stretch its children. Transitions follow their neighbors. Acts on `object`. Reads the selection. Changes the document. */
1393
+ "nla.setStrip": {
1394
+ actionEnd?: number; /** The first action frame it plays */
1395
+ actionStart?: number; /** Blends in and out over the strips of the tracks below and above it that overlap it (switching it off clears the blends) */
1396
+ autoBlend?: boolean; /** How it mixes onto the tracks below */
1397
+ blend?: "replace" | "combine" | "add" | "subtract" | "multiply"; /** Frames its influence rises over at its start */
1398
+ blendIn?: number; /** Frames its influence falls over at its end */
1399
+ blendOut?: number; /** Meta strips: move or stretch the children together to this end frame */
1400
+ end?: number; /** Outside its frames: hold (both ways; only the first strip of a track holds backwards), holdForward, or nothing */
1401
+ extrapolation?: "hold" | "holdForward" | "nothing"; /** A fixed influence from 0 to 1 in place of the blends; null for the blends */
1402
+ influence?: number; /** Does nothing */
1403
+ muted?: boolean; /** The strip's name */
1404
+ name?: string; /** The object; the active one when left out */
1405
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1406
+ pick?: Array<number>; /** How many times it plays (0.01 or more) */
1407
+ repeat?: number; /** Plays backwards */
1408
+ reversed?: boolean; /** How many times slower it plays (0.0001 or more) */
1409
+ scale?: number; /** The scene frame it starts at */
1410
+ start?: number; /** The strip on the track, from 0 (frame order) */
1411
+ strip: number; /** Moves it to this track */
1412
+ toTrack?: number; /** The track, from 0 at the bottom */
1413
+ track: number;
1414
+ };
1415
+ /** Add Transition Strip. Adds a transition between strip `strip` and its next neighbor on track `track`, blending their endpoint evaluations across the gap. Acts on `object`. Reads the selection. Changes the document. */
1416
+ "nla.addTransition": {
1417
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1418
+ pick?: Array<number>; /** The strip on the track, from 0 (frame order) */
1419
+ strip: number; /** The track, from 0 at the bottom */
1420
+ track: number;
1421
+ };
1422
+ /** Make Meta Strip. Groups the contiguous strips `first` through `last` on `track` into one meta strip; its start and end move or stretch the children together. Acts on `object`. Reads the selection. Changes the document. */
1423
+ "nla.makeMeta": {
1424
+ first: number; /** Last strip in the contiguous group, inclusive */
1425
+ last: number; /** The object; the active one when left out */
1426
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1427
+ pick?: Array<number>; /** The track, from 0 at the bottom */
1428
+ track: number;
1429
+ };
1430
+ /** Dissolve Meta Strip. Ungroups meta strip `strip` on `track`, preserving the children's current timing and blending. Acts on `object`. Reads the selection. Changes the document. */
1431
+ "nla.dissolveMeta": {
1432
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1433
+ pick?: Array<number>; /** The strip on the track, from 0 (frame order) */
1434
+ strip: number; /** The track, from 0 at the bottom */
1435
+ track: number;
1436
+ };
1437
+ /** Remove Action Strip. Removes NLA strip `strip` from track `track` of `object`. Acts on `object`. Reads the selection. Changes the document. */
1438
+ "nla.removeStrip": {
1439
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1440
+ pick?: Array<number>; /** The strip on the track, from 0 (frame order) */
1441
+ strip: number; /** The track, from 0 at the bottom */
1442
+ track: number;
1443
+ };
1444
+ /** Active Action Blending. Sets how `object`'s active action blends over the NLA (blend mode, extrapolation, influence). Acts on `object`. Reads the selection. Changes the document. */
1445
+ "nla.setAction": {
1446
+ blend?: "replace" | "combine" | "add" | "subtract" | "multiply"; /** Outside their keyed frames */
1447
+ extrapolation?: "hold" | "holdForward" | "nothing"; /** Their influence, 0 to 1 */
1448
+ influence?: number; /** The object; the active one when left out */
1449
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1450
+ pick?: Array<number>;
1451
+ };
1452
+ /** Start Tweaking Strip Action. Starts tweaking the action of NLA strip `strip` so keyframe edits go into it. Acts on `object`. Reads the selection. Changes the document. */
1453
+ "nla.tweak": {
1454
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1455
+ pick?: Array<number>; /** The strip on the track, from 0 (frame order) */
1456
+ strip: number; /** The track, from 0 at the bottom */
1457
+ track: number; /** Evaluates the tracks above too (false: the lower stack only) */
1458
+ upperStack?: boolean;
1459
+ };
1460
+ /** Stop Tweaking Strip Action. Stops tweaking the NLA strip's action. Acts on `object`. Reads the selection. Changes the document. */
1461
+ "nla.tweakExit": {
1462
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1463
+ pick?: Array<number>;
1464
+ };
1465
+ /** Add F-Curve Modifier. Adds an F-curve modifier (cycles, noise, generator, ...) to an animated property's curve. Changes the document. */
1466
+ "graph.addModifier": {
1467
+ additive?: boolean; /** cycles: after the last key */
1468
+ after?: "none" | "repeat" | "repeatOffset" | "mirror"; /** cycles: cycles after (0 forever) */
1469
+ afterCount?: number; /** function */
1470
+ amplitude?: number; /** cycles: before the first key */
1471
+ before?: "none" | "repeat" | "repeatOffset" | "mirror"; /** cycles: cycles before (0 forever) */
1472
+ beforeCount?: number; /** noise: how it mixes in */
1473
+ blend?: "replace" | "add" | "subtract" | "multiply"; /** generator: the coefficients */
1474
+ coefficients?: Array<number>; /** noise: octaves beyond the first (0 to 32) */
1475
+ depth?: number; /** stepped: steps only up to this frame; null for always */
1476
+ end?: number; /** function: the function of amplitude ? f(phaseMultiplier ? frame + phaseOffset) + valueOffset */
1477
+ function?: "sin" | "cos" | "tan" | "sqrt" | "ln" | "sinc"; /** The component, from 0 (0) */
1478
+ index?: number; /** Scales its effect, 0 to 1; null for full */
1479
+ influence?: number; /** noise: frequency step between octaves */
1480
+ lacunarity?: number; /** envelope: the high end, above the reference */
1481
+ max?: number; /** limits: maximum evaluated frame; null disables */
1482
+ maxX?: Json; /** limits: maximum curve value; null disables */
1483
+ maxY?: Json; /** envelope: the low end, below the reference */
1484
+ min?: number; /** limits: minimum evaluated frame; null disables */
1485
+ minX?: Json; /** limits: minimum curve value; null disables */
1486
+ minY?: Json; /** generator: expanded (c0 + c1?x + ...) or factorized ((c0?x + c1)(c2?x + c3)...) */
1487
+ mode?: "expanded" | "factorized"; /** Does nothing (values of rotation channels are radians) */
1488
+ muted?: boolean; /** noise, stepped: frame offset */
1489
+ offset?: number; /** The bone or shape key, for their properties */
1490
+ path?: string; /** noise */
1491
+ phase?: number; /** function */
1492
+ phaseMultiplier?: number; /** function */
1493
+ phaseOffset?: number; /** envelope: control points { frame, min, max } in frame order */
1494
+ points?: Array<{
1495
+ [key: string]: Json;
1496
+ }>; /** The channel's property (location, boneRotation, shapeKey, ...) */
1497
+ property: string; /** Limits it to { start, end, blendIn, blendOut } frames; null for everywhere */
1498
+ range?: {
1499
+ [key: string]: Json;
1500
+ }; /** envelope: the reference value */
1501
+ reference?: number; /** noise: amplitude step between octaves */
1502
+ roughness?: number; /** noise: frames per noise feature */
1503
+ scale?: number; /** stepped: steps only from this frame; null for always */
1504
+ start?: number; /** stepped: frames each step holds */
1505
+ step?: number; /** noise */
1506
+ strength?: number; /** The channel's object (or material) id */
1507
+ target: number; /** The modifier */
1508
+ type: "generator" | "function" | "envelope" | "cycles" | "noise" | "stepped" | "limits"; /** function */
1509
+ valueOffset?: number;
1510
+ };
1511
+ /** F-Curve Modifier Settings. Changes an F-curve modifier's settings. Changes the document. */
1512
+ "graph.setModifier": {
1513
+ additive?: boolean; /** cycles: after the last key */
1514
+ after?: "none" | "repeat" | "repeatOffset" | "mirror"; /** cycles: cycles after (0 forever) */
1515
+ afterCount?: number; /** function */
1516
+ amplitude?: number; /** cycles: before the first key */
1517
+ before?: "none" | "repeat" | "repeatOffset" | "mirror"; /** cycles: cycles before (0 forever) */
1518
+ beforeCount?: number; /** noise: how it mixes in */
1519
+ blend?: "replace" | "add" | "subtract" | "multiply"; /** generator: the coefficients */
1520
+ coefficients?: Array<number>; /** noise: octaves beyond the first (0 to 32) */
1521
+ depth?: number; /** stepped: steps only up to this frame; null for always */
1522
+ end?: number; /** function: the function of amplitude ? f(phaseMultiplier ? frame + phaseOffset) + valueOffset */
1523
+ function?: "sin" | "cos" | "tan" | "sqrt" | "ln" | "sinc"; /** The component, from 0 (0) */
1524
+ index?: number; /** Scales its effect, 0 to 1; null for full */
1525
+ influence?: number; /** noise: frequency step between octaves */
1526
+ lacunarity?: number; /** envelope: the high end, above the reference */
1527
+ max?: number; /** limits: maximum evaluated frame; null disables */
1528
+ maxX?: Json; /** limits: maximum curve value; null disables */
1529
+ maxY?: Json; /** envelope: the low end, below the reference */
1530
+ min?: number; /** limits: minimum evaluated frame; null disables */
1531
+ minX?: Json; /** limits: minimum curve value; null disables */
1532
+ minY?: Json; /** generator: expanded (c0 + c1?x + ...) or factorized ((c0?x + c1)(c2?x + c3)...) */
1533
+ mode?: "expanded" | "factorized"; /** The modifier's place in the stack, from 0 */
1534
+ modifier: number; /** Moves it to this place in the stack */
1535
+ moveTo?: number; /** Does nothing (values of rotation channels are radians) */
1536
+ muted?: boolean; /** noise, stepped: frame offset */
1537
+ offset?: number; /** The bone or shape key, for their properties */
1538
+ path?: string; /** noise */
1539
+ phase?: number; /** function */
1540
+ phaseMultiplier?: number; /** function */
1541
+ phaseOffset?: number; /** envelope: control points { frame, min, max } in frame order */
1542
+ points?: Array<{
1543
+ [key: string]: Json;
1544
+ }>; /** The channel's property (location, boneRotation, shapeKey, ...) */
1545
+ property: string; /** Limits it to { start, end, blendIn, blendOut } frames; null for everywhere */
1546
+ range?: {
1547
+ [key: string]: Json;
1548
+ }; /** envelope: the reference value */
1549
+ reference?: number; /** noise: amplitude step between octaves */
1550
+ roughness?: number; /** noise: frames per noise feature */
1551
+ scale?: number; /** stepped: steps only from this frame; null for always */
1552
+ start?: number; /** stepped: frames each step holds */
1553
+ step?: number; /** noise */
1554
+ strength?: number; /** The channel's object (or material) id */
1555
+ target: number; /** function */
1556
+ valueOffset?: number;
1557
+ };
1558
+ /** Remove F-Curve Modifier. Removes an F-curve modifier from a curve. Changes the document. */
1559
+ "graph.removeModifier": {
1560
+ index?: number; /** The modifier's place in the stack, from 0 */
1561
+ modifier: number; /** The bone or shape key, for their properties */
1562
+ path?: string; /** The channel's property (location, boneRotation, shapeKey, ...) */
1563
+ property: string; /** The channel's object (or material) id */
1564
+ target: number;
1565
+ };
1566
+ /** Armature. Adds an armature with one bone at `location` and answers its name and object id. Changes the document. */
1567
+ "add.armature": {
1568
+ location?: Array<number>; /** The object's name */
1569
+ name?: string;
1570
+ };
1571
+ /** Toggle Edit Mode. Toggles the armature `object` (the active one without it) between object mode and bone edit mode. Acts on `object`. Reads the selection. */
1572
+ "mode.armature": {
1573
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1574
+ pick?: Array<number>;
1575
+ };
1576
+ /** Pose Mode. Turns pose mode on or off for armature `object`. Acts on `object`. Reads the selection. */
1577
+ "mode.pose": {
1578
+ object?: Json; /** Pose mode on or off; toggles when left out */
1579
+ on?: boolean; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1580
+ pick?: Array<number>;
1581
+ };
1582
+ /** Add Bone. Adds a bone with head and tail to the armature in edit mode, optionally parented and connected. Changes the document. */
1583
+ "bone.add": {
1584
+ connected?: boolean; /** Where it starts, in the armature's space (the origin) [x, y, z] */
1585
+ head?: Array<number>; /** The bone's name (Bone) */
1586
+ name?: string; /** The parent bone */
1587
+ parent?: string; /** Where it ends (a metre above the head) [x, y, z] */
1588
+ tail?: Array<number>;
1589
+ };
1590
+ /** Extrude Bone. Extrudes a new bone from the selected bone's tail by `length` or to `tail`. Changes the document. */
1591
+ "bone.extrude": {
1592
+ length?: number; /** Where the new bone ends, in the armature's space [x, y, z] */
1593
+ tail?: Array<number>;
1594
+ };
1595
+ /** Bone Settings. Changes bone `bone`: name, head, tail, roll, parent, connection, deform. Acts on `object`. Reads the selection. Changes the document. */
1596
+ "bone.set": {
1597
+ bone?: string; /** The head sits on the parent's tail */
1598
+ connected?: boolean; /** The bone deforms meshes */
1599
+ deform?: boolean; /** Envelope: how far past the radii it fades out, metres (0.25) */
1600
+ envelopeDistance?: number; /** Multiply the bone's vertex group weights by its envelope */
1601
+ envelopeMultiply?: boolean; /** Envelope: its strength where full (1) */
1602
+ envelopeWeight?: number; /** Where it starts, armature space [x, y, z] */
1603
+ head?: Array<number>; /** Envelope: the radius at the head, metres (0.1) */
1604
+ headRadius?: number; /** A new name */
1605
+ name?: string; /** The armature; the active one when left out */
1606
+ object?: Json; /** The parent bone; an empty string clears it */
1607
+ parent?: string; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1608
+ pick?: Array<number>; /** Turn about its own axis, degrees */
1609
+ roll?: number; /** Custom shape: the object whose mesh draws the bone; null for the octahedron */
1610
+ shape?: Json; /** Custom shape: scaled by the bone's length too (true) */
1611
+ shapeBoneSize?: boolean; /** Custom shape: its turn in the bone's axes, degrees [x, y, z] */
1612
+ shapeRotation?: Array<number>; /** Custom shape: its scale [x, y, z] */
1613
+ shapeScale?: Array<number>; /** Custom shape: its offset in the bone's axes, metres [x, y, z] */
1614
+ shapeTranslation?: Array<number>; /** Custom shape: drawn as its edges only */
1615
+ shapeWire?: boolean; /** Where it ends, armature space [x, y, z] */
1616
+ tail?: Array<number>; /** Envelope: the radius at the tail, metres (0.05) */
1617
+ tailRadius?: number;
1618
+ };
1619
+ /** Select Bones. Selects bones by name in edit or pose mode, adding with `extend` or removing with `deselect`. Reads the selection. */
1620
+ "bone.select": {
1621
+ bones: Json; /** Take them out of the selection */
1622
+ deselect?: boolean; /** Add to the selection */
1623
+ extend?: boolean;
1624
+ };
1625
+ /** Pose Bones. Sets location, rotation and/or scale of pose bones `bones`. Changes the document. */
1626
+ "pose.set": {
1627
+ bones?: Json; /** Location in the bone's rest space, metres [x, y, z] */
1628
+ location?: Array<number>; /** Rotation in degrees, XYZ Euler, in the bone's rest space [x, y, z] */
1629
+ rotation?: Array<number>; /** Scale [x, y, z] */
1630
+ scale?: Array<number>;
1631
+ };
1632
+ /** Clear Pose. Clears the pose of `bones` (or all) back to the rest pose. Changes the document. */
1633
+ "pose.clear": {
1634
+ all?: boolean; /** The bones; the selected ones when left out */
1635
+ bones?: Json;
1636
+ };
1637
+ /** Insert Keyframe. Inserts keyframes for pose bones `bones` at `frame`. Reads the time. Changes the document. */
1638
+ "pose.insertKey": {
1639
+ bones?: Json; /** The frame; the current frame when left out */
1640
+ frame?: number; /** Key what this keying set names instead (the active one is used when no properties are given) */
1641
+ keyingSet?: string; /** What to key (all three when left out) */
1642
+ properties?: Array<"location" | "rotation" | "scale">;
1643
+ };
1644
+ /** Delete Keyframe. Deletes the `properties` keyframes (location, rotation, scale; all without it) of pose bones `bones` at `frame`. Reads the time. Changes the document. */
1645
+ "pose.deleteKey": {
1646
+ bones?: Json; /** The frame; the current frame when left out */
1647
+ frame?: number; /** Whose keys to delete (all three when left out) */
1648
+ properties?: Array<"location" | "rotation" | "scale">;
1649
+ };
1650
+ /** Parent to Armature. Parents `objects` (names or ids; the selection without it) to `armature` with automatic, envelope or empty weights. Acts on `objects`. Reads the selection. Changes the document. */
1651
+ "object.parentArmature": {
1652
+ armature?: Json; /** The meshes; the selected ones without the active armature when left out */
1653
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1654
+ pick?: Array<number>; /** How the vertex groups are made */
1655
+ weights?: "automatic" | "empty" | "none";
1656
+ };
1657
+ /** Add Vertex Group. Adds a vertex group named `name` to `object`. Acts on `object`. Reads the selection. Changes the document. */
1658
+ "vertexGroup.add": {
1659
+ name?: string; /** The mesh object; the edited or active one when left out */
1660
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1661
+ pick?: Array<number>;
1662
+ };
1663
+ /** Remove Vertex Group. Removes vertex group `name` from `object`. Acts on `object`. Reads the selection. Changes the document. */
1664
+ "vertexGroup.remove": {
1665
+ name: string; /** The mesh object; the edited or active one when left out */
1666
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1667
+ pick?: Array<number>;
1668
+ };
1669
+ /** Assign to Group. Assigns vertices (by index, else the selected ones) to vertex group `name` with `weight`. Acts on `object`. Reads the selection. Changes the document. */
1670
+ "vertexGroup.assign": {
1671
+ name: string; /** The mesh object; the edited or active one when left out */
1672
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1673
+ pick?: Array<number>; /** The vertices; the edit-mode selection when left out */
1674
+ vertices?: Array<number>; /** 0 to 1 (1) */
1675
+ weight?: number;
1676
+ };
1677
+ /** Remove from Group. Removes vertices (by index, else the selected ones) from vertex group `name`. Acts on `object`. Reads the selection. Changes the document. */
1678
+ "vertexGroup.unassign": {
1679
+ name: string; /** The mesh object; the edited or active one when left out */
1680
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1681
+ pick?: Array<number>; /** The vertices; the edit-mode selection when left out */
1682
+ vertices?: Array<number>;
1683
+ };
1684
+ /** Select Group. Selects the vertices of vertex group `name` in edit mode. */
1685
+ "vertexGroup.select": {
1686
+ name: string;
1687
+ };
1688
+ /** Add Shape Key. Adds a shape key named `name` to `object`, from the basis or `from`, optionally with vertex `offsets`. Acts on `object`. Reads the selection. Changes the document. */
1689
+ "shapeKey.add": {
1690
+ from?: Json; /** The key's name (Key 1, Key 2, ...) */
1691
+ name?: string; /** The mesh object; the edited or active one when left out */
1692
+ object?: Json; /** An offset [x, y, z] per vertex, in the object's own axes */
1693
+ offsets?: Array<Json>; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1694
+ pick?: Array<number>;
1695
+ };
1696
+ /** Remove Shape Key. Removes shape key `name` from `object`. Acts on `object`. Reads the selection. Changes the document. */
1697
+ "shapeKey.remove": {
1698
+ name: string; /** The mesh object; the edited or active one when left out */
1699
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1700
+ pick?: Array<number>;
1701
+ };
1702
+ /** Shape Key Settings. Sets shape key `name`'s value (0 to 1) or renames it. Acts on `object`. Reads the selection. Changes the document. */
1703
+ "shapeKey.set": {
1704
+ name: string; /** The mesh object; the edited or active one when left out */
1705
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1706
+ pick?: Array<number>; /** A new name */
1707
+ rename?: string; /** How much of the shape, usually 0 to 1 */
1708
+ value?: number;
1709
+ };
1710
+ /** Move in Shape Key. Moves vertices of shape key `name` by `offset`. Acts on `object`. Reads the selection. Changes the document. */
1711
+ "shapeKey.offset": {
1712
+ name: string; /** The mesh object; the edited or active one when left out */
1713
+ object?: Json; /** How far the vertices move in this shape, object axes [x, y, z] */
1714
+ offset: Array<number>; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1715
+ pick?: Array<number>; /** The vertices; the edit-mode selection when left out */
1716
+ vertices?: Array<number>;
1717
+ };
1718
+ /** Key Shape Value. Inserts a keyframe for shape key `name`'s value at `frame`. Acts on `object`. Reads the selection, time. Changes the document. */
1719
+ "shapeKey.insertKey": {
1720
+ frame?: number; /** The key */
1721
+ name: string; /** The mesh object; the edited or active one when left out */
1722
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1723
+ pick?: Array<number>;
1724
+ };
1725
+ /** Move Keyframe. Moves a keyframe of an animated property from `frame` to `toFrame`. Reads the time. Changes the document. */
1726
+ "graph.moveKey": {
1727
+ frame: number; /** The component, from 0 (0) */
1728
+ index?: number; /** The bone or shape key, for their properties */
1729
+ path?: string; /** The channel's property (location, boneRotation, shapeKey, ...) */
1730
+ property: string; /** The channel's object (or material) id */
1731
+ target: number; /** The key's new frame */
1732
+ toFrame?: number; /** The key's new value (degrees for rotations) */
1733
+ value?: number;
1734
+ };
1735
+ /** Delete Keyframe. Deletes the keyframe at `frame` of an animated property. Reads the time. Changes the document. */
1736
+ "graph.deleteKey": {
1737
+ frame: number; /** The component, from 0 (0) */
1738
+ index?: number; /** The bone or shape key, for their properties */
1739
+ path?: string; /** The channel's property (location, boneRotation, shapeKey, ...) */
1740
+ property: string; /** The channel's object (or material) id */
1741
+ target: number;
1742
+ };
1743
+ /** Keyframe Interpolation. Sets the interpolation of the keyframe at `frame` of an animated property. Reads the time. Changes the document. */
1744
+ "graph.setInterpolation": {
1745
+ frame: number; /** The component, from 0 (0) */
1746
+ index?: number; /** How the curve runs to the next key */
1747
+ interpolation: "bezier" | "linear" | "constant"; /** The bone or shape key, for their properties */
1748
+ path?: string; /** The channel's property (location, boneRotation, shapeKey, ...) */
1749
+ property: string; /** The channel's object (or material) id */
1750
+ target: number;
1751
+ };
1752
+ /** Add Constraint. Adds a constraint (track to, copy location, IK, limit, child of, ...) with its settings to `object` or one of its bones. Acts on `object`. Reads the selection. Changes the document. */
1753
+ "constraint.add": {
1754
+ action?: string; /** copyLocation and copyRotation: [x, y, z] axes copied */
1755
+ axes?: Array<boolean>; /** floor: the plane's side the owner stays on */
1756
+ axis?: "x" | "y" | "z" | "-x" | "-y" | "-z"; /** A bone of the owner (an armature) to constrain instead of the object; the active bone in pose mode */
1757
+ bone?: string; /** stretchTo and splineIk: how strongly the other axes thin as it stretches, 0 to 100 (1 keeps the volume) */
1758
+ bulge?: number; /** ik: bones in the chain counting this one, 0 runs to the root; splineIk: bones fitted to the curve (1) */
1759
+ chain?: number; /** splineIk: keep the chain's root where it is */
1760
+ chainOffset?: boolean; /** action: the target's channel that picks the frame */
1761
+ channel?: "locationX" | "locationY" | "locationZ" | "rotationX" | "rotationY" | "rotationZ" | "scaleX" | "scaleY" | "scaleZ"; /** splineIk: the curve's radius scales the bones' thickness (true) */
1762
+ curveRadius?: boolean; /** splineIk: share the curve evenly between the bones */
1763
+ evenDivisions?: boolean; /** transform: map values beyond the source range too */
1764
+ extrapolate?: boolean; /** action: the frame the channel's maximum plays */
1765
+ frameEnd?: number; /** action: the frame the channel's minimum plays */
1766
+ frameStart?: number; /** transform: the source range's high end [x, y, z] */
1767
+ fromMax?: Array<number>; /** transform: the source range's low end (degrees for rotation) [x, y, z] */
1768
+ fromMin?: Array<number>; /** How much of the result is used, 0 to 1 (1) */
1769
+ influence?: number; /** copyLocation and copyRotation: [x, y, z] axes inverted */
1770
+ invert?: Array<boolean>; /** ik: solver iterations (500) */
1771
+ iterations?: number; /** stretchTo: how Y turns to the target */
1772
+ keepAxis?: "swingY" | "planeX" | "planeZ"; /** limitRotation: [x, y, z] angles limited */
1773
+ limit?: Array<boolean>; /** transform: the target's channel read */
1774
+ mapFrom?: "location" | "rotation" | "scale"; /** transform: the owner's channel set */
1775
+ mapTo?: "location" | "rotation" | "scale"; /** transform: for the owner's x, y, z, the target axis each reads */
1776
+ mapping?: Array<"x" | "y" | "z">; /** limitRotation: highest angles, degrees [x, y, z]; action: the channel value that plays frameEnd */
1777
+ max?: Json; /** limitRotation: lowest angles, degrees [x, y, z]; action: the channel value that plays frameStart (degrees for rotation) */
1778
+ min?: Json; /** transform: add or replace (location), add, replace, before, or after (rotation), replace or multiply (scale); action: how the action combines with the owner */
1779
+ mix?: "add" | "replace" | "before" | "after" | "multiply" | "beforeFull" | "beforeSplit" | "afterFull" | "afterSplit"; /** The owner; the active object when left out */
1780
+ object?: Json; /** copyLocation: true adds to the owner's location; floor: metres beyond the plane */
1781
+ offset?: number; /** copyLocation, copyRotation, transform: the space the owner is read in (pose and localWithParent on bones) */
1782
+ ownerSpace?: "world" | "local" | "pose" | "localWithParent"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1783
+ pick?: Array<number>; /** ik: the pole target object */
1784
+ pole?: Json; /** ik: degrees the chain turns from the pole */
1785
+ poleAngle?: number; /** ik: a bone of the pole target */
1786
+ poleBone?: string; /** armature: blend the bones as dual quaternions */
1787
+ preserveVolume?: boolean; /** Its name */
1788
+ rename?: string; /** stretchTo: the distance, in the owner's Y units, at which it does not stretch; 0 takes the distance now */
1789
+ restLength?: number; /** limitRotation: the space the angles are read in (pose and localWithParent on bones) */
1790
+ space?: "world" | "local" | "pose" | "localWithParent"; /** The target object */
1791
+ target?: Json; /** A bone of the target (an armature) to use instead of the object */
1792
+ targetBone?: string; /** copyLocation, copyRotation, transform, action: the space the target is read in */
1793
+ targetSpace?: "world" | "local" | "pose" | "localWithParent"; /** armature: the bones that move the owner, as { object, bone, weight } */
1794
+ targets?: Array<{
1795
+ bone?: string;
1796
+ object?: Json;
1797
+ weight?: number;
1798
+ }>; /** transform: the destination range's high end [x, y, z] */
1799
+ toMax?: Array<number>; /** transform: the destination range's low end (degrees for rotation) [x, y, z] */
1800
+ toMin?: Array<number>; /** trackTo and dampedTrack: the axis pointed at the target */
1801
+ trackAxis?: "x" | "y" | "z" | "-x" | "-y" | "-z"; /** The constraint (ik and splineIk on bones) */
1802
+ type: "trackTo" | "dampedTrack" | "copyLocation" | "copyRotation" | "limitRotation" | "childOf" | "ik" | "stretchTo" | "floor" | "transform" | "action" | "armature" | "splineIk"; /** trackTo: the axis kept up */
1803
+ upAxis?: "x" | "y" | "z"; /** floor: the plane turns with the target */
1804
+ useRotation?: boolean; /** stretchTo: the axes that thin */
1805
+ volume?: "xzx" | "x" | "z" | "none"; /** splineIk: the bones' thickness */
1806
+ xzScale?: "none" | "boneOriginal" | "inversePreserve" | "volumePreserve"; /** splineIk: the bones' lengths */
1807
+ yScale?: "none" | "fitCurve" | "boneOriginal";
1808
+ };
1809
+ /** Change Constraint. Changes the settings of constraint `index` or `name`. Acts on `object`. Reads the selection. Changes the document. */
1810
+ "constraint.set": {
1811
+ action?: string; /** copyLocation and copyRotation: [x, y, z] axes copied */
1812
+ axes?: Array<boolean>; /** floor: the plane's side the owner stays on */
1813
+ axis?: "x" | "y" | "z" | "-x" | "-y" | "-z"; /** A bone of the owner (an armature) to constrain instead of the object; the active bone in pose mode */
1814
+ bone?: string; /** stretchTo and splineIk: how strongly the other axes thin as it stretches, 0 to 100 (1 keeps the volume) */
1815
+ bulge?: number; /** ik: bones in the chain counting this one, 0 runs to the root; splineIk: bones fitted to the curve (1) */
1816
+ chain?: number; /** splineIk: keep the chain's root where it is */
1817
+ chainOffset?: boolean; /** action: the target's channel that picks the frame */
1818
+ channel?: "locationX" | "locationY" | "locationZ" | "rotationX" | "rotationY" | "rotationZ" | "scaleX" | "scaleY" | "scaleZ"; /** splineIk: the curve's radius scales the bones' thickness (true) */
1819
+ curveRadius?: boolean; /** On or off */
1820
+ enabled?: boolean; /** splineIk: share the curve evenly between the bones */
1821
+ evenDivisions?: boolean; /** transform: map values beyond the source range too */
1822
+ extrapolate?: boolean; /** action: the frame the channel's maximum plays */
1823
+ frameEnd?: number; /** action: the frame the channel's minimum plays */
1824
+ frameStart?: number; /** transform: the source range's high end [x, y, z] */
1825
+ fromMax?: Array<number>; /** transform: the source range's low end (degrees for rotation) [x, y, z] */
1826
+ fromMin?: Array<number>; /** The constraint's position in the stack, from 0 */
1827
+ index?: number; /** How much of the result is used, 0 to 1 (1) */
1828
+ influence?: number; /** copyLocation and copyRotation: [x, y, z] axes inverted */
1829
+ invert?: Array<boolean>; /** ik: solver iterations (500) */
1830
+ iterations?: number; /** stretchTo: how Y turns to the target */
1831
+ keepAxis?: "swingY" | "planeX" | "planeZ"; /** limitRotation: [x, y, z] angles limited */
1832
+ limit?: Array<boolean>; /** transform: the target's channel read */
1833
+ mapFrom?: "location" | "rotation" | "scale"; /** transform: the owner's channel set */
1834
+ mapTo?: "location" | "rotation" | "scale"; /** transform: for the owner's x, y, z, the target axis each reads */
1835
+ mapping?: Array<"x" | "y" | "z">; /** limitRotation: highest angles, degrees [x, y, z]; action: the channel value that plays frameEnd */
1836
+ max?: Json; /** limitRotation: lowest angles, degrees [x, y, z]; action: the channel value that plays frameStart (degrees for rotation) */
1837
+ min?: Json; /** transform: add or replace (location), add, replace, before, or after (rotation), replace or multiply (scale); action: how the action combines with the owner */
1838
+ mix?: "add" | "replace" | "before" | "after" | "multiply" | "beforeFull" | "beforeSplit" | "afterFull" | "afterSplit"; /** The constraint's name (instead of index) */
1839
+ name?: string; /** The owner; the active object when left out */
1840
+ object?: Json; /** copyLocation: true adds to the owner's location; floor: metres beyond the plane */
1841
+ offset?: number; /** copyLocation, copyRotation, transform: the space the owner is read in (pose and localWithParent on bones) */
1842
+ ownerSpace?: "world" | "local" | "pose" | "localWithParent"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1843
+ pick?: Array<number>; /** ik: the pole target object */
1844
+ pole?: Json; /** ik: degrees the chain turns from the pole */
1845
+ poleAngle?: number; /** ik: a bone of the pole target */
1846
+ poleBone?: string; /** armature: blend the bones as dual quaternions */
1847
+ preserveVolume?: boolean; /** A new name */
1848
+ rename?: string; /** stretchTo: the distance, in the owner's Y units, at which it does not stretch; 0 takes the distance now */
1849
+ restLength?: number; /** limitRotation: the space the angles are read in (pose and localWithParent on bones) */
1850
+ space?: "world" | "local" | "pose" | "localWithParent"; /** The target object */
1851
+ target?: Json; /** A bone of the target (an armature) to use instead of the object */
1852
+ targetBone?: string; /** copyLocation, copyRotation, transform, action: the space the target is read in */
1853
+ targetSpace?: "world" | "local" | "pose" | "localWithParent"; /** armature: the bones that move the owner, as { object, bone, weight } */
1854
+ targets?: Array<{
1855
+ bone?: string;
1856
+ object?: Json;
1857
+ weight?: number;
1858
+ }>; /** transform: the destination range's high end [x, y, z] */
1859
+ toMax?: Array<number>; /** transform: the destination range's low end (degrees for rotation) [x, y, z] */
1860
+ toMin?: Array<number>; /** trackTo and dampedTrack: the axis pointed at the target */
1861
+ trackAxis?: "x" | "y" | "z" | "-x" | "-y" | "-z"; /** trackTo: the axis kept up */
1862
+ upAxis?: "x" | "y" | "z"; /** floor: the plane turns with the target */
1863
+ useRotation?: boolean; /** stretchTo: the axes that thin */
1864
+ volume?: "xzx" | "x" | "z" | "none"; /** splineIk: the bones' thickness */
1865
+ xzScale?: "none" | "boneOriginal" | "inversePreserve" | "volumePreserve"; /** splineIk: the bones' lengths */
1866
+ yScale?: "none" | "fitCurve" | "boneOriginal";
1867
+ };
1868
+ /** Remove Constraint. Removes constraint `index` or `name`. Acts on `object`. Reads the selection. Changes the document. */
1869
+ "constraint.remove": {
1870
+ bone?: string; /** The constraint's position in the stack, from 0 */
1871
+ index?: number; /** The constraint's name (instead of index) */
1872
+ name?: string; /** The owner; the active object when left out */
1873
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1874
+ pick?: Array<number>;
1875
+ };
1876
+ /** Move Constraint. Moves constraint `index` or `name` to position `to` in the stack. Acts on `object`. Reads the selection. Changes the document. */
1877
+ "constraint.move": {
1878
+ bone?: string; /** The constraint's position in the stack, from 0 */
1879
+ index?: number; /** The constraint's name (instead of index) */
1880
+ name?: string; /** The owner; the active object when left out */
1881
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1882
+ pick?: Array<number>; /** The new position, from 0 */
1883
+ to: number;
1884
+ };
1885
+ /** Apply Constraint. Applies constraint `index` or `name` to the transform (its effect alone, on the object's own transform) and removes it; the others stay. Acts on `object`. Reads the selection. Changes the document. */
1886
+ "constraint.apply": {
1887
+ bone?: string; /** The constraint's position in the stack, from 0 */
1888
+ index?: number; /** The constraint's name (instead of index) */
1889
+ name?: string; /** The owner; the active object when left out */
1890
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1891
+ pick?: Array<number>;
1892
+ };
1893
+ /** Set Inverse. Sets the inverse of a child-of constraint so the object stays where it is. Acts on `object`. Reads the selection. Changes the document. */
1894
+ "constraint.setInverse": {
1895
+ bone?: string; /** The constraint's position in the stack, from 0 */
1896
+ index?: number; /** The constraint's name (instead of index) */
1897
+ name?: string; /** The owner; the active object when left out */
1898
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1899
+ pick?: Array<number>;
1900
+ };
1901
+ /** Clear Inverse. Clears the inverse of a child-of constraint. Acts on `object`. Reads the selection. Changes the document. */
1902
+ "constraint.clearInverse": {
1903
+ bone?: string; /** The constraint's position in the stack, from 0 */
1904
+ index?: number; /** The constraint's name (instead of index) */
1905
+ name?: string; /** The owner; the active object when left out */
1906
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1907
+ pick?: Array<number>;
1908
+ };
1909
+ /** Weight Paint. Turns weight paint mode on or off for mesh `object`. Acts on `object`. Reads the selection. */
1910
+ "mode.weightPaint": {
1911
+ object?: Json; /** Weight paint on or off; toggles when left out */
1912
+ on?: boolean; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1913
+ pick?: Array<number>;
1914
+ };
1915
+ /** Paint Group. Sets the vertex group weight painting paints into, and answers it. */
1916
+ "paint.group": {
1917
+ name: string;
1918
+ };
1919
+ /** Brush Settings. Sets the weight paint brush (mode, weight, radius, strength, falloff, front faces only) and X mirror (`xMirror`, `topologyMirror`, `mirrorGroups`); answers them. */
1920
+ "paint.brush": {
1921
+ falloff?: "smooth" | "sphere" | "root" | "sharp" | "linear" | "constant"; /** Only vertices facing the view */
1922
+ frontFacesOnly?: boolean; /** X mirror paints in the group of the mirrored name, Arm.L and Arm.R (true) */
1923
+ mirrorGroups?: boolean; /** What a stroke does */
1924
+ mode?: "draw" | "add" | "subtract" | "blur"; /** Radius in pixels (50) */
1925
+ radius?: number; /** How much one dab changes, 0 to 1 (1) */
1926
+ strength?: number; /** X mirror finds that vertex by the edges, for sides that differ in shape (false) */
1927
+ topologyMirror?: boolean; /** The weight painted, 0 to 1 (1) */
1928
+ weight?: number; /** Paint the vertex across X = 0 too (false) */
1929
+ xMirror?: boolean;
1930
+ };
1931
+ /** Weight Tool. Sets what the pointer does in weight paint: `tool` brush, linearGradient, radialGradient, or sampleWeight; answers it. */
1932
+ "paint.tool": {
1933
+ tool: "brush" | "linearGradient" | "radialGradient" | "sampleWeight";
1934
+ };
1935
+ /** Sample Weight. Sets the brush weight to the paint group's weight at viewport pixel `at` (the nearest vertex of the face there); answers it. Reads the selection. */
1936
+ "paint.sample": {
1937
+ at: Array<number>;
1938
+ };
1939
+ /** Gradient. Fills group `group` (the paint group without it) with a `kind` linear or radial gradient from viewport pixel `from` (full brush weight) to `to`, as one undo step. Changes the document. */
1940
+ "paint.gradient": {
1941
+ from: Array<number>; /** The group; the paint group when left out */
1942
+ group?: string; /** Along the line, or around the start (linear) */
1943
+ kind?: "linear" | "radial"; /** Where it has faded out, viewport pixels [x, y] */
1944
+ to: Array<number>;
1945
+ };
1946
+ /** Paint Stroke. Paints weights into vertex group `group` along `points` with the current brush. Changes the document. */
1947
+ "paint.stroke": {
1948
+ group?: string; /** The stroke's path in viewport pixels, as [x, y] pairs */
1949
+ points: Array<Json>;
1950
+ };
1951
+ /** Set Weights. Sets, adds or subtracts `weight` on vertices of group `group` directly. Acts on `object`. Reads the selection. Changes the document. */
1952
+ "paint.vertices": {
1953
+ group?: string; /** How the weight is used (draw replaces) */
1954
+ mode?: "draw" | "add" | "subtract"; /** The mesh; the painted or active one when left out */
1955
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1956
+ pick?: Array<number>; /** Vertex indices */
1957
+ vertices: Array<number>; /** The weight (1) */
1958
+ weight?: number;
1959
+ };
1960
+ /** Normalize All. Normalizes every vertex's weights to sum to 1, optionally keeping the active group. Acts on `object`. Reads the selection. Changes the document. */
1961
+ "paint.normalizeAll": {
1962
+ lockActive?: boolean; /** The mesh; the painted or active one when left out */
1963
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1964
+ pick?: Array<number>;
1965
+ };
1966
+ /** Sculpt Mode. Turns sculpt mode on or off for mesh `object`. Acts on `object`. Reads the selection. */
1967
+ "mode.sculpt": {
1968
+ object?: Json; /** Sculpt on or off; toggles when left out */
1969
+ on?: boolean; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
1970
+ pick?: Array<number>;
1971
+ };
1972
+ /** Brush Settings. Sets the sculpt brush (kind, radius, strength, falloff, auto-smooth) and answers it. */
1973
+ "sculpt.brush": {
1974
+ autoSmooth?: number; /** How the brush fades to its edge */
1975
+ falloff?: "smooth" | "sphere" | "root" | "sharp" | "linear" | "constant"; /** Only vertices facing the view */
1976
+ frontFacesOnly?: boolean; /** The brush */
1977
+ kind?: "draw" | "clayStrips" | "smooth" | "grab" | "inflate" | "crease" | "flatten" | "pinch" | "snakeHook" | "mask" | "drawFaceSets"; /** Radius in viewport pixels (50) */
1978
+ radius?: number; /** Distance between dabs as a share of the radius (0.1) */
1979
+ spacing?: number; /** Strength at the centre, 0 to 1 (0.5; 1 for grab, snake hook, crease, mask, draw face sets) */
1980
+ strength?: number; /** The other direction: in instead of out, unmask instead of mask */
1981
+ subtract?: boolean; /** Mirror dabs across the object's own [x, y, z] (x on) */
1982
+ symmetry?: Array<boolean>; /** Pen pressure scales the strength (true) */
1983
+ usePressure?: boolean;
1984
+ };
1985
+ /** Sculpt Stroke. Sculpts along `points` (or a `drag`) with a brush. Reads the selection, time. Changes the document. */
1986
+ "sculpt.stroke": {
1987
+ autoSmooth?: number; /** Grab and snake hook with world points: how far the last point drags, in metres [x, y, z] */
1988
+ drag?: Array<number>; /** How the brush fades to its edge */
1989
+ falloff?: "smooth" | "sphere" | "root" | "sharp" | "linear" | "constant"; /** Only vertices facing the view */
1990
+ frontFacesOnly?: boolean; /** The brush */
1991
+ kind?: "draw" | "clayStrips" | "smooth" | "grab" | "inflate" | "crease" | "flatten" | "pinch" | "snakeHook" | "mask" | "drawFaceSets"; /** The stroke's path: [x, y] viewport pixels, or [x, y, z] world points on the surface */
1992
+ points: Array<Json>; /** Pen pressure at each point, 0 to 1 */
1993
+ pressures?: Array<number>; /** Radius in viewport pixels (50) */
1994
+ radius?: number; /** Distance between dabs as a share of the radius (0.1) */
1995
+ spacing?: number; /** Strength at the centre, 0 to 1 (0.5; 1 for grab, snake hook, crease, mask, draw face sets) */
1996
+ strength?: number; /** The other direction: in instead of out, unmask instead of mask */
1997
+ subtract?: boolean; /** Mirror dabs across the object's own [x, y, z] (x on) */
1998
+ symmetry?: Array<boolean>; /** Pen pressure scales the strength (true) */
1999
+ usePressure?: boolean; /** With world points: the radius in metres (0.25) */
2000
+ worldRadius?: number;
2001
+ };
2002
+ /** Invert Mask. Inverts the sculpt mask. Changes the document. */
2003
+ "sculpt.maskInvert": Record<string, never>;
2004
+ /** Clear Mask. Clears the sculpt mask. Changes the document. */
2005
+ "sculpt.maskClear": Record<string, never>;
2006
+ /** Fill Mask. Masks the whole mesh. Changes the document. */
2007
+ "sculpt.maskFill": Record<string, never>;
2008
+ /** Smooth Mask. Smooths the sculpt mask's edges. Changes the document. */
2009
+ "sculpt.maskSmooth": Record<string, never>;
2010
+ /** Sculpt Tool. Selects a sculpt tool and answers it. Reads the selection. */
2011
+ "sculpt.tool": {
2012
+ tool: "brush" | "boxMask" | "lassoMask" | "boxHide" | "lassoHide" | "boxFaceSet" | "lassoFaceSet";
2013
+ };
2014
+ /** Dynamic Topology. Turns dynamic topology on or off and sets its detail mode and size. Changes the document. */
2015
+ "sculpt.dyntopo": {
2016
+ detailSize?: number; /** Dynamic topology on (cuts the mesh into triangles) or off */
2017
+ enabled?: boolean; /** How the detail size is measured */
2018
+ mode?: "relative" | "constant" | "brush"; /** Brush: the longest edge as a percentage of the brush radius (25) */
2019
+ percent?: number; /** What a dab does to the edges under it */
2020
+ refine?: "subdivideCollapse" | "subdivide" | "collapse"; /** Constant: edges per metre (12) */
2021
+ resolution?: number;
2022
+ };
2023
+ /** Detail Flood Fill. Remeshes the whole mesh to the dynamic topology detail size. Changes the document. */
2024
+ "sculpt.detailFlood": Record<string, never>;
2025
+ /** Box or Lasso. Applies a box or lasso gesture (mask, hide, face set, trim) over screen `points`. Reads the selection, time. Changes the document. */
2026
+ "sculpt.gesture": {
2027
+ action: "mask" | "unmask" | "hide" | "show" | "faceSet"; /** Only what is seen, not what is behind it */
2028
+ frontFacesOnly?: boolean; /** Work on what lies outside the shape instead */
2029
+ outside?: boolean; /** [x, y] viewport pixels: a box's two corners or a lasso's outline */
2030
+ points: Array<Json>; /** A box (two corners) or a lasso (the outline) */
2031
+ shape?: "box" | "lasso"; /** mask: the mask value, 0 to 1 (1) */
2032
+ value?: number;
2033
+ };
2034
+ /** Face Set from Masked. Makes a face set from the masked faces. Changes the document. */
2035
+ "sculpt.faceSetsFromMask": Record<string, never>;
2036
+ /** Face Set from Visible. Makes a face set from the visible faces. Changes the document. */
2037
+ "sculpt.faceSetsFromVisible": Record<string, never>;
2038
+ /** Face Sets from Loose Parts. Makes one face set per loose part of the mesh. Changes the document. */
2039
+ "sculpt.faceSetsFromLooseParts": Record<string, never>;
2040
+ /** Clear Face Sets. Removes every face set. Changes the document. */
2041
+ "sculpt.faceSetsClear": Record<string, never>;
2042
+ /** Face Set Visibility. Shows, hides or isolates face set `faceSet` (or the one under `x`, `y`). Reads the selection, time. Changes the document. */
2043
+ "sculpt.faceSetVisibility": {
2044
+ action?: "hide" | "isolate" | "showAll" | "toggle"; /** The face set's id (0 for faces in none) */
2045
+ faceSet?: number; /** Or the face set under this viewport pixel: x (the pointer's when left out) */
2046
+ x?: number; /** and y */
2047
+ y?: number;
2048
+ };
2049
+ /** Hide Face Set. Hides the face set under the pointer. Reads the selection, time. Changes the document. */
2050
+ "sculpt.hideFaceSet": Record<string, never>;
2051
+ /** Show Only Face Set. Shows only the face set under the pointer. Reads the selection, time. Changes the document. */
2052
+ "sculpt.isolateFaceSet": Record<string, never>;
2053
+ /** Show All Faces. Shows every hidden face again. Reads the selection, time. Changes the document. */
2054
+ "sculpt.showAllFaces": Record<string, never>;
2055
+ /** Voxel Remesh. Remeshes `object` with voxels of `voxelSize`. Acts on `object`. Reads the selection. Changes the document. */
2056
+ "sculpt.remesh": {
2057
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2058
+ pick?: Array<number>; /** The size of the voxels the surface is rebuilt from, metres (0.1) */
2059
+ voxelSize?: number;
2060
+ };
2061
+ /** Multires Subdivide. Adds a multiresolution subdivision level to `object`. Acts on `object`. Reads the selection. Changes the document. */
2062
+ "multires.subdivide": {
2063
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2064
+ pick?: Array<number>;
2065
+ };
2066
+ /** Multires Unsubdivide. Recovers one quad subdivision level below the base mesh, preserving existing surfaces and detail. Requires a Multires modifier, manifold quad topology with a boundary corner or extraordinary interior vertex per component (at most 100000 base faces and 250000 highest-level faces), linearly subdivided UVs, and no vertex groups, shape keys, masks, face sets, hidden faces, seams or UV pins. Unsupported inputs leave the document unchanged. Acts on `object`. Reads the selection. Changes the document. */
2067
+ "multires.unsubdivide": {
2068
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2069
+ pick?: Array<number>;
2070
+ };
2071
+ /** Multires Rebuild Subdivisions. Recovers all complete quad subdivision levels, up to six, from a mesh with a Multires modifier and no existing levels. Disconnected components stop at their common depth. Preserves the input surface as the highest level; has the same topology and attribute restrictions as multires.unsubdivide. Acts on `object`. Reads the selection. Changes the document. */
2072
+ "multires.rebuildSubdivisions": {
2073
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2074
+ pick?: Array<number>;
2075
+ };
2076
+ /** Multires Delete Higher. Deletes the multiresolution levels above the current one. Acts on `object`. Reads the selection. Changes the document. */
2077
+ "multires.deleteHigher": {
2078
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2079
+ pick?: Array<number>;
2080
+ };
2081
+ /** Multires Apply Base. Applies the multiresolution detail to the base mesh's shape. Acts on `object`. Reads the selection. Changes the document. */
2082
+ "multires.applyBase": {
2083
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2084
+ pick?: Array<number>;
2085
+ };
2086
+ /** Multires Reshape. Copies the shape of object `from` into `object`'s multiresolution levels. Acts on `object`. Reads the selection. Changes the document. */
2087
+ "multires.reshape": {
2088
+ from: Json; /** The mesh; the sculpted or active one when left out */
2089
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2090
+ pick?: Array<number>;
2091
+ };
2092
+ /** Add Particle System. Adds a particle system (Newtonian or airborne averaged boid emitter, or hair) with its settings to `object`. Acts on `object`. Reads the selection. Changes the document. */
2093
+ "particles.add": {
2094
+ boids?: {
2095
+ airAccMax?: number;
2096
+ airAngularMax?: number;
2097
+ airPersonalSpace?: number;
2098
+ airSpeedMax?: number;
2099
+ rules?: Array<{
2100
+ kind: "goal" | "avoid" | "separate" | "flock";
2101
+ target?: Json;
2102
+ }>;
2103
+ }; /** The share of speed kept on a bounce, 0 to 1 (0.5) */
2104
+ bounce?: number; /** Hair: children per parent strand (10) */
2105
+ childCount?: number; /** Hair: how far simple children spread round their parent, metres (0.2) */
2106
+ childRadius?: number; /** Hair: child strands */
2107
+ children?: "none" | "simple" | "interpolated"; /** Objects particles bounce off (ids or names; an empty list for none) */
2108
+ colliders?: Json; /** Particles or parent strands (1000, at most 100000) */
2109
+ count?: number; /** The vertex group whose weights set how densely particles and strands start (empty: everywhere alike) */
2110
+ densityGroup?: string; /** Particles die where they hit a collider */
2111
+ dieOnCollision?: boolean; /** How start points spread */
2112
+ distribution?: "jittered" | "random"; /** Air drag: the share of speed lost per second */
2113
+ drag?: number; /** Hair: dynamics simulated in the physics bake (true: on with the defaults, false: off; an object: its settings, turning it on) */
2114
+ dynamics?: Json; /** Where particles start */
2115
+ emitFrom?: "faces" | "verts" | "volume"; /** Emitter: the last frame particles are born (200) */
2116
+ frameEnd?: number; /** Emitter: the first frame particles are born (1) */
2117
+ frameStart?: number; /** How strongly the scene's gravity pulls (1) */
2118
+ gravity?: number; /** Hair: strand length, metres (4) */
2119
+ hairLength?: number; /** With renderAs object: the object copied at each particle (null for none) */
2120
+ instanceObject?: Json; /** Emitter (particles that fly) or hair (strands) */
2121
+ kind?: "emitter" | "hair"; /** Emitter: frames a particle lives (50) */
2122
+ lifetime?: number; /** Emitter: how much of the lifetime may randomly be cut, 0 to 1 */
2123
+ lifetimeRandom?: number; /** The system's name (ParticleSystem) */
2124
+ name?: string; /** Start speed along the surface normal, m/s (1) */
2125
+ normalVelocity?: number; /** The mesh; the active one when left out */
2126
+ object?: Json; /** Start velocity along the emitter's axes, m/s [x, y, z] */
2127
+ objectVelocity?: Array<number>; /** Emitter physics: Newtonian or airborne boids with averaged rules */
2128
+ physics?: "newtonian" | "boids"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2129
+ pick?: Array<number>; /** Start speed in a random direction, m/s */
2130
+ randomVelocity?: number; /** How particles show */
2131
+ renderAs?: "halo" | "object" | "none"; /** How far instances turn at random, 0 to 1 */
2132
+ rotationRandom?: number; /** Different seeds give different, each repeatable, particles (0) */
2133
+ seed?: number; /** Hair: segments per strand (5) */
2134
+ segments?: number; /** Particle size (halo diameter, instance scale), metres (0.05) */
2135
+ size?: number; /** How much of the size may randomly be taken off, 0 to 1 */
2136
+ sizeRandom?: number; /** Hair: strand width at the root, metres (0.01) */
2137
+ strandWidth?: number; /** Seconds simulated per frame (0.04) */
2138
+ timestep?: number;
2139
+ };
2140
+ /** Particle Settings. Changes particle system `system`'s settings, including airborne boids with averaged Goal, Avoid, Separate and Flock rules. Targets use their current world-space positions; animated target history, collisions and force fields are unsupported. Acts on `object`. Reads the selection. Changes the document. */
2141
+ "particles.set": {
2142
+ boids?: {
2143
+ airAccMax?: number;
2144
+ airAngularMax?: number;
2145
+ airPersonalSpace?: number;
2146
+ airSpeedMax?: number;
2147
+ rules?: Array<{
2148
+ kind: "goal" | "avoid" | "separate" | "flock";
2149
+ target?: Json;
2150
+ }>;
2151
+ }; /** The share of speed kept on a bounce, 0 to 1 (0.5) */
2152
+ bounce?: number; /** Hair: children per parent strand (10) */
2153
+ childCount?: number; /** Hair: how far simple children spread round their parent, metres (0.2) */
2154
+ childRadius?: number; /** Hair: child strands */
2155
+ children?: "none" | "simple" | "interpolated"; /** Objects particles bounce off (ids or names; an empty list for none) */
2156
+ colliders?: Json; /** Particles or parent strands (1000, at most 100000) */
2157
+ count?: number; /** The vertex group whose weights set how densely particles and strands start (empty: everywhere alike) */
2158
+ densityGroup?: string; /** Particles die where they hit a collider */
2159
+ dieOnCollision?: boolean; /** How start points spread */
2160
+ distribution?: "jittered" | "random"; /** Air drag: the share of speed lost per second */
2161
+ drag?: number; /** Hair: dynamics simulated in the physics bake (true: on with the defaults, false: off; an object: its settings, turning it on) */
2162
+ dynamics?: Json; /** Where particles start */
2163
+ emitFrom?: "faces" | "verts" | "volume"; /** Emitter: the last frame particles are born (200) */
2164
+ frameEnd?: number; /** Emitter: the first frame particles are born (1) */
2165
+ frameStart?: number; /** How strongly the scene's gravity pulls (1) */
2166
+ gravity?: number; /** Hair: strand length, metres (4) */
2167
+ hairLength?: number; /** With renderAs object: the object copied at each particle (null for none) */
2168
+ instanceObject?: Json; /** Emitter (particles that fly) or hair (strands) */
2169
+ kind?: "emitter" | "hair"; /** Emitter: frames a particle lives (50) */
2170
+ lifetime?: number; /** Emitter: how much of the lifetime may randomly be cut, 0 to 1 */
2171
+ lifetimeRandom?: number; /** A new name for the system */
2172
+ name?: string; /** Start speed along the surface normal, m/s (1) */
2173
+ normalVelocity?: number; /** The mesh; the active one when left out */
2174
+ object?: Json; /** Start velocity along the emitter's axes, m/s [x, y, z] */
2175
+ objectVelocity?: Array<number>; /** Emitter physics: Newtonian or airborne boids with averaged rules */
2176
+ physics?: "newtonian" | "boids"; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2177
+ pick?: Array<number>; /** Start speed in a random direction, m/s */
2178
+ randomVelocity?: number; /** How particles show */
2179
+ renderAs?: "halo" | "object" | "none"; /** How far instances turn at random, 0 to 1 */
2180
+ rotationRandom?: number; /** Different seeds give different, each repeatable, particles (0) */
2181
+ seed?: number; /** Hair: segments per strand (5) */
2182
+ segments?: number; /** Particle size (halo diameter, instance scale), metres (0.05) */
2183
+ size?: number; /** How much of the size may randomly be taken off, 0 to 1 */
2184
+ sizeRandom?: number; /** Hair: strand width at the root, metres (0.01) */
2185
+ strandWidth?: number; /** The system's index or name; the first when left out */
2186
+ system?: Json; /** Seconds simulated per frame (0.04) */
2187
+ timestep?: number;
2188
+ };
2189
+ /** Remove Particle System. Removes particle system `system` from `object`. Acts on `object`. Reads the selection. Changes the document. */
2190
+ "particles.remove": {
2191
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2192
+ pick?: Array<number>; /** The system's index or name; the first when left out */
2193
+ system?: Json;
2194
+ };
2195
+ /** Convert Particles to Mesh. Converts particle system `system` into a mesh object. Acts on `object`. Reads the selection, time. Changes the document. */
2196
+ "particles.convert": {
2197
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2198
+ pick?: Array<number>; /** The system's index or name; the first when left out */
2199
+ system?: Json;
2200
+ };
2201
+ /** Particle Statistics. Answers particle system `system`'s counts (particles, alive, children) at `frame`. Acts on `object`. Reads the selection. */
2202
+ "particles.stats": {
2203
+ frame?: number; /** The mesh; the active one when left out */
2204
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2205
+ pick?: Array<number>; /** The system's index or name; the first when left out */
2206
+ system?: Json;
2207
+ };
2208
+ /** Particle Edit Mode. Turns particle edit mode on or off for a hair system. Acts on `object`. Reads the selection. */
2209
+ "mode.particleEdit": {
2210
+ object?: Json; /** Particle Edit on or off; toggles when left out */
2211
+ on?: boolean; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2212
+ pick?: Array<number>; /** The system's index or name; the first when left out */
2213
+ system?: Json;
2214
+ };
2215
+ /** Grooming Brush. Sets the grooming brush (comb, cut, length, puff, smooth, ...) and answers it. */
2216
+ "particleEdit.brush": {
2217
+ kind?: "comb" | "cut" | "length" | "puff" | "smooth"; /** Radius in viewport pixels (50) */
2218
+ radius?: number; /** Strength, 0 to 1 (0.5) */
2219
+ strength?: number; /** Length and puff the other way: shorten, flatten */
2220
+ subtract?: boolean;
2221
+ };
2222
+ /** Groom Stroke. Grooms hair along `points` with a brush. Changes the document. */
2223
+ "particleEdit.stroke": {
2224
+ kind?: "comb" | "cut" | "length" | "puff" | "smooth"; /** The stroke's path: [x, y] viewport pixels */
2225
+ points: Array<Json>; /** Radius in viewport pixels (50) */
2226
+ radius?: number; /** Strength, 0 to 1 (0.5) */
2227
+ strength?: number; /** Length and puff the other way: shorten, flatten */
2228
+ subtract?: boolean;
2229
+ };
2230
+ /** Delete Edit. Deletes the grooming edits of the hair system. Changes the document. */
2231
+ "particleEdit.reset": Record<string, never>;
2232
+ /** Share Presence. Shares this person's pointer and selection with collaborators; answers what it shares. Reads the selection. */
2233
+ "presence.local": {
2234
+ pointer?: Array<number>;
2235
+ };
2236
+ /** Other People. Tells the editor where other people's pointers and selections are, for drawing them. */
2237
+ "presence.peers": {
2238
+ peers: Json;
2239
+ };
2240
+ /** Place Other People. Answers where to draw other people's pointers in the viewport. */
2241
+ "presence.place": Record<string, never>;
2242
+ /** Bezier. Adds a Bezier curve at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
2243
+ "add.curveBezier": {
2244
+ location?: Array<number>; /** The object's name */
2245
+ name?: string; /** Size: the curve spans twice this (1) */
2246
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
2247
+ rotation?: Array<number>; /** Scale [x, y, z] */
2248
+ scale?: Array<number>;
2249
+ };
2250
+ /** Circle. Adds a Bezier circle curve at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
2251
+ "add.curveCircle": {
2252
+ location?: Array<number>; /** The object's name */
2253
+ name?: string; /** Radius in metres (1) */
2254
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
2255
+ rotation?: Array<number>; /** Scale [x, y, z] */
2256
+ scale?: Array<number>;
2257
+ };
2258
+ /** Path. Adds a NURBS path curve at `location` (with rotation, scale and `name`) and answers its name and object id; name it to address it in the same run. Changes the document. */
2259
+ "add.curvePath": {
2260
+ location?: Array<number>; /** The object's name */
2261
+ name?: string; /** Size: the path spans four times this (1) */
2262
+ radius?: number; /** Rotation in degrees, XYZ Euler [x, y, z] */
2263
+ rotation?: Array<number>; /** Scale [x, y, z] */
2264
+ scale?: Array<number>;
2265
+ };
2266
+ /** Text. Adds a text object with `body` and `size` at `location` and answers its name and object id. Changes the document. */
2267
+ "add.text": {
2268
+ body?: string; /** Where to put it, in metres (the origin when left out) [x, y, z] */
2269
+ location?: Array<number>; /** The object's name */
2270
+ name?: string; /** Rotation in degrees, XYZ Euler [x, y, z] */
2271
+ rotation?: Array<number>; /** Scale [x, y, z] */
2272
+ scale?: Array<number>; /** The text's size (1) */
2273
+ size?: number;
2274
+ };
2275
+ /** Toggle Edit Mode. Toggles the active curve, text or lattice between object mode and its edit mode. Reads the selection. */
2276
+ "mode.shape": Record<string, never>;
2277
+ /** Curve Settings. Changes curve `object`: dimensions, resolution, extrude, bevel depth and resolution, fill, cyclic. Acts on `object`. Reads the selection. Changes the document. */
2278
+ "curve.set": {
2279
+ bevelDepth?: number; /** Segments in each quarter of the bevel's profile (4) */
2280
+ bevelResolution?: number; /** Close every spline on itself */
2281
+ cyclic?: boolean; /** 2d keeps the curve flat and fills closed splines */
2282
+ dimensions?: "2d" | "3d"; /** Half the height the curve is extruded to, metres */
2283
+ extrude?: number; /** Close the ends of an open bevelled curve */
2284
+ fillCaps?: boolean; /** 3D: full or half profile; 2D: which faces fill a closed curve */
2285
+ fillMode?: "full" | "half" | "both" | "front" | "back" | "none"; /** The curve or text; the active or edited one when left out */
2286
+ object?: Json; /** Moves the curve along its normals, metres */
2287
+ offset?: number; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2288
+ pick?: Array<number>; /** Samples per segment, for every spline (12) */
2289
+ resolution?: number;
2290
+ };
2291
+ /** Text Settings. Changes text `object`: body, font size, alignment, extrude, bevel, spacing. Acts on `object`. Reads the selection. Changes the document. */
2292
+ "text.set": {
2293
+ align?: "left" | "center" | "right"; /** The round edge's radius, metres */
2294
+ bevelDepth?: number; /** Segments in the round edge (4) */
2295
+ bevelResolution?: number; /** The text; a newline starts a new line */
2296
+ body?: string; /** Letter spacing as a multiple of each advance (1) */
2297
+ characterSpacing?: number; /** Half the thickness the letters are extruded to, metres */
2298
+ extrude?: number; /** The font's name (only the bundled Inter is available) */
2299
+ font?: string; /** Line distance as a multiple of the size (1) */
2300
+ lineSpacing?: number; /** The curve or text; the active or edited one when left out */
2301
+ object?: Json; /** Moves the text sideways, metres */
2302
+ offsetX?: number; /** Moves the text up, metres */
2303
+ offsetY?: number; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2304
+ pick?: Array<number>; /** Points per curved segment of each letter (12) */
2305
+ resolution?: number; /** Slants the letters: x moves by shear ? y */
2306
+ shear?: number; /** The text's size (1: the font's full height is one metre) */
2307
+ size?: number; /** Space width as a multiple (1) */
2308
+ wordSpacing?: number;
2309
+ };
2310
+ /** Convert to Mesh. Converts curves and texts in `objects` (names or ids; the selection without it) into meshes. Acts on `objects`. Reads the selection. Changes the document. */
2311
+ "object.convertToMesh": {
2312
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2313
+ pick?: Array<number>;
2314
+ };
2315
+ /** Set Splines. Replaces the splines of curve `object` with `splines` (points, handles, cyclic). Acts on `object`. Reads the selection. Changes the document. */
2316
+ "curve.setSplines": {
2317
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2318
+ pick?: Array<number>; /** Splines as {type: bezier|poly|nurbs, points: [{co: [x,y,z], left?, right?, leftType?, rightType?: auto|vector|aligned|free, radius?, tilt?, weight?}], cyclic?, resolution?, order?, endpoint?}; B?zier handles left out are automatic */
2319
+ splines: Array<Json>;
2320
+ };
2321
+ /** Select Points. Selects curve points by index in curve edit mode. */
2322
+ "curve.select": {
2323
+ deselect?: boolean; /** Add to the selection */
2324
+ extend?: boolean; /** Control points, counted through the splines in order (handles go with their point) */
2325
+ points?: Array<number>;
2326
+ };
2327
+ /** Move Points. Moves the selected curve points by `offset`. Changes the document. */
2328
+ "curve.translate": {
2329
+ offset: Array<number>;
2330
+ };
2331
+ /** Extrude Points. Extrudes new points from the selected curve end points by `offset`. Changes the document. */
2332
+ "curve.extrude": {
2333
+ offset?: Array<number>;
2334
+ };
2335
+ /** Subdivide. Subdivides the segments between selected curve points. Changes the document. */
2336
+ "curve.subdivide": Record<string, never>;
2337
+ /** Toggle Cyclic. Opens or closes the selected splines. Changes the document. */
2338
+ "curve.toggleCyclic": Record<string, never>;
2339
+ /** Set Handle Type. Sets the selected points' handle type (auto, vector, aligned, free). Changes the document. */
2340
+ "curve.setHandleType": {
2341
+ type: "auto" | "vector" | "aligned" | "free";
2342
+ };
2343
+ /** Delete Points. Deletes the selected curve points. Changes the document. */
2344
+ "curve.deletePoints": Record<string, never>;
2345
+ /** Type Text. Types `text` at the caret of text object `object` in text edit mode. Acts on `object`. Reads the selection. Changes the document. */
2346
+ "text.insert": {
2347
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2348
+ pick?: Array<number>; /** What to type at the caret (or the end) */
2349
+ text: string;
2350
+ };
2351
+ /** Delete Characters. Deletes `count` characters backward (or forward) from the caret in text edit mode. Changes the document. */
2352
+ "text.delete": {
2353
+ count?: number; /** Delete after the caret instead of before */
2354
+ forward?: boolean;
2355
+ };
2356
+ /** Move Caret. Moves the caret in text edit mode by `by`, to `to`, or to a place (start, end, line start, ...) and answers it. */
2357
+ "text.caret": {
2358
+ by?: number; /** A place to go */
2359
+ place?: "start" | "end" | "lineStart" | "lineEnd" | "up" | "down"; /** A character index */
2360
+ to?: number;
2361
+ };
2362
+ /** Lattice. Adds a lattice of `resolution` at `location` and answers its name and object id. Changes the document. */
2363
+ "add.lattice": {
2364
+ location?: Array<number>; /** The object's name */
2365
+ name?: string; /** Points along each side, 1 to 64: one number for all three, or [u, v, w] */
2366
+ resolution?: Json; /** Rotation in degrees, XYZ Euler [x, y, z] */
2367
+ rotation?: Array<number>; /** Scale: the lattice spans this many metres along each axis (1) [x, y, z] */
2368
+ scale?: Array<number>;
2369
+ };
2370
+ /** Lattice Settings. Changes lattice `object`: resolution and interpolation, or resets its points. Acts on `object`. Reads the selection. Changes the document. */
2371
+ "lattice.set": {
2372
+ interpolation?: "bspline" | "linear"; /** The lattice; the active or edited one when left out */
2373
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2374
+ pick?: Array<number>; /** Put every point back where it rests */
2375
+ reset?: boolean; /** Points along each side, 1 to 64: one number for all three, or [u, v, w] */
2376
+ resolution?: Json;
2377
+ };
2378
+ /** Move Lattice Points. Moves lattice points (by index, else the selected ones) by `offset`. Acts on `object`. Reads the selection. Changes the document. */
2379
+ "lattice.movePoints": {
2380
+ object?: Json; /** How far to move them, in the lattice's own axes [x, y, z] */
2381
+ offset: Array<number>; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2382
+ pick?: Array<number>; /** Point indices (u + v ? U + w ? U ? V); the selected points in edit mode when left out */
2383
+ points?: Array<number>;
2384
+ };
2385
+ /** Select Lattice Points. Selects lattice points by index in lattice edit mode. */
2386
+ "lattice.select": {
2387
+ deselect?: boolean; /** Add to the selection */
2388
+ extend?: boolean; /** Point indices */
2389
+ points?: Array<number>;
2390
+ };
2391
+ /** Physics World. Sets the physics world: gravity, frame range, steps and iterations. Changes the document. */
2392
+ "physics.world.set": {
2393
+ frameEnd?: number; /** The first simulated frame */
2394
+ frameStart?: number; /** Gravity in m/s? (default 0, 0, -9.81) [x, y, z] */
2395
+ gravity?: Array<number>; /** Solver iterations per step (1 to 100) */
2396
+ iterations?: number; /** Simulation steps per frame (1 to 100) */
2397
+ substeps?: number; /** How fast simulated time runs (0.01 to 100) */
2398
+ timeScale?: number;
2399
+ };
2400
+ /** Add Rigid Body. Makes `objects` (names or ids; the selection without it) rigid bodies (active or passive) with mass, shape, friction and damping. Acts on `objects`. Reads the selection. Changes the document. */
2401
+ "physics.rigidBody.add": {
2402
+ angularDamping?: number; /** A passive body moved by its animation, pushing active ones */
2403
+ animated?: boolean; /** Below this spin (rad/s) the body may fall asleep */
2404
+ deactivateAngular?: number; /** Below this speed (m/s) the body may fall asleep */
2405
+ deactivateLinear?: number; /** The body may fall asleep when it barely moves (and wakes when something hits it) */
2406
+ deactivation?: boolean; /** Simulated (an active body that is not stays put) */
2407
+ enabled?: boolean; /** Friction, 0 to 10 */
2408
+ friction?: number; /** Linear damping, 0 to 1 */
2409
+ linearDamping?: number; /** Collision margin in metres */
2410
+ margin?: number; /** Mass in kg */
2411
+ mass?: number; /** The objects; the selection when left out */
2412
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2413
+ pick?: Array<number>; /** Bounciness, 0 to 1 */
2414
+ restitution?: number; /** The collision shape (mesh: passive bodies only) */
2415
+ shape?: "box" | "sphere" | "capsule" | "cylinder" | "convexHull" | "mesh"; /** The body starts asleep, hanging where it is until something hits it */
2416
+ startDeactivated?: boolean; /** Active bodies move; passive ones only collide */
2417
+ type?: "active" | "passive";
2418
+ };
2419
+ /** Rigid Body Settings. Changes the rigid body settings of `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2420
+ "physics.rigidBody.set": {
2421
+ angularDamping?: number; /** A passive body moved by its animation, pushing active ones */
2422
+ animated?: boolean; /** Below this spin (rad/s) the body may fall asleep */
2423
+ deactivateAngular?: number; /** Below this speed (m/s) the body may fall asleep */
2424
+ deactivateLinear?: number; /** The body may fall asleep when it barely moves (and wakes when something hits it) */
2425
+ deactivation?: boolean; /** Simulated (an active body that is not stays put) */
2426
+ enabled?: boolean; /** Friction, 0 to 10 */
2427
+ friction?: number; /** Linear damping, 0 to 1 */
2428
+ linearDamping?: number; /** Collision margin in metres */
2429
+ margin?: number; /** Mass in kg */
2430
+ mass?: number; /** The objects; the selection when left out */
2431
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2432
+ pick?: Array<number>; /** Bounciness, 0 to 1 */
2433
+ restitution?: number; /** The collision shape (mesh: passive bodies only) */
2434
+ shape?: "box" | "sphere" | "capsule" | "cylinder" | "convexHull" | "mesh"; /** The body starts asleep, hanging where it is until something hits it */
2435
+ startDeactivated?: boolean; /** Active bodies move; passive ones only collide */
2436
+ type?: "active" | "passive";
2437
+ };
2438
+ /** Remove Rigid Body. Removes the rigid bodies from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2439
+ "physics.rigidBody.remove": {
2440
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2441
+ pick?: Array<number>;
2442
+ };
2443
+ /** Add Cloth. Adds cloth simulation to `objects` (names or ids; the selection without it) with its stiffness, damping and per-system `effectorWeights`. All multiplies each field weight; nonpositive products disable fields. Gravity is independent. Acts on `objects`. Reads the selection. Changes the document. */
2444
+ "physics.cloth.add": {
2445
+ airDamping?: number; /** Bending stiffness */
2446
+ bending?: number; /** How close the cloth comes to collision objects, in metres */
2447
+ collisionDistance?: number; /** Compression stiffness */
2448
+ compression?: number; /** Partial cloth or soft-body influence weights; All multiplies field weights, Gravity is independent */
2449
+ effectorWeights?: {
2450
+ all?: number;
2451
+ drag?: number;
2452
+ force?: number;
2453
+ gravity?: number;
2454
+ turbulence?: number;
2455
+ vortex?: number;
2456
+ wind?: number;
2457
+ }; /** Mass of each vertex in kg */
2458
+ mass?: number; /** The objects; the selection when left out */
2459
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2460
+ pick?: Array<number>; /** The vertex group that stays put (empty: none) */
2461
+ pinGroup?: string; /** Steps per frame (1 to 80) */
2462
+ quality?: number; /** The cloth collides with itself */
2463
+ selfCollision?: boolean; /** How far apart the cloth keeps from itself, in metres */
2464
+ selfDistance?: number; /** Shear stiffness */
2465
+ shear?: number; /** Stretch stiffness */
2466
+ tension?: number;
2467
+ };
2468
+ /** Cloth Settings. Changes cloth settings and partial `effectorWeights` on `objects`. Weights default to 1 and range from -200 to 200; other systems are unaffected. Acts on `objects`. Reads the selection. Changes the document. */
2469
+ "physics.cloth.set": {
2470
+ airDamping?: number; /** Bending stiffness */
2471
+ bending?: number; /** How close the cloth comes to collision objects, in metres */
2472
+ collisionDistance?: number; /** Compression stiffness */
2473
+ compression?: number; /** Partial cloth or soft-body influence weights; All multiplies field weights, Gravity is independent */
2474
+ effectorWeights?: {
2475
+ all?: number;
2476
+ drag?: number;
2477
+ force?: number;
2478
+ gravity?: number;
2479
+ turbulence?: number;
2480
+ vortex?: number;
2481
+ wind?: number;
2482
+ }; /** Mass of each vertex in kg */
2483
+ mass?: number; /** The objects; the selection when left out */
2484
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2485
+ pick?: Array<number>; /** The vertex group that stays put (empty: none) */
2486
+ pinGroup?: string; /** Steps per frame (1 to 80) */
2487
+ quality?: number; /** The cloth collides with itself */
2488
+ selfCollision?: boolean; /** How far apart the cloth keeps from itself, in metres */
2489
+ selfDistance?: number; /** Shear stiffness */
2490
+ shear?: number; /** Stretch stiffness */
2491
+ tension?: number;
2492
+ };
2493
+ /** Remove Cloth. Removes cloth from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2494
+ "physics.cloth.remove": {
2495
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2496
+ pick?: Array<number>;
2497
+ };
2498
+ /** Add Soft Body. Adds a soft body to `objects` (names or ids; the selection without it) with its goal, edge springs, mass, friction and per-system `effectorWeights`. All multiplies each field weight; nonpositive products disable fields. Gravity is independent. Acts on `objects`. Reads the selection. Changes the document. */
2499
+ "physics.softBody.add": {
2500
+ ballSize?: number; /** Springs between vertices two edges apart, 0 to 10 (0: none) */
2501
+ bending?: number; /** Edge damping (0.5) */
2502
+ damping?: number; /** Springs along the mesh's edges (on) */
2503
+ edges?: boolean; /** Partial cloth or soft-body influence weights; All multiplies field weights, Gravity is independent */
2504
+ effectorWeights?: {
2505
+ all?: number;
2506
+ drag?: number;
2507
+ force?: number;
2508
+ gravity?: number;
2509
+ turbulence?: number;
2510
+ vortex?: number;
2511
+ wind?: number;
2512
+ }; /** The last simulated frame (250); after it the body holds */
2513
+ frameEnd?: number; /** The first simulated frame (1); before it the mesh is at rest */
2514
+ frameStart?: number; /** Air friction (0.5) */
2515
+ friction?: number; /** Vertices are drawn to where the mesh puts them (on) */
2516
+ goal?: boolean; /** Goal spring damping (0) */
2517
+ goalDamping?: number; /** The goal weight, 0 to 1; 1 follows the mesh exactly (0.7) */
2518
+ goalDefault?: number; /** The vertex group whose weights scale the goal (empty: every vertex alike) */
2519
+ goalGroup?: string; /** The goal weight at group weight 1, 0 to 1 (1) */
2520
+ goalMax?: number; /** The goal weight at group weight 0, 0 to 1 (0) */
2521
+ goalMin?: number; /** Goal spring stiffness, 0 to 0.999 (0.5) */
2522
+ goalStiffness?: number; /** Mass of each vertex in kg (1) */
2523
+ mass?: number; /** The objects; the selection when left out */
2524
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2525
+ pick?: Array<number>; /** Edge stiffness when stretched, 0 to 0.999 (0.5) */
2526
+ pull?: number; /** Edge stiffness when squeezed, 0 to 0.999 (0.5) */
2527
+ push?: number; /** Vertices keep apart from each other (off) */
2528
+ selfCollision?: boolean; /** How fast simulated time runs (1) */
2529
+ speed?: number;
2530
+ };
2531
+ /** Soft Body Settings. Changes soft-body settings and partial `effectorWeights` on `objects`. Weights default to 1 and range from -200 to 200; other systems are unaffected. Acts on `objects`. Reads the selection. Changes the document. */
2532
+ "physics.softBody.set": {
2533
+ ballSize?: number; /** Springs between vertices two edges apart, 0 to 10 (0: none) */
2534
+ bending?: number; /** Edge damping (0.5) */
2535
+ damping?: number; /** Springs along the mesh's edges (on) */
2536
+ edges?: boolean; /** Partial cloth or soft-body influence weights; All multiplies field weights, Gravity is independent */
2537
+ effectorWeights?: {
2538
+ all?: number;
2539
+ drag?: number;
2540
+ force?: number;
2541
+ gravity?: number;
2542
+ turbulence?: number;
2543
+ vortex?: number;
2544
+ wind?: number;
2545
+ }; /** The last simulated frame (250); after it the body holds */
2546
+ frameEnd?: number; /** The first simulated frame (1); before it the mesh is at rest */
2547
+ frameStart?: number; /** Air friction (0.5) */
2548
+ friction?: number; /** Vertices are drawn to where the mesh puts them (on) */
2549
+ goal?: boolean; /** Goal spring damping (0) */
2550
+ goalDamping?: number; /** The goal weight, 0 to 1; 1 follows the mesh exactly (0.7) */
2551
+ goalDefault?: number; /** The vertex group whose weights scale the goal (empty: every vertex alike) */
2552
+ goalGroup?: string; /** The goal weight at group weight 1, 0 to 1 (1) */
2553
+ goalMax?: number; /** The goal weight at group weight 0, 0 to 1 (0) */
2554
+ goalMin?: number; /** Goal spring stiffness, 0 to 0.999 (0.5) */
2555
+ goalStiffness?: number; /** Mass of each vertex in kg (1) */
2556
+ mass?: number; /** The objects; the selection when left out */
2557
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2558
+ pick?: Array<number>; /** Edge stiffness when stretched, 0 to 0.999 (0.5) */
2559
+ pull?: number; /** Edge stiffness when squeezed, 0 to 0.999 (0.5) */
2560
+ push?: number; /** Vertices keep apart from each other (off) */
2561
+ selfCollision?: boolean; /** How fast simulated time runs (1) */
2562
+ speed?: number;
2563
+ };
2564
+ /** Remove Soft Body. Removes the soft bodies from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2565
+ "physics.softBody.remove": {
2566
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2567
+ pick?: Array<number>;
2568
+ };
2569
+ /** Add Collision. Makes `objects` (names or ids; the selection without it) colliders for cloth, soft bodies, hair, and particles (`damping` for how much they bounce). Acts on `objects`. Reads the selection. Changes the document. */
2570
+ "physics.collision.add": {
2571
+ damping?: number; /** Friction against cloth and soft bodies */
2572
+ friction?: number; /** The objects; the selection when left out */
2573
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2574
+ pick?: Array<number>; /** How far outside the surface cloth and soft bodies stay, in metres */
2575
+ thickness?: number;
2576
+ };
2577
+ /** Remove Collision. Removes collision from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2578
+ "physics.collision.remove": {
2579
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2580
+ pick?: Array<number>;
2581
+ };
2582
+ /** New Force Field. Adds an empty with a force field (wind, vortex, force, turbulence, ...) at `location`. Changes the document. */
2583
+ "physics.field.new": {
2584
+ falloffPower?: number; /** Things are carried along: they also slow by this share of their speed each second */
2585
+ flow?: number; /** Drag: slowing in proportion to speed */
2586
+ linearDrag?: number; /** Where to put it, in metres (the origin when left out) [x, y, z] */
2587
+ location?: Array<number>; /** Beyond this distance it does nothing (0 or less: no limit) */
2588
+ maxDistance?: number; /** Within this distance it is at full strength (0 or less: none) */
2589
+ minDistance?: number; /** The new empty's name */
2590
+ name?: string; /** Drag: slowing in proportion to speed squared */
2591
+ quadraticDrag?: number; /** Rotation in degrees, XYZ Euler (wind and vortex act along its Z) [x, y, z] */
2592
+ rotation?: Array<number>; /** Turbulence: different seeds give different noise */
2593
+ seed?: number; /** Turbulence: the size of its swirls in metres */
2594
+ size?: number; /** How hard it pushes (m/s? on a particle at full strength; drag ignores it) */
2595
+ strength?: number; /** force: away from the origin (towards it when negative); wind: along the object's Z; vortex: round its Z; turbulence: noise; drag: slows things */
2596
+ type?: "force" | "wind" | "vortex" | "turbulence" | "drag";
2597
+ };
2598
+ /** Add Force Field. Adds a force field to `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2599
+ "physics.field.add": {
2600
+ falloffPower?: number; /** Things are carried along: they also slow by this share of their speed each second */
2601
+ flow?: number; /** Drag: slowing in proportion to speed */
2602
+ linearDrag?: number; /** Beyond this distance it does nothing (0 or less: no limit) */
2603
+ maxDistance?: number; /** Within this distance it is at full strength (0 or less: none) */
2604
+ minDistance?: number; /** The objects; the selection when left out */
2605
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2606
+ pick?: Array<number>; /** Drag: slowing in proportion to speed squared */
2607
+ quadraticDrag?: number; /** Turbulence: different seeds give different noise */
2608
+ seed?: number; /** Turbulence: the size of its swirls in metres */
2609
+ size?: number; /** How hard it pushes (m/s? on a particle at full strength; drag ignores it) */
2610
+ strength?: number; /** force: away from the origin (towards it when negative); wind: along the object's Z; vortex: round its Z; turbulence: noise; drag: slows things */
2611
+ type?: "force" | "wind" | "vortex" | "turbulence" | "drag";
2612
+ };
2613
+ /** Force Field Settings. Changes the force field settings of `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2614
+ "physics.field.set": {
2615
+ falloffPower?: number; /** Things are carried along: they also slow by this share of their speed each second */
2616
+ flow?: number; /** Drag: slowing in proportion to speed */
2617
+ linearDrag?: number; /** Beyond this distance it does nothing (0 or less: no limit) */
2618
+ maxDistance?: number; /** Within this distance it is at full strength (0 or less: none) */
2619
+ minDistance?: number; /** The objects; the selection when left out */
2620
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2621
+ pick?: Array<number>; /** Drag: slowing in proportion to speed squared */
2622
+ quadraticDrag?: number; /** Turbulence: different seeds give different noise */
2623
+ seed?: number; /** Turbulence: the size of its swirls in metres */
2624
+ size?: number; /** How hard it pushes (m/s? on a particle at full strength; drag ignores it) */
2625
+ strength?: number; /** force: away from the origin (towards it when negative); wind: along the object's Z; vortex: round its Z; turbulence: noise; drag: slows things */
2626
+ type?: "force" | "wind" | "vortex" | "turbulence" | "drag";
2627
+ };
2628
+ /** Remove Force Field. Removes the force fields from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2629
+ "physics.field.remove": {
2630
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2631
+ pick?: Array<number>;
2632
+ };
2633
+ /** Add Rigid Body Constraint. Adds a rigid body constraint (fixed, hinge, slider, spring, motor, ...) between two objects. A motor independently drives translation and rotation on the constraint X axis. Acts on `objects`. Reads the selection. Changes the document. */
2634
+ "physics.constraint.add": {
2635
+ angleLimit?: Array<Json>; /** Generic spring: per axis X, Y, Z a [lower, upper] in degrees, or null for free */
2636
+ angularLimits?: Array<Json>; /** Motor: maximum angular impulse control, 0 to 1000000000 (default 1); step impulse is value times seconds */
2637
+ angularMaxImpulse?: number; /** Motor: enable rotation about the constraint's X axis (default false) */
2638
+ angularMotor?: boolean; /** Generic spring: per axis X, Y, Z a stiffness in N?m/rad, or null for none */
2639
+ angularSprings?: Array<Json>; /** Motor: body 1 relative to body 2 in rad/s, -100000 to 100000 (default 1) */
2640
+ angularTargetVelocity?: number; /** The constraint breaks when it must push harder than the threshold */
2641
+ breakable?: boolean; /** The impulse (N?s) in one step that breaks it */
2642
+ breakingThreshold?: number; /** The joined bodies pass through each other (default true) */
2643
+ disableCollisions?: boolean; /** Slider: [lower, upper] in metres along X, or null for none */
2644
+ distanceLimit?: Array<Json>; /** The constraint acts */
2645
+ enabled?: boolean; /** Generic spring: per axis X, Y, Z a [lower, upper] in metres, or null for free */
2646
+ linearLimits?: Array<Json>; /** Motor: maximum linear impulse control, 0 to 1000000000 (default 1); step impulse is value times seconds */
2647
+ linearMaxImpulse?: number; /** Motor: enable translation along the constraint's X axis (default false) */
2648
+ linearMotor?: boolean; /** Generic spring: per axis X, Y, Z a stiffness in N/m, or null for none */
2649
+ linearSprings?: Array<Json>; /** Motor: body 1 relative to body 2 in m/s, -100000 to 100000 (default 1) */
2650
+ linearTargetVelocity?: number; /** The first rigid body joined */
2651
+ object1?: Json; /** The second rigid body joined */
2652
+ object2?: Json; /** The objects; the selection when left out */
2653
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2654
+ pick?: Array<number>; /** Generic spring: the springs' damping */
2655
+ springDamping?: number; /** fixed: one piece; point: a ball joint; hinge: turns about Z; slider: slides along X; genericSpring: per axis limits and springs; motor: drives along/about X */
2656
+ type?: "fixed" | "point" | "hinge" | "slider" | "genericSpring" | "motor";
2657
+ };
2658
+ /** Rigid Body Constraint Settings. Changes a rigid body constraint's settings. Acts on `objects`. Reads the selection. Changes the document. */
2659
+ "physics.constraint.set": {
2660
+ angleLimit?: Array<Json>; /** Generic spring: per axis X, Y, Z a [lower, upper] in degrees, or null for free */
2661
+ angularLimits?: Array<Json>; /** Motor: maximum angular impulse control, 0 to 1000000000 (default 1); step impulse is value times seconds */
2662
+ angularMaxImpulse?: number; /** Motor: enable rotation about the constraint's X axis (default false) */
2663
+ angularMotor?: boolean; /** Generic spring: per axis X, Y, Z a stiffness in N?m/rad, or null for none */
2664
+ angularSprings?: Array<Json>; /** Motor: body 1 relative to body 2 in rad/s, -100000 to 100000 (default 1) */
2665
+ angularTargetVelocity?: number; /** The constraint breaks when it must push harder than the threshold */
2666
+ breakable?: boolean; /** The impulse (N?s) in one step that breaks it */
2667
+ breakingThreshold?: number; /** The joined bodies pass through each other (default true) */
2668
+ disableCollisions?: boolean; /** Slider: [lower, upper] in metres along X, or null for none */
2669
+ distanceLimit?: Array<Json>; /** The constraint acts */
2670
+ enabled?: boolean; /** Generic spring: per axis X, Y, Z a [lower, upper] in metres, or null for free */
2671
+ linearLimits?: Array<Json>; /** Motor: maximum linear impulse control, 0 to 1000000000 (default 1); step impulse is value times seconds */
2672
+ linearMaxImpulse?: number; /** Motor: enable translation along the constraint's X axis (default false) */
2673
+ linearMotor?: boolean; /** Generic spring: per axis X, Y, Z a stiffness in N/m, or null for none */
2674
+ linearSprings?: Array<Json>; /** Motor: body 1 relative to body 2 in m/s, -100000 to 100000 (default 1) */
2675
+ linearTargetVelocity?: number; /** The first rigid body joined */
2676
+ object1?: Json; /** The second rigid body joined */
2677
+ object2?: Json; /** The objects; the selection when left out */
2678
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2679
+ pick?: Array<number>; /** Generic spring: the springs' damping */
2680
+ springDamping?: number; /** fixed: one piece; point: a ball joint; hinge: turns about Z; slider: slides along X; genericSpring: per axis limits and springs; motor: drives along/about X */
2681
+ type?: "fixed" | "point" | "hinge" | "slider" | "genericSpring" | "motor";
2682
+ };
2683
+ /** Remove Rigid Body Constraint. Removes rigid body constraints from `objects` (names or ids; the selection without it). Acts on `objects`. Reads the selection. Changes the document. */
2684
+ "physics.constraint.remove": {
2685
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2686
+ pick?: Array<number>;
2687
+ };
2688
+ /** Connect Rigid Bodies. Connects `objects` (names or ids; the selection without it) pairwise with rigid body constraints of `type`. Acts on `objects`. Reads the selection. Changes the document. */
2689
+ "physics.constraint.connect": {
2690
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2691
+ pick?: Array<number>; /** The kind of constraint (default fixed) */
2692
+ type?: "fixed" | "point" | "hinge" | "slider" | "genericSpring" | "motor";
2693
+ };
2694
+ /** Bake Physics. Bakes the physics simulation over the frame range; answers the cache state. Without anything simulated it fails. Nonfinite cloth/soft-body motion fails explicitly, discards the derived cache and stops automatic baking until Bake is requested again. */
2695
+ "physics.bake": {
2696
+ wait?: boolean;
2697
+ };
2698
+ /** Bake Physics Step. Bakes `frames` more frames of the simulation and answers the cache state; divergent cloth/soft-body motion fails and stops automatic baking. */
2699
+ "physics.bakeStep": {
2700
+ frames?: number;
2701
+ };
2702
+ /** Free Physics Bake. Frees the baked physics cache and answers its state. */
2703
+ "physics.free": Record<string, never>;
2704
+ /** New Node Group. Creates a node group (geometry, shader, compositor) for a modifier, material, world or as a library group. Acts on `object`. Changes the document. */
2705
+ "nodes.newGroup": {
2706
+ material?: Json; /** With object: the Geometry Nodes modifier (its index) to use the group instead of adding one */
2707
+ modifier?: number; /** The group's name (Geometry Nodes, Shader, or Volume when left out) */
2708
+ name?: string; /** geometry: add a Geometry Nodes modifier using the group to this mesh object */
2709
+ object?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2710
+ pick?: Array<number>; /** geometry (the default): a Geometry Nodes group; shader: a material's surface and volume */
2711
+ tree?: "geometry" | "shader"; /** shader: the group is the world's volume (a Principled Volume into the Material Output's Volume) */
2712
+ world?: boolean;
2713
+ };
2714
+ /** Remove Node Group. Deletes node group `group`. Changes the document. */
2715
+ "nodes.removeGroup": {
2716
+ group?: Json;
2717
+ };
2718
+ /** Rename Node Group. Renames node group `group`. Changes the document. */
2719
+ "nodes.renameGroup": {
2720
+ group?: Json; /** The new name */
2721
+ name: string;
2722
+ };
2723
+ /** Add Node. Adds a node of `kind` (see `nodes.describe`) to `group` at `location` with input `values`. Changes the document. */
2724
+ "nodes.addNode": {
2725
+ group?: Json; /** The node's kind (nodes.describe lists their sockets) */
2726
+ kind: "groupInput" | "groupOutput" | "group" | "repeatInput" | "repeatOutput" | "simulationInput" | "simulationOutput" | "meshCube" | "meshGrid" | "meshUvSphere" | "meshIcoSphere" | "meshCylinder" | "meshCone" | "meshLine" | "meshCircle" | "curveLine" | "curveCircle" | "curveBezierSegment" | "curveQuadrilateral" | "curveSpiral" | "curveStar" | "curveToMesh" | "curveToPoints" | "fillCurve" | "resampleCurve" | "trimCurve" | "reverseCurve" | "setCurveRadius" | "setCurveTilt" | "setSplineType" | "setNurbsOrder" | "setNurbsWeight" | "setSplineCyclic" | "setSplineResolution" | "splineParameter" | "curveLength" | "endpointSelection" | "transform" | "joinGeometry" | "setPosition" | "deleteGeometry" | "mergeByDistance" | "subdivideMesh" | "subdivisionSurface" | "extrudeMesh" | "meshToPoints" | "meshToCurve" | "distributePointsOnFaces" | "pointsToVertices" | "instanceOnPoints" | "realizeInstances" | "setMaterial" | "storeNamedAttribute" | "captureAttribute" | "position" | "normal" | "index" | "value" | "vector" | "objectInfo" | "separateXyz" | "combineXyz" | "math" | "vectorMath" | "randomValue" | "compare" | "switch" | "mapRange" | "sceneTime" | "namedAttribute" | "domainSize" | "attributeStatistic" | "accumulateField" | "meshBoolean" | "dualMesh" | "flipFaces" | "splitEdges" | "triangulate" | "scaleElements" | "meshIsland" | "edgeAngle" | "faceArea" | "edgeNeighbors" | "sampleIndex" | "sampleNearest" | "raycast" | "geometryProximity" | "translateInstances" | "rotateInstances" | "scaleInstances" | "instanceRotation" | "instanceScale" | "rotateEuler" | "rotateRotation" | "rotateVector" | "eulerToRotation" | "rotationToEuler" | "axisAngleToRotation" | "invertRotation" | "renderLayers" | "image" | "rgb" | "compositorOutput" | "viewer" | "alphaOver" | "brightContrast" | "colorBalance" | "exposure" | "hueSaturation" | "invert" | "mixColor" | "rgbCurves" | "blur" | "denoise" | "glare" | "defocus" | "vectorBlur" | "kuwahara" | "cryptomatte" | "chromaKey" | "colorKey" | "differenceKey" | "distanceKey" | "keying" | "luminanceKey" | "ellipseMask" | "lensDistortion" | "crop" | "flip" | "rotate" | "scale" | "imageTransform" | "translate" | "materialOutput" | "textureCoordinate" | "geometryInfo" | "fresnel" | "layerWeight" | "principledBsdf" | "diffuseBsdf" | "glossyBsdf" | "glassBsdf" | "transparentBsdf" | "emission" | "volumeAbsorption" | "volumeScatter" | "principledVolume" | "mixShader" | "addShader" | "imageTexture" | "noiseTexture" | "voronoiTexture" | "gradientTexture" | "checkerTexture" | "waveTexture" | "colorRamp" | "separateColor" | "combineColor" | "mapping" | "bump" | "normalMap"; /** [x, y] in the editor's units */
2727
+ location?: Array<number>; /** Socket and setting values by id, as nodes.setValue takes them */
2728
+ values?: {
2729
+ [key: string]: Json;
2730
+ };
2731
+ };
2732
+ /** Remove Nodes. Removes nodes by index from `group`. Changes the document. */
2733
+ "nodes.removeNodes": {
2734
+ group?: Json; /** The nodes' ids */
2735
+ nodes: Array<number>;
2736
+ };
2737
+ /** Move Nodes. Moves nodes of `group` to `location` or by `offset` in the node editor. Changes the document. */
2738
+ "nodes.moveNodes": {
2739
+ group?: Json; /** [x, y] to put the (one) node at */
2740
+ location?: Array<number>; /** The nodes' ids */
2741
+ nodes: Array<number>; /** [dx, dy] to move each by */
2742
+ offset?: Array<number>;
2743
+ };
2744
+ /** Set Node Value. Sets input or property `id` of node `node` in `group` to `value`. Changes the document. */
2745
+ "nodes.setValue": {
2746
+ group?: Json; /** An input socket's or a setting's id */
2747
+ id: string; /** The node's id: its id */
2748
+ node: number; /** The value: a number, [x, y, z], a boolean, a setting's choice, an object or material id, a text; null clears it */
2749
+ value?: Json;
2750
+ };
2751
+ /** Link Sockets. Links output socket `fromSocket` of node `from` to input socket `toSocket` of node `to` in `group`. Changes the document. */
2752
+ "nodes.link": {
2753
+ from: number; /** The output socket's id */
2754
+ fromSocket: string; /** The group's id or name; the only group when left out */
2755
+ group?: Json; /** The node whose input to link: its id */
2756
+ to: number; /** The input socket's id; a link already there is replaced unless the input takes several */
2757
+ toSocket: string;
2758
+ };
2759
+ /** Unlink Sockets. Removes the link between two sockets in `group`. Changes the document. */
2760
+ "nodes.unlink": {
2761
+ from?: number; /** Only the link from this output socket */
2762
+ fromSocket?: string; /** The group's id or name; the only group when left out */
2763
+ group?: Json; /** The node whose input to unlink: its id */
2764
+ to: number; /** The input socket's id */
2765
+ toSocket: string;
2766
+ };
2767
+ /** Add Group Input. Adds an input socket of `type` to node group `group`'s interface. Changes the document. */
2768
+ "nodes.addInput": {
2769
+ default?: Json; /** The group's id or name; the only group when left out */
2770
+ group?: Json; /** The input's name, unique in the group */
2771
+ name: string; /** What the input carries */
2772
+ type: "geometry" | "float" | "int" | "bool" | "vector" | "rotation" | "object" | "material" | "string";
2773
+ };
2774
+ /** Remove Group Input. Removes input `name` from node group `group`'s interface. Changes the document. */
2775
+ "nodes.removeInput": {
2776
+ group?: Json; /** The input's name */
2777
+ name: string;
2778
+ };
2779
+ /** Add Group Output. Adds an output socket of `type` to node group `group`'s interface. Changes the document. */
2780
+ "nodes.addOutput": {
2781
+ group?: Json; /** The output's name, unique in the group (a Group node using the group gives it) */
2782
+ name: string; /** What the output carries */
2783
+ type: "geometry" | "float" | "int" | "bool" | "vector" | "rotation";
2784
+ };
2785
+ /** Remove Group Output. Removes output `name` from node group `group`'s interface. Changes the document. */
2786
+ "nodes.removeOutput": {
2787
+ group?: Json; /** The output's name */
2788
+ name: string;
2789
+ };
2790
+ /** Add Zone Item. Adds an item to a repeat or simulation zone node's state. Changes the document. */
2791
+ "nodes.addZoneItem": {
2792
+ group?: Json; /** The item's name, unique in the zone: a socket on both of its nodes */
2793
+ name: string; /** Either node of the zone: its id */
2794
+ node: number; /** What the item carries */
2795
+ type: "geometry" | "float" | "int" | "bool" | "vector" | "rotation";
2796
+ };
2797
+ /** Remove Zone Item. Removes an item from a repeat or simulation zone node's state. Changes the document. */
2798
+ "nodes.removeZoneItem": {
2799
+ group?: Json; /** The item's name */
2800
+ name: string; /** Either node of the zone: its id */
2801
+ node: number;
2802
+ };
2803
+ /** Describe Node Kinds. Lists the node kinds a tree takes (or one `kind`) with their inputs, outputs and properties, for `nodes.addNode`. */
2804
+ "nodes.describe": {
2805
+ group?: Json; /** One kind; every kind when left out */
2806
+ kind?: string; /** Only the kinds a geometry, a compositing, or a shader group takes */
2807
+ tree?: "geometry" | "compositor" | "shader";
2808
+ };
2809
+ /** New Compositor. Creates a compositing node group and uses it for renders when `use`. Changes the document. */
2810
+ "compositor.new": {
2811
+ name?: string; /** Make renders pass through it (true) */
2812
+ use?: boolean;
2813
+ };
2814
+ /** Compositing. Turns compositing on or off and sets which group renders use. Changes the document. */
2815
+ "compositor.set": {
2816
+ compositing?: boolean; /** The compositing group renders pass through: its id or name; null for none: its id or name */
2817
+ group?: Json;
2818
+ };
2819
+ /** Set Compositing Image. Sets the image an image node of the compositing group reads (workspace path or base64). Changes the document. */
2820
+ "compositor.setImage": {
2821
+ base64?: string; /** Take the node's picture away */
2822
+ clear?: boolean; /** The compositing group (the one renders use when left out): its id or name */
2823
+ group?: Json; /** An image the scene has already, by its hash */
2824
+ image?: string; /** The image's name, with base64 */
2825
+ name?: string; /** The Image node's id */
2826
+ node: number; /** An image file (PNG, JPEG, or Radiance HDR) to read */
2827
+ path?: Json;
2828
+ };
2829
+ /** Pick Matte. Adds the name under `x`, `y` of the render to a Cryptomatte node's matte (or takes it away with `remove`). Reads the time. Changes the document. */
2830
+ "compositor.pickMatte": {
2831
+ group?: Json; /** The Cryptomatte node's id */
2832
+ node: number; /** Take the name away from the matte instead (false) */
2833
+ remove?: boolean; /** Across the render, 0 (left) to 1 (right) */
2834
+ x: number; /** Down the render, 0 (top) to 1 (bottom) */
2835
+ y: number;
2836
+ };
2837
+ /** Preview Compositing. Answers the compositing group's result (or a viewer node) as a picture of `size`. */
2838
+ "compositor.preview": {
2839
+ group?: Json; /** The longer side of the preview in pixels, 16 to 2048 (480) */
2840
+ size?: number; /** Answer what the Viewer node shows instead of the output (false) */
2841
+ viewer?: boolean;
2842
+ };
2843
+ /** Camera Move. Keys a preset camera move round `target` (an object or a point) from frame `start` for `duration` frames, turning to aim at the target, as one undo step: pushIn (dolly in by `amount`), pushHover (push in 18 frames swinging `yaw` and `tilt`, hover creeping in, settle back), orbit (`degrees` round at constant speed, `easeEnds` only at the ends), craneRise (from close and low, `scale` 3 to 1, rise and pull back to where the camera is), reveal (from a close-up out to where the camera is), pullBack (out by `amount`), whip (a fast pan to `to`, turning motion blur on), follow (keeps an `offset` from a moving object, aimed `lead` seconds ahead, lagging by `smoothing` seconds), zoomThrough (straight in to the target's surface, the distance shrinking in log space so the approach looks steady; `through` arrives at full speed with the surface's colour filling the frame), pullOut (the reverse: from filling the frame with the surface back out to a wide shot). Moves start where the camera is and as it looks at `start` (`from: "current"`), so they chain into one continuous take; `position` builds the move round that place instead. Optional `lens` to reach and `ease` [x1, y1, x2, y2]. Eases are baked as one linear key per frame. Reads the time. Changes the document. */
2844
+ "camera.move": {
2845
+ amount?: number; /** The camera; the scene's camera when left out */
2846
+ camera?: Json; /** pushHover: share of the distance it drifts in while hovering, 0 to 0.015 (0.015) */
2847
+ creep?: number; /** orbit: degrees round the target, counter-clockwise seen from above; negative turns clockwise (90) */
2848
+ degrees?: number; /** pullOut: metres from the target to the wide shot it ends on, back along the camera's line of sight (the camera's distance, or 8 times the target's half-size when it is closer than its size) */
2849
+ distance?: number; /** Frames the move takes, 1 to 10000 (pushIn 45, pushHover 90, orbit 90, craneRise 110, reveal 60, pullBack 45, whip 10, follow 90) */
2850
+ duration?: number; /** A cubic-bezier [x1, y1, x2, y2] instead of the preset's main ease (x1 and x2 from 0 to 1) */
2851
+ ease?: Array<number>; /** orbit: speed up and slow down only at the ends (none: constant speed throughout) */
2852
+ easeEnds?: "none" | "in" | "out" | "inOut"; /** Where the move starts: current, where the camera is and how it looks at `start` (the default), so moves chain without a jump; position, round `position` aimed at the target from the first frame (the default when `position` is given) */
2853
+ from?: "current" | "position"; /** zoomThrough and pullOut: metres from the surface where the move ends or starts (1.5 times the camera's near clipping distance) */
2854
+ gap?: number; /** orbit: height above the target in metres (where the camera is) */
2855
+ height?: number; /** follow: seconds ahead of the object the camera aims, 0 to 10 (0.1) */
2856
+ lead?: number; /** Focal length in millimetres to reach by the end, 1 to 5000 (unchanged) */
2857
+ lens?: number; /** whip: turn the scene's motion blur on with a 0.5-frame shutter (true); it shows in path-traced renders */
2858
+ motionBlur?: boolean; /** follow: where the camera keeps to, from the object's centre, in metres (the camera's offset at `start`) [x, y, z] */
2859
+ offset?: Array<number>; /** Where the camera is, instead of where it is at `start` (implies `from: "position"`) [x, y, z] */
2860
+ position?: Array<number>; /** The move */
2861
+ preset: "pushIn" | "pushHover" | "orbit" | "craneRise" | "reveal" | "pullBack" | "whip" | "follow" | "zoomThrough" | "pullOut"; /** orbit: horizontal distance from the target in metres (where the camera is) */
2862
+ radius?: number; /** craneRise: degrees the camera rises over the target (25) */
2863
+ rise?: number; /** craneRise and reveal: how many times larger the target looks at the start (3, 2.5) */
2864
+ scale?: number; /** follow: seconds the camera lags behind (a critically damped spring), 0 to 10; 0 sticks rigidly (0.3) */
2865
+ smoothing?: number; /** The first frame of the move (the current frame) */
2866
+ start?: number; /** What the camera looks at and moves around (required, except for whip from where the camera is); follow: the object it follows */
2867
+ target?: Json; /** zoomThrough: arrive at full speed instead of slowing to rest, for a cut on the colour that fills the frame (false) */
2868
+ through?: boolean; /** pushHover: degrees it rises during the push (8) */
2869
+ tilt?: number; /** whip: what the camera swings to */
2870
+ to?: Json; /** pushHover: degrees the camera swings round the target during the push (34) */
2871
+ yaw?: number;
2872
+ };
2873
+ /** Camera Shake. Adds a decaying shake on top of the camera's keys from `frame` on (nothing before), as one undo step: jolts of `amplitude` metres and `rotation` degrees at `frequency` per second, dying away at `decay` per second; seeded noise, so the same `seed` gives the same shake. Run it after the camera moves it rides on. Reads the time. Changes the document. */
2874
+ "camera.shake": {
2875
+ amplitude?: number; /** The camera; the scene's camera when left out */
2876
+ camera?: Json; /** How fast it dies away, per second: the strength falls by e every 1/decay seconds, 0.1 to 1000 (9) */
2877
+ decay?: number; /** The frame the shake hits, at full strength (the current frame) */
2878
+ frame?: number; /** Jolts per second, 0.1 to 120 (14) */
2879
+ frequency?: number; /** Degrees it jolts in pitch and yaw at first (half that in roll), 0 to 45 (0.6) */
2880
+ rotation?: number; /** Picks a different, repeatable shake (0) */
2881
+ seed?: number;
2882
+ };
2883
+ /** Handheld Camera. Adds a slow handheld float on top of the camera's keys from `start` to `end`, as one undo step: two sine sways of `period` seconds (2.7 and 4.1) up to `amount` metres and `rotation` degrees, fading to exactly nothing inside each of `holds` ([[first, last], ...]) and at its ends over 6 frames. Run it after the camera moves it rides on. Reads the time. Changes the document. */
2884
+ "camera.handheld": {
2885
+ amount?: number; /** The camera; the scene's camera when left out */
2886
+ camera?: Json; /** The last frame of the float (the scene's last frame) */
2887
+ end?: number; /** Frame ranges [[first, last], ...] where the camera is dead still; the float fades out over the 6 frames before each and back in over the 6 after */
2888
+ holds?: Array<Array<number>>; /** How slowly it sways: two sine waves added together ([2.7, 4.1] seconds) */
2889
+ period?: Json; /** Degrees it drifts at most in pitch and yaw (half that in roll), 0 to 45 (0.25) */
2890
+ rotation?: number; /** Picks a different, repeatable sway (0) */
2891
+ seed?: number; /** The first frame of the float (the scene's first frame) */
2892
+ start?: number;
2893
+ };
2894
+ /** Studio Lights. Builds or updates a three-point light rig on `target` as one undo step: Key Light (a spot camera-left), Fill Light (a cool area light), Rim Light (a warm spot from behind), named so they can be edited; sets the world strength, ambient occlusion, and the AgX view. `preset` product, dramatic, or soft; `distance` in metres. Changes the document. */
2895
+ "light.studio": {
2896
+ distance?: number; /** The rig's mood (product) */
2897
+ preset?: "product" | "dramatic" | "soft"; /** What the lights point at */
2898
+ target: Json;
2899
+ };
2900
+ /** Drop In. Keys `objects` falling in from `height` metres above where they rest at `start`, accelerating as under gravity over `duration` frames, with an optional `bounce` and a stretch, squash and settle as they land, as one undo step. Acts on `objects`. Reads the selection, time. Changes the document. */
2901
+ "object.drop": {
2902
+ bounce?: number; /** Frames the fall takes, 1 to 10000 (12) */
2903
+ duration?: number; /** Metres above where they rest that they fall from (2) */
2904
+ height?: number; /** The objects; the selection when left out */
2905
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2906
+ pick?: Array<number>; /** Stretch as they land, squash and settle (scale 1.06, 0.97, 1 over 4 frames) (true) */
2907
+ squash?: boolean; /** The frame the fall starts (the current frame) */
2908
+ start?: number;
2909
+ };
2910
+ /** Hop. Keys `objects` hopping on a ballistic arc from where they are at `start` to `to` (a point for their centre, or an object to land on top of) over `duration` frames, rising `height` above the higher end, with optional `spin` degrees, landing with a squash that rings out (`impact` {squash, frames}), as one undo step. Answers the landing frame. Acts on `objects`. Reads the selection, time. Changes the document. */
2911
+ "object.hop": {
2912
+ duration?: number; /** Metres the arc rises above the higher of its two ends, 0 to 10000 (0.6) */
2913
+ height?: number; /** The squash and stretch as they land ({squash: 0.12, frames: 8}) */
2914
+ impact?: Json; /** The objects; the selection when left out. They hop together, keeping their places relative to one another */
2915
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2916
+ pick?: Array<number>; /** Degrees they turn about X, Y and Z in the air [x, y, z] */
2917
+ spin?: Array<number>; /** The frame they take off (the current frame) */
2918
+ start?: number; /** Where they land: a point their centre lands on, or an object they land on top of */
2919
+ to: Json;
2920
+ };
2921
+ /** Gather. Keys `objects` swirling in from where they are at `start` to an evenly spaced ring of `radius` round `center` (0: a cluster just touching), each on a spiral that turns `arc` degrees on the way, `stagger` frames apart (shrinking gaps with `accelerate`), each over `duration` frames, as one undo step. Acts on `objects`. Reads the selection, time. Changes the document. */
2922
+ "object.gather": {
2923
+ accelerate?: boolean; /** Degrees each swirls round the centre on the way, counter-clockwise seen from above; negative turns clockwise (90) */
2924
+ arc?: number; /** What they gather round: a point, or an object's bounding-box centre */
2925
+ center: Json; /** Frames each takes, 1 to 10000 (30) */
2926
+ duration?: number; /** Height in metres of the ring (each keeps its own height) */
2927
+ level?: number; /** accelerate: the last gap in frames (0.2) */
2928
+ minStagger?: number; /** The objects, in the order they set off; the selection when left out */
2929
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2930
+ pick?: Array<number>; /** Metres from the centre to the ring they end on, 0 to 10000; 0 packs them into a cluster just touching (half their mean distance from the centre) */
2931
+ radius?: number; /** Degrees each turns about X, Y and Z on the way [x, y, z] */
2932
+ spin?: Array<number>; /** Frames between one setting off and the next (2; 4 with accelerate) */
2933
+ stagger?: number; /** The frame the first sets off (the current frame) */
2934
+ start?: number;
2935
+ };
2936
+ /** Wave. Keys a wave running out from `origin` at `speed` metres a second over `objects`, as one undo step: as it reaches each one (by its distance), it bumps in size by `amount` (property scale) or switches its own material's base colour to `color` and leaves it there (property color), over `duration` frames. Separate objects only, not an Array modifier's copies. Acts on `objects`. Reads the selection, time. Changes the document. */
2937
+ "object.wave": {
2938
+ amount?: number; /** color: the colour each switches to (#rrggbb or linear [r, g, b]) */
2939
+ color?: Json; /** Frames each object's bump or switch takes, 1 to 10000 (10) */
2940
+ duration?: number; /** The objects; the selection when left out */
2941
+ objects?: Json; /** Where the wave starts: a point, or an object's bounding-box centre */
2942
+ origin: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2943
+ pick?: Array<number>; /** What the wave does: scale, a bump in size; color, switches each one's material base colour to `color` and leaves it there (scale) */
2944
+ property?: "scale" | "color"; /** Metres a second the wave travels, 0.001 to 100000 (4) */
2945
+ speed?: number; /** The frame the wave sets off from `origin` (the current frame) */
2946
+ start?: number;
2947
+ };
2948
+ /** Pop In. Keys `objects` growing from nothing to their size with an overshoot over `duration` frames, one after another `stagger` frames apart (shrinking gaps with `accelerate`), as one undo step. Acts on `objects`. Reads the selection, time. Changes the document. */
2949
+ "object.pop": {
2950
+ accelerate?: boolean; /** Frames each takes to grow, 1 to 10000 (12) */
2951
+ duration?: number; /** accelerate: the last gap in frames (0.2) */
2952
+ minStagger?: number; /** The objects, in the order they pop; the selection when left out */
2953
+ objects?: Json; /** Instead of `object`/`objects`: a world point [x, y, z] in metres; the command acts on the object there now (the smallest whose mesh's bounds hold the point, else the nearest light, camera, empty, curve, text, lattice or armature whose origin is within 0.25 m). A place: with `basis`, a write by it is refused when what is at the point is no longer what was there (moved away, another moved in, its parent moved) */
2954
+ pick?: Array<number>; /** Frames between one starting and the next (3; 4 with accelerate) */
2955
+ stagger?: number; /** The frame the first one starts (the current frame) */
2956
+ start?: number;
2957
+ };
2958
+ }
2959
+ /** A Scene file opened with `openDocument<Scene, SceneCommands>`. */
2960
+ export type SceneDocument = ModelDocument<Scene, SceneCommands>;
2961
+ export type SceneContext = RequestContext<Scene, SceneCommands>;
2962
+ export {};