Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScriptedMapFormat

The interface that should be implemented for objects passed to tiled.registerMapFormat.

Hierarchy

  • ScriptedMapFormat

Index

Properties

Methods

Properties

Readonly extension

extension: string

The file extension used by the format.

Readonly name

name: string

Name of the format as shown in the file dialog.

Methods

Optional outputFiles

  • outputFiles(map: TileMap, fileName: string): string[]

  • A function that returns the list of files that will be written when exporting the given map (optional).

Optional read

  • A function that reads a map from the given file. Can use TextFile or BinaryFile to read the file.

Optional write

  • write(map: TileMap, fileName: string): undefined | string

  • A function that writes a map to the given file. Can use TextFile or BinaryFile to write the file. * When a non-empty string is returned, it is shown as error message.

Generated using TypeDoc