get_properties
Read custom properties stored on an Aseprite sprite object, including named namespaces, to retrieve metadata omitted by sprite info and sheet exports.
Instructions
Read the custom properties stored on one object inside the sprite.
The counterpart to `set_properties`, and the only way to read that metadata back:
neither `get_sprite_info` nor the sprite-sheet export reports custom properties.
Args:
target, layer, frame, name, tile: Which object, exactly as `set_properties`
takes them.
namespace: Read a named group instead of the unnamed one. Aseprite offers no way
to list the namespaces an object has, so a group can only be read by a caller
who knows its name; an unknown name reads as empty rather than as an error.
Returns `properties` as an object of key to value, each value in the type it was
stored as. A value of a type JSON cannot describe (the editor can store a point or a
rectangle) is reported as text rather than dropped.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| tile | No | ||
| frame | No | ||
| layer | No | ||
| target | Yes | ||
| filename | Yes | ||
| namespace | No |