properties
Gets, sets, deletes, or replaces custom metadata on Aseprite sprites, layers, cels, tags, slices, tilesets, or tiles; use pluginKey to target an extension's fields.
Instructions
Gets, sets, deletes or replaces custom properties on a sprite, layer, cel, tag, slice, tileset or tile. With pluginKey ('publisher/extension') it reads/writes that extension's properties instead of the user properties.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | ||
| keys | No | delete: property names | |
| save | No | Batch mode: write changes back to the sprite file (default true) | |
| frame | No | 1-based frame number. Defaults to the active frame (or 1). | |
| index | No | Tile index for target=tile | |
| layer | No | Layer name, 'Group/Child' path, or 1-based index from get_sprite_info. Defaults to the active layer. | |
| slice | No | ||
| action | No | ||
| sprite | No | File path, open tab title, or sprite id. Defaults to the active sprite (live). Batch mode needs a file path. | |
| target | No | ||
| values | No | ||
| backend | No | auto (default): live Aseprite if connected, else headless batch | |
| tileset | No | ||
| pluginKey | No |