blockbench-types 5.1.0 → 5.2.0-beta.0-next.2

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 (102) hide show
  1. package/README.md +30 -30
  2. package/custom/animation.d.ts +257 -256
  3. package/custom/animation_controller.d.ts +124 -124
  4. package/custom/blockbench.d.ts +73 -73
  5. package/custom/canvas.d.ts +324 -307
  6. package/custom/codec.d.ts +182 -182
  7. package/custom/copy_paste.d.ts +43 -42
  8. package/custom/cube.d.ts +151 -151
  9. package/custom/desktop.d.ts +61 -73
  10. package/custom/display_mode.d.ts +141 -137
  11. package/custom/edit_session.d.ts +38 -37
  12. package/custom/global.d.ts +181 -168
  13. package/custom/group.d.ts +113 -113
  14. package/custom/interface.d.ts +88 -78
  15. package/custom/io.d.ts +12 -12
  16. package/custom/{toolbars.d.ts → keybind.d.ts} +150 -221
  17. package/custom/keyframe.d.ts +94 -94
  18. package/custom/libs.d.ts +13 -13
  19. package/custom/menu_bar.d.ts +66 -0
  20. package/custom/mesh.d.ts +196 -196
  21. package/custom/misc.d.ts +196 -199
  22. package/custom/molang.d.ts +159 -159
  23. package/custom/outliner.d.ts +158 -158
  24. package/custom/painter.d.ts +102 -69
  25. package/custom/preview_scene.d.ts +120 -120
  26. package/custom/screencam.d.ts +71 -71
  27. package/custom/spline_mesh.d.ts +190 -189
  28. package/custom/texture_group.d.ts +68 -68
  29. package/custom/textures.d.ts +526 -515
  30. package/custom/timeline.d.ts +66 -66
  31. package/custom/undo.d.ts +209 -208
  32. package/custom/util/version_util.d.ts +32 -32
  33. package/custom/util.d.ts +235 -235
  34. package/custom/uveditor.d.ts +3 -3
  35. package/custom/validator.d.ts +99 -99
  36. package/documentation.md +12 -12
  37. package/generated/animations/mirror_animating.d.ts +7 -0
  38. package/generated/animations/timeline_animators.d.ts +1 -1
  39. package/generated/api.d.ts +8 -1
  40. package/generated/file_system.d.ts +2 -1
  41. package/generated/find_replace.d.ts +6 -0
  42. package/generated/formats/standards/obj.d.ts +9 -11
  43. package/generated/interface/actions.d.ts +16 -12
  44. package/generated/interface/form.d.ts +2 -1
  45. package/generated/interface/main_tools.d.ts +23 -0
  46. package/generated/interface/menu.d.ts +141 -0
  47. package/generated/interface/menu_bar.d.ts +2 -3
  48. package/generated/interface/resize_lines.d.ts +2 -0
  49. package/generated/interface/settings.d.ts +6 -2
  50. package/generated/interface/shared_actions.d.ts +5 -0
  51. package/generated/interface/start_screen.d.ts +62 -42
  52. package/generated/interface/toolbars.d.ts +146 -46
  53. package/generated/io/format.d.ts +1 -0
  54. package/generated/io/project.d.ts +10 -2
  55. package/generated/lib/CanvasFrame.d.ts +1 -0
  56. package/generated/main.d.ts +4 -1
  57. package/generated/modeling/mesh/add_mesh.d.ts +6 -0
  58. package/generated/modeling/mesh/proportional_edit.d.ts +15 -13
  59. package/generated/modeling/mesh/util.d.ts +8 -2
  60. package/generated/modeling/mirror_modeling.d.ts +4 -0
  61. package/generated/modeling/weight_paint.d.ts +11 -0
  62. package/generated/modes.d.ts +2 -2
  63. package/generated/native_apis.d.ts +3 -0
  64. package/generated/outliner/abstract/outliner_element.d.ts +1 -0
  65. package/generated/outliner/abstract/outliner_node.d.ts +1 -0
  66. package/generated/outliner/types/armature.d.ts +1 -1
  67. package/generated/outliner/types/armature_bone.d.ts +1 -1
  68. package/generated/outliner/types/billboard.d.ts +1 -1
  69. package/generated/outliner/types/bounding_box.d.ts +1 -1
  70. package/generated/outliner/types/cube.d.ts +1 -1
  71. package/generated/outliner/types/group.d.ts +1 -1
  72. package/generated/outliner/types/locator.d.ts +1 -1
  73. package/generated/outliner/types/mesh.d.ts +1 -1
  74. package/generated/outliner/types/null_object.d.ts +1 -1
  75. package/generated/outliner/types/spline_mesh.d.ts +1 -2
  76. package/generated/outliner/types/texture_mesh.d.ts +1 -1
  77. package/generated/plugin_loader.d.ts +1 -1
  78. package/generated/preview/preview.d.ts +280 -0
  79. package/generated/preview/reference_images.d.ts +1 -1
  80. package/generated/texturing/layers.d.ts +140 -0
  81. package/generated/util/gif.d.ts +12 -3
  82. package/generated/util/state_memory.d.ts +3 -11
  83. package/index.d.ts +2 -2
  84. package/package.json +39 -39
  85. package/tsconfig.json +19 -19
  86. package/type_config.json +43 -46
  87. package/custom/menu.d.ts +0 -136
  88. package/custom/preview.d.ts +0 -137
  89. package/custom/start_screen.d.ts +0 -15
  90. package/custom/texture_layers.d.ts +0 -117
  91. package/generated/global_types.d.ts +0 -47
  92. package/generated/io/formats/bedrock.d.ts +0 -4
  93. package/generated/io/formats/bedrock_old.d.ts +0 -4
  94. package/generated/io/formats/collada.d.ts +0 -4
  95. package/generated/io/formats/fbx.d.ts +0 -17
  96. package/generated/io/formats/gltf.d.ts +0 -6
  97. package/generated/io/formats/java_block.d.ts +0 -4
  98. package/generated/io/formats/modded_entity.d.ts +0 -139
  99. package/generated/io/formats/obj.d.ts +0 -12
  100. package/generated/io/formats/optifine_jem.d.ts +0 -3
  101. package/generated/io/formats/optifine_jpm.d.ts +0 -3
  102. package/generated/io/formats/skin.d.ts +0 -22
package/custom/cube.d.ts CHANGED
@@ -1,151 +1,151 @@
1
- /// <reference types="./blockbench"/>
2
- type CardinalDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
3
-
4
- interface ICubeOptions {
5
- name?: string
6
- autouv?: 0 | 1 | 2
7
- shade?: boolean
8
- mirror_uv?: boolean
9
- inflate?: number
10
- color?: number
11
- visibility?: boolean
12
- from?: ArrayVector3
13
- to?: ArrayVector3
14
- rotation?: ArrayVector3
15
- origin?: ArrayVector3
16
- stretch?: ArrayVector3
17
- box_uv?: boolean
18
- /**
19
- * UV position for box UV mode
20
- */
21
- uv_offset?: ArrayVector2
22
- faces?: Partial<Record<CardinalDirection, CubeFaceOptions>>
23
- }
24
-
25
- declare class Cube extends OutlinerElement {
26
- constructor(options: ICubeOptions, uuid?: string)
27
- name: string
28
- uuid: string
29
- color: any
30
- /**
31
- * Auto UV setting, saved as an integer, where 0 means disabled, 1 means enabled, and 2 means relative auto UV (cube position affects UV)
32
- */
33
- autouv: 0 | 1 | 2
34
- /**
35
- * Enable or disable shading based on face normal
36
- */
37
- shade: boolean
38
- /**
39
- * UV mirror across the X axis when using Box UV
40
- */
41
- mirror_uv: boolean
42
- /**
43
- * If the cube is using Box UV
44
- */
45
- box_uv: boolean
46
- /**
47
- * Inflate adds an inflation value to all sides equally
48
- */
49
- inflate: number
50
- /**
51
- * Visibility of the cube in the viewport
52
- */
53
- visibility: boolean
54
- from: ArrayVector3
55
- to: ArrayVector3
56
- rotation: ArrayVector3
57
- origin: ArrayVector3
58
- stretch: ArrayVector3
59
- faces: {
60
- [fkey: string]: CubeFace
61
- }
62
- rescale?: boolean
63
- rotation_axis: 'x' | 'y' | 'z'
64
- /**
65
- * UV position for box UV mode
66
- */
67
- uv_offset: ArrayVector2
68
- mesh: THREE.Mesh & {
69
- outline: THREE.Mesh
70
- geometry: THREE.BufferGeometry & {
71
- faces: string[]
72
- }
73
- }
74
-
75
- extend(options: ICubeOptions): this
76
- /**
77
- * Calculates and returns the size of the cube
78
- */
79
- size(): ArrayVector3
80
- /**
81
- * Calculates and returns the size of a cube on a certain axis
82
- */
83
- size(axis: number, floored?: boolean): number
84
- rotationAxis(): string
85
- getUndoCopy(aspects?: any): any
86
- getSaveCopy(): Cube
87
- /**
88
- * Rotate the cube around axis in 90 degree steps
89
- * @param axis Axis index
90
- * @param steps Number of steps
91
- * @param origin Rotation pivot
92
- */
93
- roll(axis: number, steps: number, origin: ArrayVector3): void
94
- flip(axis: number, center: number, skipUV?: boolean): void
95
- /**
96
- * Transfer the origin to a new position, while updating from and to to keep the same visual position.
97
- */
98
- transferOrigin(origin: ArrayVector3, update?: boolean): void
99
- getWorldCenter(): THREE.Vector3
100
- getGlobalVertexPositions(): ArrayVector3[]
101
- setUVMode(box_uv: boolean): void
102
- setColor(color: number): void
103
- applyTexture(texture: Texture, faces: true | undefined | CubeFaceDirection[]): void
104
- mapAutoUV(): void
105
- moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
106
- resize(
107
- value: number,
108
- axis: number,
109
- negative: boolean,
110
- allow_negative?: boolean,
111
- bidirectional?: boolean
112
- ): void
113
-
114
- static all: Cube[]
115
- static selected: Cube[]
116
- /**Check if any elements of the type are in the project */
117
- static hasAny: () => boolean
118
- /**Check if any elements of the type are currently selected */
119
- static hasSelected: () => boolean
120
- preview_controller: NodePreviewController
121
- static preview_controller: NodePreviewController
122
- }
123
-
124
- interface FaceOptions {
125
- texture?: Texture | UUID | false
126
- }
127
-
128
- type CubeFaceDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
129
- interface CubeFaceOptions extends FaceOptions {
130
- uv?: [number, number, number, number]
131
- rotation?: number
132
- tint?: number
133
- cullface?: CubeFaceDirection | ''
134
- material_name?: string
135
- enabled?: boolean
136
- }
137
- declare class CubeFace extends Face {
138
- constructor(direction: CubeFaceDirection, data: CubeFaceOptions, cube: Cube)
139
- cube: Cube
140
- direction: CubeFaceDirection
141
- uv: [number, number, number, number]
142
- uv_size: readonly [number, number]
143
- rotation: number
144
- tint: number
145
- cullface: CubeFaceDirection | ''
146
- material_name: string
147
- enabled: boolean
148
-
149
- extend(data: CubeFaceOptions): void
150
- getVertexIndices(): [number, number, number, number]
151
- }
1
+ /// <reference types="./blockbench"/>
2
+ type CardinalDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
3
+
4
+ interface ICubeOptions {
5
+ name?: string
6
+ autouv?: 0 | 1 | 2
7
+ shade?: boolean
8
+ mirror_uv?: boolean
9
+ inflate?: number
10
+ color?: number
11
+ visibility?: boolean
12
+ from?: ArrayVector3
13
+ to?: ArrayVector3
14
+ rotation?: ArrayVector3
15
+ origin?: ArrayVector3
16
+ stretch?: ArrayVector3
17
+ box_uv?: boolean
18
+ /**
19
+ * UV position for box UV mode
20
+ */
21
+ uv_offset?: ArrayVector2
22
+ faces?: Partial<Record<CardinalDirection, CubeFaceOptions>>
23
+ }
24
+
25
+ declare class Cube extends OutlinerElement {
26
+ constructor(options: ICubeOptions, uuid?: string)
27
+ name: string
28
+ uuid: string
29
+ color: any
30
+ /**
31
+ * Auto UV setting, saved as an integer, where 0 means disabled, 1 means enabled, and 2 means relative auto UV (cube position affects UV)
32
+ */
33
+ autouv: 0 | 1 | 2
34
+ /**
35
+ * Enable or disable shading based on face normal
36
+ */
37
+ shade: boolean
38
+ /**
39
+ * UV mirror across the X axis when using Box UV
40
+ */
41
+ mirror_uv: boolean
42
+ /**
43
+ * If the cube is using Box UV
44
+ */
45
+ box_uv: boolean
46
+ /**
47
+ * Inflate adds an inflation value to all sides equally
48
+ */
49
+ inflate: number
50
+ /**
51
+ * Visibility of the cube in the viewport
52
+ */
53
+ visibility: boolean
54
+ from: ArrayVector3
55
+ to: ArrayVector3
56
+ rotation: ArrayVector3
57
+ origin: ArrayVector3
58
+ stretch: ArrayVector3
59
+ faces: {
60
+ [fkey: string]: CubeFace
61
+ }
62
+ rescale?: boolean
63
+ rotation_axis: 'x' | 'y' | 'z'
64
+ /**
65
+ * UV position for box UV mode
66
+ */
67
+ uv_offset: ArrayVector2
68
+ mesh: THREE.Mesh & {
69
+ outline: THREE.Mesh
70
+ geometry: THREE.BufferGeometry & {
71
+ faces: string[]
72
+ }
73
+ }
74
+
75
+ extend(options: ICubeOptions): this
76
+ /**
77
+ * Calculates and returns the size of the cube
78
+ */
79
+ size(): ArrayVector3
80
+ /**
81
+ * Calculates and returns the size of a cube on a certain axis
82
+ */
83
+ size(axis: number, floored?: boolean): number
84
+ rotationAxis(): string
85
+ getUndoCopy(aspects?: any): any
86
+ getSaveCopy(): Cube
87
+ /**
88
+ * Rotate the cube around axis in 90 degree steps
89
+ * @param axis Axis index
90
+ * @param steps Number of steps
91
+ * @param origin Rotation pivot
92
+ */
93
+ roll(axis: number, steps: number, origin: ArrayVector3): void
94
+ flip(axis: number, center: number, skipUV?: boolean): void
95
+ /**
96
+ * Transfer the origin to a new position, while updating from and to to keep the same visual position.
97
+ */
98
+ transferOrigin(origin: ArrayVector3, update?: boolean): void
99
+ getWorldCenter(): THREE.Vector3
100
+ getGlobalVertexPositions(): ArrayVector3[]
101
+ setUVMode(box_uv: boolean): void
102
+ setColor(color: number): void
103
+ applyTexture(texture: Texture, faces: true | undefined | CubeFaceDirection[]): void
104
+ mapAutoUV(): void
105
+ moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
106
+ resize(
107
+ value: number,
108
+ axis: number,
109
+ negative: boolean,
110
+ allow_negative?: boolean,
111
+ bidirectional?: boolean
112
+ ): void
113
+
114
+ static all: Cube[]
115
+ static selected: Cube[]
116
+ /**Check if any elements of the type are in the project */
117
+ static hasAny: () => boolean
118
+ /**Check if any elements of the type are currently selected */
119
+ static hasSelected: () => boolean
120
+ preview_controller: NodePreviewController
121
+ static preview_controller: NodePreviewController
122
+ }
123
+
124
+ interface FaceOptions {
125
+ texture?: Texture | UUID | false
126
+ }
127
+
128
+ type CubeFaceDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
129
+ interface CubeFaceOptions extends FaceOptions {
130
+ uv?: [number, number, number, number]
131
+ rotation?: number
132
+ tint?: number
133
+ cullface?: CubeFaceDirection | ''
134
+ material_name?: string
135
+ enabled?: boolean
136
+ }
137
+ declare class CubeFace extends Face {
138
+ constructor(direction: CubeFaceDirection, data: CubeFaceOptions, cube: Cube)
139
+ cube: Cube
140
+ direction: CubeFaceDirection
141
+ uv: [number, number, number, number]
142
+ uv_size: readonly [number, number]
143
+ rotation: number
144
+ tint: number
145
+ cullface: CubeFaceDirection | ''
146
+ material_name: string
147
+ enabled: boolean
148
+
149
+ extend(data: CubeFaceOptions): this
150
+ getVertexIndices(): [number, number, number, number]
151
+ }
@@ -1,73 +1,61 @@
1
-
2
- declare function updateRecentProjects(): void
3
- declare function addRecentProject(data: any): void
4
- declare function updateRecentProjectData(): void
5
- declare function updateRecentProjectThumbnail(): Promise<void>
6
- declare function loadDataFromModelMemory(): void
7
- declare function changeImageEditor(texture: any, from_settings: any): void
8
- declare function openDefaultTexturePath(): void
9
-
10
- declare function createBackup(init: any): void
11
- declare function closeBlockbenchWindow(): any
12
-
13
- type ScopedFS = Pick<typeof import("node:fs"),
14
- "copyFile" |
15
- "copyFileSync" |
16
- "readFile" |
17
- "readFileSync" |
18
- "writeFile" |
19
- "writeFileSync" |
20
- "appendFile" |
21
- "appendFileSync" |
22
- "existsSync" |
23
- "mkdir" |
24
- "mkdirSync" |
25
- "readdir" |
26
- "readdirSync" |
27
- "rename" |
28
- "renameSync" |
29
- "rm" |
30
- "rmSync" |
31
- "rmdir" |
32
- "rmdirSync" |
33
- "unlink" |
34
- "unlinkSync" |
35
- "stat" |
36
- "statSync"
37
- > & {
38
- promises: Pick<typeof import("node:fs").promises,
39
- "copyFile" |
40
- "readFile" |
41
- "writeFile" |
42
- "appendFile" |
43
- "mkdir" |
44
- "readdir" |
45
- "rename" |
46
- "rm" |
47
- "rmdir" |
48
- "unlink" |
49
- "stat"
50
- >
51
- }
52
- interface RequireDialogOptions {
53
- message?: string
54
- optional?: boolean
55
- }
56
- declare function requireNativeModule(module: 'fs', options?: {scope?: string} & RequireDialogOptions): ScopedFS | undefined
57
- declare function requireNativeModule(module: 'path'): typeof import("node:path");
58
- declare function requireNativeModule(module: 'crypto'): typeof import("node:crypto");
59
- declare function requireNativeModule(module: 'events'): typeof import("node:events");
60
- declare function requireNativeModule(module: 'zlib'): typeof import("node:zlib");
61
- declare function requireNativeModule(module: 'timers'): typeof import("node:timers");
62
- declare function requireNativeModule(module: 'url'): typeof import("node:url");
63
- declare function requireNativeModule(module: 'string_decoder'): typeof import("node:string_decoder");
64
- declare function requireNativeModule(module: 'querystring'): typeof import("node:querystring");
65
- declare function requireNativeModule(module: 'child_process', options?: RequireDialogOptions): (typeof import("node:child_process")) | undefined;
66
- declare function requireNativeModule(module: 'electron', options?: RequireDialogOptions): (typeof import("node:electron")) | undefined;
67
- declare function requireNativeModule(module: 'https', options?: RequireDialogOptions): (typeof import("node:https")) | undefined;
68
- declare function requireNativeModule(module: 'net', options?: RequireDialogOptions): (typeof import("node:net")) | undefined;
69
- declare function requireNativeModule(module: 'tls', options?: RequireDialogOptions): (typeof import("node:tls")) | undefined;
70
- declare function requireNativeModule(module: 'util', options?: RequireDialogOptions): (typeof import("node:util")) | undefined;
71
- declare function requireNativeModule(module: 'os', options?: RequireDialogOptions): (typeof import("node:os")) | undefined;
72
- declare function requireNativeModule(module: 'v8', options?: RequireDialogOptions): (typeof import("node:v8")) | undefined;
73
- declare function requireNativeModule(module: 'clipboard', options?: RequireDialogOptions): (import('electron').Clipboard) | undefined;
1
+ type ScopedFS = Pick<typeof import("node:fs"),
2
+ "copyFile" |
3
+ "copyFileSync" |
4
+ "readFile" |
5
+ "readFileSync" |
6
+ "writeFile" |
7
+ "writeFileSync" |
8
+ "appendFile" |
9
+ "appendFileSync" |
10
+ "existsSync" |
11
+ "mkdir" |
12
+ "mkdirSync" |
13
+ "readdir" |
14
+ "readdirSync" |
15
+ "rename" |
16
+ "renameSync" |
17
+ "rm" |
18
+ "rmSync" |
19
+ "rmdir" |
20
+ "rmdirSync" |
21
+ "unlink" |
22
+ "unlinkSync" |
23
+ "stat" |
24
+ "statSync"
25
+ > & {
26
+ promises: Pick<typeof import("node:fs").promises,
27
+ "copyFile" |
28
+ "readFile" |
29
+ "writeFile" |
30
+ "appendFile" |
31
+ "mkdir" |
32
+ "readdir" |
33
+ "rename" |
34
+ "rm" |
35
+ "rmdir" |
36
+ "unlink" |
37
+ "stat"
38
+ >
39
+ }
40
+ interface RequireDialogOptions {
41
+ message?: string
42
+ optional?: boolean
43
+ }
44
+ declare function requireNativeModule(module: 'fs', options?: {scope?: string} & RequireDialogOptions): ScopedFS | undefined
45
+ declare function requireNativeModule(module: 'path'): typeof import("node:path");
46
+ declare function requireNativeModule(module: 'crypto'): typeof import("node:crypto");
47
+ declare function requireNativeModule(module: 'events'): typeof import("node:events");
48
+ declare function requireNativeModule(module: 'zlib'): typeof import("node:zlib");
49
+ declare function requireNativeModule(module: 'timers'): typeof import("node:timers");
50
+ declare function requireNativeModule(module: 'url'): typeof import("node:url");
51
+ declare function requireNativeModule(module: 'string_decoder'): typeof import("node:string_decoder");
52
+ declare function requireNativeModule(module: 'querystring'): typeof import("node:querystring");
53
+ declare function requireNativeModule(module: 'child_process', options?: RequireDialogOptions): (typeof import("node:child_process")) | undefined;
54
+ declare function requireNativeModule(module: 'electron', options?: RequireDialogOptions): (typeof import("node:electron")) | undefined;
55
+ declare function requireNativeModule(module: 'https', options?: RequireDialogOptions): (typeof import("node:https")) | undefined;
56
+ declare function requireNativeModule(module: 'net', options?: RequireDialogOptions): (typeof import("node:net")) | undefined;
57
+ declare function requireNativeModule(module: 'tls', options?: RequireDialogOptions): (typeof import("node:tls")) | undefined;
58
+ declare function requireNativeModule(module: 'util', options?: RequireDialogOptions): (typeof import("node:util")) | undefined;
59
+ declare function requireNativeModule(module: 'os', options?: RequireDialogOptions): (typeof import("node:os")) | undefined;
60
+ declare function requireNativeModule(module: 'v8', options?: RequireDialogOptions): (typeof import("node:v8")) | undefined;
61
+ declare function requireNativeModule(module: 'clipboard', options?: RequireDialogOptions): (import('electron').Clipboard) | undefined;