Class Codec

A codec represents a specific file format that can be imported into and exported from Blockbench. The codec handles the compilation and parsing, as well as the loading and exporting logic

Hierarchy (View Summary)

EventSystem
- Codec

Indexable

[key: string]: any
Additional properties

Constructors

constructor

new Codec(id: string, data?: CodecOptions): Codec
Creates a new codec
Parameters
- id: string
  Codec ID
- Optionaldata: CodecOptions
  Codec options
Returns Codec
Overrides EventSystem.constructor
- Defined in types/generated/io/codec.d.ts:100

Methods

addListener

addListener(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.addListener
- Defined in types/generated/util/event_system.d.ts:11

afterDownload

afterDownload(path: string): void
Parameters
- path: string
Returns void
- Defined in types/generated/io/codec.d.ts:155

afterSave

afterSave(path: string): void
Parameters
- path: string
Returns void
- Defined in types/generated/io/codec.d.ts:156

compile

compile(options?: { [key: string]: any }): any
Compiles the file content
Parameters
- Optionaloptions: { [key: string]: any }
Returns any
- Defined in types/generated/io/codec.d.ts:124

delete

delete(): void
Returns void
- Defined in types/generated/io/codec.d.ts:157

dispatchEvent

dispatchEvent(event_name: string, data: any): any
Parameters
- event_name: string
- data: any
Returns any
Inherited from EventSystem.dispatchEvent
- Defined in types/generated/util/event_system.d.ts:8

export

export(options?: Record<string, any>): Promise<void>
Opens the file browser to export a file of this type
Parameters
- Optionaloptions: Record<string, any>
Returns Promise<void>
- Defined in types/generated/io/codec.d.ts:136

exportCollection

exportCollection(collection: Collection): Promise<void>
Parameters
- collection: Collection
Returns Promise<void>
- Defined in types/generated/io/codec.d.ts:138

fileName

fileName(): string
Generate a file name to suggest when exporting

Returns string
- Defined in types/generated/io/codec.d.ts:143

getExportOptions

getExportOptions(): { [key: string]: any }
Return the stored export option values of the current project

Returns { [key: string]: any }
- Defined in types/generated/io/codec.d.ts:104

load

load(model: any, file?: FileResult, args?: LoadOptions): boolean | void
Load a file into the program
Parameters
- model: any
- Optionalfile: FileResult
- Optionalargs: LoadOptions
  Load options
Returns boolean | void
- Defined in types/generated/io/codec.d.ts:113

on

on(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.on
- Defined in types/generated/util/event_system.d.ts:9

once

once(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.once
- Defined in types/generated/util/event_system.d.ts:10

`Optional`overwrite

overwrite?(content: any, path: string, callback: (path: string) => void): void
Parameters
- content: any
- path: string
- callback: (path: string) => void
Returns void
- Defined in types/generated/io/codec.d.ts:154

`Optional`parse

parse?(data: any, path: string, args?: LoadOptions): void
Takes the content of a file, and loads the model into the current Blockbench project
Parameters
- data: any
  File content
- path: string
  File path
- Optionalargs: LoadOptions
Returns void
- Defined in types/generated/io/codec.d.ts:119

patchCollectionExport

patchCollectionExport(collection: Collection, callback: any): Promise<void>
Parameters
- collection: Collection
- callback: any
Returns Promise<void>
- Defined in types/generated/io/codec.d.ts:137

promptExportOptions

promptExportOptions(): Promise<{ [key: string]: any }>
Prompt the user to enter their preferred export settings into the dialog

Returns Promise<{ [key: string]: any }>
- Defined in types/generated/io/codec.d.ts:130

removeListener

removeListener(event_name: string, cb: EventListener): void
Parameters
- event_name: string
- cb: EventListener
Returns void
Inherited from EventSystem.removeListener
- Defined in types/generated/util/event_system.d.ts:12

startPath

startPath(): string
Generates the suggested file path. This is the path that the explorer opens in when exporting this type

Returns string
- Defined in types/generated/io/codec.d.ts:147

write

write(content: any, path: string): void
Write the content of this file to the selected location. The default method can be overwritten to achieve custom behavior
Parameters
- content: any
  File content, as generated by compile()
- path: string
  The file export path
Returns void
- Defined in types/generated/io/codec.d.ts:153

writeCollection

writeCollection(collection: Collection): Promise<void>
Parameters
- collection: Collection
Returns Promise<void>
- Defined in types/generated/io/codec.d.ts:139

`Static`getAllExtensions

getAllExtensions(): string[]
Get a list of all possible extensions of all codecs

Returns string[]
- Defined in types/generated/io/codec.d.ts:161

Properties

events

events: Record<string, EventListener[]>

`Optional`export_action

export_action?: Action

If available, the action that is used to export files using this codec

export_options

export_options: Record<string, FormElementOptions>

List of export option inputs

extension

extension: string

The default file extension that the codec uses

`Optional`format

format?: ModelFormat

Default/main format of this codec

name

name: string

The display name of the codec

`Optional`plugin

plugin?: string

remember

remember: boolean

Whether to remember files that use this codec in the recent models list

support_offset

support_offset: boolean

support_partial_export

support_partial_export: boolean

Whether the codec can be used to export a part of the model via a collection

Class Codec

Hierarchy (View Summary)

Indexable

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Codec

Methods

addListener

Parameters

Returns Deletable

afterDownload

Parameters

Returns void

afterSave

Parameters

Returns void

compile

Parameters

Returns any

delete

Returns void

dispatchEvent

Parameters

Returns any

export

Parameters

Returns Promise<void>

exportCollection

Parameters

Returns Promise<void>

fileName

Returns string

getExportOptions

Returns { [key: string]: any }

load

Parameters

Returns boolean | void

on

Parameters

Returns Deletable

once

Parameters

Returns Deletable

Optionaloverwrite

Parameters

Returns void

Optionalparse

Parameters

Returns void

patchCollectionExport

Parameters

Returns Promise<void>

promptExportOptions

Returns Promise<{ [key: string]: any }>

removeListener

Parameters

Returns void

startPath

Returns string

write

Parameters

Returns void

writeCollection

Parameters

Returns Promise<void>

StaticgetAllExtensions

Returns string[]

Properties

events

Optionalexport_action

export_options

extension

Optionalformat

name

Optionalplugin

`Optional`overwrite

`Optional`parse

`Static`getAllExtensions

`Optional`export_action

`Optional`format

`Optional`plugin