Namespace tiled

See QColor::fromString for the accepted color names.

since

1.11

since

1.11

When no compression method is given, defaults to Zlib compression. The compression level defaults to the default for the respective method.

example

Example that compresses data using Gzip compression:

buffer = tiled.compress(buffer, Tiled.Gzip);

since

1.10

since

1.11.1

since

1.11.1

When no compression method is given, defaults to Zlib compression.

since

1.10

When the issue is activated (with double-click or Enter key) the given callback function is invoked.

Raises a script error if the command is not found.

For more control over the executed binary, use Process instead.

If a menu item does not include a before property, the value is inherited from the previous item. When this property is not set at all, the items are appended to the end of the menu.

Example that adds a custom action to the "Edit" menu, before the "Select All" action and separated by a separator:

tiled.extendMenu("Edit", [
    { action: "CustomAction", before: "SelectAll" },
    { separator: true }
]);

The "CustomAction" will need to have been registered before using tiled.registerAction().

since

1.11

For more complex input requirements, consider creating a custom Dialog.

Returns the absolute path of the chosen directory, or an empty string if the user cancels the dialog.

since

1.10.2

Returns the absolute path of the chosen file, or an empty string if the user cancels the dialog.

since

1.10.2

Returns an array of the absolute paths of the chosen files, or an empty array if the user cancels the dialog.

since

1.10.2

Returns the absolute path of the chosen file, or an empty string if the user cancels the dialog.

since

1.10.2

When creating an enum value, the name of the value can be used (or string with comma-separated names, in case of using flags). However, the created PropertyValue object will always use numbers for enum values.

example

Creating a value of a custom enum:

var bodyType = tiled.propertyValue("BodyType", "Dynamic")

example

Creating a value of a custom class:

var body = tiled.propertyValue("Body", { type: bodyType, bullet: true })

since

1.8

The shortcut will currently only work when the action is added to a menu using tiled.extendMenu().

example

var action = tiled.registerAction("CustomAction", function(action) {
    tiled.log(action.text + " was " + (action.checked ? "checked" : "unchecked"))
})

action.text = "My Custom Action"
action.checkable = true
action.shortcut = "Ctrl+K"

If a map format is already registered with the same shortName, the existing format is replaced. The short name can also be used to specify the format when using --export-map on the command-line, in case the file extension is ambiguous or a different one should be used.

example

Example that produces a simple JSON representation of a map:

var customMapFormat = {
    name: "Custom map format",
    extension: "custom",

    write: function(map, fileName) {
        var m = {
            width: map.width,
            height: map.height,
            layers: []
        };

        for (var i = 0; i < map.layerCount; ++i) {
            var layer = map.layerAt(i);
            if (layer.isTileLayer) {
                var rows = [];
                for (y = 0; y < layer.height; ++y) {
                    var row = [];
                    for (x = 0; x < layer.width; ++x)
                        row.push(layer.cellAt(x, y).tileId);
                    rows.push(row);
                }
                m.layers.push(rows);
            }
        }

        var file = new TextFile(fileName, TextFile.WriteOnly);
        file.write(JSON.stringify(m));
        file.commit();
    },
}

tiled.registerMapFormat("custom", customMapFormat)

If a tool is already registered with the same shortName the existing tool is replaced.

example

Here is an example tool that places a rectangle each time the mouse has moved by 32 pixels:

var tool = tiled.registerTool("PlaceRectangles", {
    name: "Place Rectangles",

    mouseMoved: function(x, y, modifiers) {
        if (!this.pressed)
            return

        var dx = Math.abs(this.x - x)
        var dy = Math.abs(this.y - y)

        this.distance += Math.sqrt(dx*dx + dy*dy)
        this.x = x
        this.y = y

        if (this.distance > 32) {
            var objectLayer = this.map.currentLayer

            if (objectLayer && objectLayer.isObjectLayer) {
                var object = new MapObject(MapObject.Rectangle, ++this.counter)
                object.x = Math.min(this.lastX, x)
                object.y = Math.min(this.lastY, y)
                object.width = Math.abs(this.lastX - x)
                object.height = Math.abs(this.lastY - y)
                objectLayer.addObject(object)
            }

            this.distance = 0
            this.lastX = x
            this.lastY = y
        }
    },

    mousePressed: function(button, x, y, modifiers) {
        this.pressed = true
        this.x = x
        this.y = y
        this.distance = 0
        this.counter = 0
        this.lastX = x
        this.lastY = y
    },

    mouseReleased: function(button, x, y, modifiers) {
        this.pressed = false
    },
})

Use the tiled.actions property to get a list of all available actions.

Actions that are checkable will toggle when triggered.

since

1.11

since

1.11

since

1.10

When the issue is activated (with double-click or Enter key) the given callback function is invoked.