blockbench-types 5.0.0 → 5.0.5

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.
@@ -162,6 +162,8 @@ interface AddChannelOptions {
162
162
  transform?: boolean
163
163
  mutable?: boolean
164
164
  max_data_points?: number
165
+ condition?: ConditionResolvable
166
+ displayFrame?: (animator: GeneralAnimator, multiplier: number) => void
165
167
  }
166
168
  interface Channel {
167
169
  name: string
@@ -108,6 +108,8 @@ declare namespace Canvas {
108
108
  const ground_plane: THREE.Mesh
109
109
  const brush_outline: THREE.Mesh
110
110
 
111
+ const show_gizmos: boolean
112
+
111
113
  const global_light_color: THREE.Color
112
114
  const global_light_side: number
113
115
 
package/custom/cube.d.ts CHANGED
@@ -83,7 +83,7 @@ declare class Cube extends OutlinerElement {
83
83
  size(axis: number, floored?: boolean): number
84
84
  rotationAxis(): string
85
85
  getUndoCopy(aspects?: any): void
86
- getSaveCopy(project?: boolean): Cube
86
+ getSaveCopy(): Cube
87
87
  /**
88
88
  * Rotate the cube around axis in 90 degree steps
89
89
  * @param axis Axis index
@@ -135,9 +135,9 @@ declare class Face {
135
135
  getBoundingRect(): any
136
136
  reset(): void
137
137
  /**
138
- * Returns a save copy of the face, ready for serialization. Set project to true to save for a bbmodel project file
138
+ * Returns a save copy of the face, ready for serialization
139
139
  */
140
- getSaveCopy(project?: boolean): any
140
+ getSaveCopy(): any
141
141
  /**
142
142
  * Get a copy for undo tracking
143
143
  */
@@ -70,3 +70,4 @@ declare function requireNativeModule(module: 'tls', options?: RequireDialogOptio
70
70
  declare function requireNativeModule(module: 'util', options?: RequireDialogOptions): (typeof import("node:util")) | undefined;
71
71
  declare function requireNativeModule(module: 'os', options?: RequireDialogOptions): (typeof import("node:os")) | undefined;
72
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;
package/custom/group.d.ts CHANGED
@@ -74,7 +74,10 @@ declare class Group extends OutlinerNode {
74
74
 
75
75
  extend(options: Partial<GroupOptions>): this
76
76
  selectChildren(event: Event): this
77
- selectLow(highlight: boolean): this
77
+ /**
78
+ * Mark the group as selected
79
+ */
80
+ markAsSelected(descendants?: boolean): void
78
81
  select(event?: any, isOutlinerClick?: boolean): this
79
82
  unselect(): this
80
83
  matchesSelection(): boolean
@@ -11,6 +11,7 @@ interface KeyframeDataPointData {
11
11
  declare class KeyframeDataPoint extends Object {
12
12
  static properties: Record<string, Property<any>>
13
13
  constructor(keyframe: _Keyframe)
14
+ readonly keyframe: Keyframe
14
15
  extend(data: KeyframeDataPointData): void
15
16
  getUndoCopy(): {
16
17
  [key: string]: any
package/custom/mesh.d.ts CHANGED
@@ -19,8 +19,8 @@ interface MeshOptions {
19
19
  }
20
20
 
21
21
  interface MeshFaceOptions extends FaceOptions {
22
- vertices: string[]
23
- uv: { [vkey: string]: ArrayVector2 }
22
+ vertices?: string[]
23
+ uv?: { [vkey: string]: ArrayVector2 }
24
24
  }
25
25
  declare class MeshFace extends Face {
26
26
  constructor(mesh: Mesh, data: MeshFaceOptions)
package/custom/misc.d.ts CHANGED
@@ -24,6 +24,7 @@ declare const VuePrismEditor: Vue.Component
24
24
  type EventName =
25
25
  | 'remove_animation'
26
26
  | 'display_animation_frame'
27
+ | 'interpolate_keyframes'
27
28
  | 'before_closing'
28
29
  | 'create_session'
29
30
  | 'join_session'
@@ -63,6 +64,7 @@ type EventName =
63
64
  | 'canvas_click'
64
65
  | 'change_texture_path'
65
66
  | 'add_texture'
67
+ | 'generate_texture_template'
66
68
  | 'update_texture_selection'
67
69
  | 'init_edit'
68
70
  | 'finish_edit'
@@ -86,6 +88,7 @@ type EventName =
86
88
  | 'setup_project'
87
89
  | 'update_project_resolution'
88
90
  | 'merge_project'
91
+ | 'display_model_stats'
89
92
  | 'update_view'
90
93
  | 'update_camera_position'
91
94
  | 'render_frame'
@@ -36,6 +36,10 @@ declare class OutlinerNode {
36
36
  addTo(target?: OutlinerNode | 'root'): this
37
37
  sortInBefore(target?: OutlinerNode, index_modifier?: number): this
38
38
  select(event?: any, isOutlinerClick?: boolean): this
39
+ /**
40
+ * Mark the element as selected
41
+ */
42
+ markAsSelected(descendants?: boolean): void
39
43
  getParentArray(): OutlinerNode[]
40
44
  /**
41
45
  * Unfolds the outliner and scrolls up or down if necessary to show the group or element.
@@ -109,6 +109,7 @@ declare global {
109
109
  render_mode: 'default' | 'emissive' | 'additive' | 'layered' | string
110
110
  render_sides: 'auto' | 'front' | 'double' | string
111
111
  pbr_channel: 'color' | 'normal' | 'height' | 'mer'
112
+ use_as_default: boolean
112
113
 
113
114
  /** Texture animation frame time */
114
115
  frame_time: number
@@ -153,6 +154,10 @@ declare global {
153
154
  * Set a function that will run once the next time the texture is loaded
154
155
  */
155
156
  load_callback?: null | ((texture: Texture) => void)
157
+ /**
158
+ * Custom texture flags
159
+ */
160
+ flags: Set
156
161
 
157
162
  /**
158
163
  * Texture selection in paint mode
@@ -177,6 +182,7 @@ declare global {
177
182
  * Texture image element
178
183
  */
179
184
  img: HTMLImageElement
185
+ readonly offset: ArrayVector2
180
186
 
181
187
  relative_path?: string
182
188
  get material(): THREE.ShaderMaterial
@@ -425,7 +431,7 @@ declare global {
425
431
  * Return the smallest possible rectangle that contains all of the selection
426
432
  * @param respect_empty If true, if there is no selection, the bounding box will still cover the entire area
427
433
  */
428
- getBoundingRect(respect_empty: boolean): Rectangle
434
+ getBoundingRect(respect_empty: boolean = false): Rectangle
429
435
  /**
430
436
  * Checks whether a selection is present and contains selected pixels
431
437
  */
package/custom/util.d.ts CHANGED
@@ -37,10 +37,7 @@ declare function Condition(condition: ConditionResolvable): boolean
37
37
  /**
38
38
  * Wrapper for anys that tells the custom JSON exporter to write in one line
39
39
  */
40
- declare class oneLiner {
41
- constructor(data?: any)
42
- [key: string]: any
43
- }
40
+ const oneLiner: new <T>(data?: T) => T
44
41
 
45
42
  /**
46
43
  * If the input event is a touch event, convert touch event to a compatible mouse event
@@ -40,6 +40,7 @@ declare global {
40
40
  events: {};
41
41
  openTime: Date;
42
42
  setup_successful: null | true;
43
+ argv: string[];
43
44
  /**
44
45
  * @deprecated Use Undo.initEdit and Undo.finishEdit instead
45
46
  */
@@ -76,7 +77,7 @@ declare global {
76
77
  removeMenuEntry(name: string): void;
77
78
  openLink(link: string): void;
78
79
  notification(title: string, text: string, icon?: string): void;
79
- addCSS(css: string): Deletable;
80
+ addCSS(css: string, layer?: string): Deletable;
80
81
  addFlag(flag: string): void;
81
82
  removeFlag(flag: string): void;
82
83
  hasFlag(flag: string): boolean | undefined;
@@ -9,16 +9,16 @@ declare global {
9
9
  /**
10
10
  * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
11
11
  */
12
- type ResourceID = string | 'texture' | 'minecraft_skin' | 'dev_plugin' | 'animation' | 'animation_particle' | 'animation_audio' | 'theme' | 'model' | 'gltf' | 'obj' | 'preview_background' | 'screenshot' | 'palette';
12
+ export type ResourceID = string | 'texture' | 'minecraft_skin' | 'dev_plugin' | 'animation' | 'animation_particle' | 'animation_audio' | 'theme' | 'model' | 'gltf' | 'obj' | 'preview_background' | 'screenshot' | 'palette';
13
13
  type ReadType = 'buffer' | 'binary' | 'text' | 'image' | 'none';
14
- interface ReadOptions {
14
+ export interface ReadOptions {
15
15
  readtype?: ReadType | ((file: string) => ReadType);
16
16
  errorbox?: boolean;
17
17
  /** File Extensions
18
18
  */
19
19
  extensions?: string[];
20
20
  }
21
- interface ImportOptions extends ReadOptions {
21
+ export interface ImportOptions extends ReadOptions {
22
22
  /** Name of the file type
23
23
  */
24
24
  type: string;
@@ -50,7 +50,7 @@ declare global {
50
50
  path: string;
51
51
  }[];
52
52
  export const read: typeof readFile;
53
- interface PickDirOptions {
53
+ export interface PickDirOptions {
54
54
  /**Location where the file dialog starts off
55
55
  */
56
56
  startpath?: string;
@@ -65,7 +65,7 @@ declare global {
65
65
  * Pick a directory. Desktop app only.
66
66
  */
67
67
  export function pickDirectory(options?: PickDirOptions): string | undefined;
68
- interface ExportOptions extends WriteOptions {
68
+ export interface ExportOptions extends WriteOptions {
69
69
  /**
70
70
  * Name of the file type
71
71
  */
@@ -95,7 +95,7 @@ declare global {
95
95
  */
96
96
  export function exportFile(options: ExportOptions, callback?: (file_path: string) => void): void;
97
97
  type WriteType = 'text' | 'buffer' | 'binary' | 'zip' | 'image';
98
- interface WriteOptions {
98
+ export interface WriteOptions {
99
99
  content?: string | ArrayBuffer | Blob;
100
100
  savetype?: WriteType | ((file: string) => WriteType);
101
101
  custom_writer?: (content: string | ArrayBuffer | Blob, file_path: string, callback?: (file_path: string) => void) => void;
@@ -105,7 +105,7 @@ declare global {
105
105
  */
106
106
  export function writeFile(file_path: string, options: WriteOptions, callback?: (file_path: string) => void): void;
107
107
  export function showFileInFolder(path: string): void;
108
- interface FindFileOptions {
108
+ export interface FindFileOptions {
109
109
  recursive: boolean;
110
110
  filter_regex: RegExp;
111
111
  priority_regex?: RegExp;
@@ -117,7 +117,7 @@ declare global {
117
117
  * @param {string[]} base_directories List of base directory paths to search in
118
118
  */
119
119
  export function findFileFromContent(base_directories: string[], options: FindFileOptions, check_file: (path: string, content: string | object) => boolean): any;
120
- interface DragHandlerOptions {
120
+ export interface DragHandlerOptions {
121
121
  /**
122
122
  * Allowed file extensions
123
123
  */
@@ -11,6 +11,7 @@ declare global {
11
11
  folded: boolean;
12
12
  attached_to?: string;
13
13
  attached_index?: number;
14
+ open_tab?: string;
14
15
  fixed_height: boolean;
15
16
  sidebar_index: number;
16
17
  }
@@ -80,7 +81,6 @@ declare global {
80
81
  previous_slot: PanelSlot;
81
82
  width: number;
82
83
  height: number;
83
- open_attached_panel: Panel;
84
84
  node: HTMLElement;
85
85
  container: HTMLElement;
86
86
  handle: HTMLElement;
@@ -115,6 +115,8 @@ declare global {
115
115
  set attached_to(id: string);
116
116
  get attached_index(): number;
117
117
  set attached_index(id: number);
118
+ get open_attached_panel(): Panel;
119
+ set open_attached_panel(panel: Panel | undefined);
118
120
  dispatchEvent(event_name: PanelEvent, data: any): void;
119
121
  getAttachedPanels(): Panel[];
120
122
  /**
@@ -46,7 +46,7 @@ declare global {
46
46
  */
47
47
  coordinate_limits?: [number, number];
48
48
  }
49
- const Formats: {};
49
+ const Formats: Record<string, ModelFormat>;
50
50
  interface FormatFeatures {
51
51
  /**
52
52
  * Enables Box UV on cubes by default
@@ -108,6 +108,10 @@ declare global {
108
108
  * Specify how large in pixels a block is. Defaults to 16.
109
109
  */
110
110
  block_size: number;
111
+ /**
112
+ * Which direction of the model is facing forward
113
+ */
114
+ forward_direction: '-z' | '+z' | '-x' | '+x';
111
115
  /**
112
116
  * Add the ability to rotate cubes
113
117
  */
@@ -180,6 +184,10 @@ declare global {
180
184
  * If true, animations will be saved into files
181
185
  */
182
186
  animation_files: boolean;
187
+ /**
188
+ * Change how animations can be grouped
189
+ */
190
+ animation_grouping: 'by_file' | 'custom' | 'disabled';
183
191
  /**
184
192
  * Enables a folder path per texture that can be set in the texture properties window
185
193
  */
@@ -1,7 +1,7 @@
1
1
  declare global {
2
2
  function buildAnimationTracks(export_scale?: string | number | boolean, do_quaternions?: boolean): any[];
3
3
  function buildSkinnedMeshFromGroup(root_group: any): import("three").SkinnedMesh<import("three").BufferGeometry, any>;
4
- function buildSkinnedMesh(mesh_obj: any, armature: any, scale: any): import("three").SkinnedMesh<any, any>;
4
+ function buildSkinnedMesh(armature: any, scale: any): import("three").SkinnedMesh<any, any>;
5
5
  }
6
6
 
7
7
  export {};
@@ -1,34 +1,37 @@
1
- declare class Easings {
2
- static linear(t: any): any;
3
- static easeInSine(t: any): number;
4
- static easeOutSine(t: any): number;
5
- static easeInOutSine(t: any): number;
6
- static easeInQuad(t: any): number;
7
- static easeOutQuad(t: any): number;
8
- static easeInOutQuad(t: any): number;
9
- static easeInCubic(t: any): number;
10
- static easeOutCubic(t: any): number;
11
- static easeInOutCubic(t: any): number;
12
- static easeInQuart(t: any): number;
13
- static easeOutQuart(t: any): number;
14
- static easeInOutQuart(t: any): number;
15
- static easeInQuint(t: any): number;
16
- static easeOutQuint(t: any): number;
17
- static easeInOutQuint(t: any): number;
18
- static easeInExpo(t: any): number;
19
- static easeOutExpo(t: any): number;
20
- static easeInOutExpo(t: any): any;
21
- static easeInCirc(t: any): number;
22
- static easeOutCirc(t: any): number;
23
- static easeInOutCirc(t: any): number;
24
- static easeInBack(t: any, magnitude?: number): number;
25
- static easeOutBack(t: any, magnitude?: number): number;
26
- static easeInOutBack(t: any, magnitude?: number): number;
27
- static easeInElastic(t: any, magnitude?: number): any;
28
- static easeOutElastic(t: any, magnitude?: number): any;
29
- static easeInOutElastic(t: any, magnitude?: number): any;
30
- static easeOutBounce(t: any): number;
31
- static easeInBounce(t: any): number;
32
- static easeInOutBounce(t: any): number;
1
+ declare global {
2
+ class Easings {
3
+ static linear(t: any): any;
4
+ static easeInSine(t: any): number;
5
+ static easeOutSine(t: any): number;
6
+ static easeInOutSine(t: any): number;
7
+ static easeInQuad(t: any): number;
8
+ static easeOutQuad(t: any): number;
9
+ static easeInOutQuad(t: any): number;
10
+ static easeInCubic(t: any): number;
11
+ static easeOutCubic(t: any): number;
12
+ static easeInOutCubic(t: any): number;
13
+ static easeInQuart(t: any): number;
14
+ static easeOutQuart(t: any): number;
15
+ static easeInOutQuart(t: any): number;
16
+ static easeInQuint(t: any): number;
17
+ static easeOutQuint(t: any): number;
18
+ static easeInOutQuint(t: any): number;
19
+ static easeInExpo(t: any): number;
20
+ static easeOutExpo(t: any): number;
21
+ static easeInOutExpo(t: any): any;
22
+ static easeInCirc(t: any): number;
23
+ static easeOutCirc(t: any): number;
24
+ static easeInOutCirc(t: any): number;
25
+ static easeInBack(t: any, magnitude?: number): number;
26
+ static easeOutBack(t: any, magnitude?: number): number;
27
+ static easeInOutBack(t: any, magnitude?: number): number;
28
+ static easeInElastic(t: any, magnitude?: number): any;
29
+ static easeOutElastic(t: any, magnitude?: number): any;
30
+ static easeInOutElastic(t: any, magnitude?: number): any;
31
+ static easeOutBounce(t: any): number;
32
+ static easeInBounce(t: any): number;
33
+ static easeInOutBounce(t: any): number;
34
+ }
33
35
  }
36
+
34
37
  export {};
@@ -5,6 +5,7 @@ import * as FIK from './fik';
5
5
  import Vue from 'vue/dist/vue.js';
6
6
  import JSZip from 'jszip';
7
7
  import Prism from 'prismjs';
8
+ import 'prismjs/components/prism-json';
8
9
  import GIF from './gif';
9
10
  import { marked } from 'marked';
10
11
  import { APNGencoder } from './canvas2apng';
@@ -5,7 +5,6 @@ declare global {
5
5
  function unselectAllElements(exceptions: any): void;
6
6
  function selectAll(): void;
7
7
  function unselectAll(): void;
8
- function factoryResetAndReload(): void;
9
8
  function benchmarkCode(id: any, iterations: any, code: any): void;
10
9
  namespace Pressing {
11
10
  let shift: boolean;
@@ -13,7 +13,8 @@ declare global {
13
13
  center: any;
14
14
  }): boolean;
15
15
  isParentTreeOpposite(element1: OutlinerNode, element2: OutlinerNode): boolean;
16
- insertElementIntoUndo(element: OutlinerElement, undo_aspects: UndoAspects, element_before_snapshot: any): void;
16
+ insertElementIntoUndo(element: OutlinerElement, undo_aspects: UndoAspects, element_before_snapshot?: any): void;
17
+ insertGroupIntoUndo(group: Group, undo_aspects: UndoAspects, before_snapshop?: any): void;
17
18
  element_types: Record<string, MirrorModelingElementTypeOptions>;
18
19
  registerElementType(type_class: any, options: MirrorModelingElementTypeOptions): void;
19
20
  cached_elements: {};
@@ -7,7 +7,7 @@ declare global {
7
7
  visibility?: boolean;
8
8
  }
9
9
  class Armature extends OutlinerElement {
10
- children: ArmatureBone[];
10
+ children: (ArmatureBone | Mesh | NullObject)[];
11
11
  isOpen: boolean;
12
12
  visibility: boolean;
13
13
  origin: ArrayVector3;
@@ -30,6 +30,8 @@ declare global {
30
30
  get position(): ArrayVector3;
31
31
  extend(object: ArmatureBoneOptions): this;
32
32
  getArmature(): Armature;
33
+ getVertexWeight(mesh: Mesh, vkey: string): number;
34
+ setVertexWeight(mesh: Mesh, vkey: string, weight?: number): void;
33
35
  init(): this;
34
36
  select(event?: Event, isOutlinerClick?: boolean): this;
35
37
  markAsSelected(descendants: boolean): this;
@@ -43,7 +45,7 @@ declare global {
43
45
  getSize(axis: any): number;
44
46
  resize(move_value: number | ((input: number) => number), axis_number?: axisNumber, invert?: boolean): void;
45
47
  setColor(index: any): this;
46
- getSaveCopy(project: any): {
48
+ getSaveCopy(): {
47
49
  isOpen: boolean;
48
50
  uuid: string;
49
51
  type: string;
@@ -47,7 +47,7 @@ declare global {
47
47
  getMesh(): import("three").Object3D;
48
48
  get mesh(): import("three").Object3D;
49
49
  getUndoCopy(aspects?: number): Billboard;
50
- getSaveCopy(project: any): {
50
+ getSaveCopy(): {
51
51
  from: any;
52
52
  autouv: number;
53
53
  color: number;
@@ -21,7 +21,6 @@ declare global {
21
21
  */
22
22
  children: string[];
23
23
  export_path: string;
24
- codec: string;
25
24
  export_codec: string;
26
25
  visibility: boolean;
27
26
  static properties: Record<string, Property<any>>;
@@ -36,7 +35,7 @@ declare global {
36
35
  constructor(data: CollectionOptions, uuid?: string);
37
36
  extend(data: CollectionOptions): this;
38
37
  select(event?: KeyboardEvent | MouseEvent): this;
39
- clickSelect(event: any): void;
38
+ clickSelect(event: MouseEvent): void;
40
39
  /**
41
40
  * Get all direct children
42
41
  */
@@ -108,7 +108,7 @@ declare global {
108
108
  type: string;
109
109
  uuid: string;
110
110
  };
111
- getSaveCopy(project: any): {
111
+ getSaveCopy(): {
112
112
  vertices: {};
113
113
  handles: {};
114
114
  curves: {};
@@ -118,6 +118,7 @@ declare global {
118
118
  contributes?: {
119
119
  formats: string[];
120
120
  };
121
+ creation_date?: string;
121
122
  has_changelog?: boolean;
122
123
  /**
123
124
  * In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated
@@ -182,6 +183,7 @@ declare global {
182
183
  cache_version: number;
183
184
  menu: Menu;
184
185
  details: null | PluginDetails;
186
+ uuid: UUID;
185
187
  onload?: () => void;
186
188
  onunload?: () => void;
187
189
  oninstall?: () => void;
@@ -6,7 +6,7 @@ declare global {
6
6
  class EventSystem {
7
7
  events: Record<string, EventListener[]>;
8
8
  constructor();
9
- dispatchEvent(event_name: string, data: any): void;
9
+ dispatchEvent(event_name: string, data: any): any;
10
10
  on(event_name: string, cb: EventListener): Deletable;
11
11
  once(event_name: string, cb: EventListener): Deletable;
12
12
  addListener(event_name: string, cb: EventListener): Deletable;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "blockbench-types",
3
- "version": "5.0.0",
3
+ "version": "5.0.5",
4
4
  "description": "Blockbench typescript types",
5
5
  "main": "",
6
6
  "types": "./index.d.ts",
package/type_config.json CHANGED
@@ -12,7 +12,8 @@
12
12
  "interface/setup_settings",
13
13
  "desktop",
14
14
  "util/math_util",
15
- "display_mode",
15
+ "display_mode/display_references",
16
+ "display_mode/display_mode",
16
17
  "interface/interface",
17
18
  "outliner/cube",
18
19
  "outliner/group",
@@ -1,5 +0,0 @@
1
- declare global {
2
- DisplayReferences;
3
- }
4
-
5
- export {};