Skip to content

Document object.properties does not store/load for non-aseprite file formats #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arecher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document object.properties does not store/load for non-aseprite file formats #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions api/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Properties

Some objects like a [Sprite](sprite.md#sprite),
Certain objects like [Sprite](sprite.md#sprite),
[Layer](layer.md#layer), [Cel](cel.md#cel), [Slice](slice.md#slice),
[Tag](tag.md#tag), [Tileset](tileset.md#tileset), [Tile](tile.md#tile),
contain some special fields like `.color` and `.data` to store a
contain special fields like `.color` and `.data` to store a
user-defined [color](color.md#color) or user-defined text (any text).

Anyway, since **Aseprite 1.3-rc1** you can have user-defined and
Since **Aseprite 1.3-rc1** you can have user-defined and
extension-defined properties for each of these objects. We will use
`object` in the following examples, as it can be of any kind (Sprite,
Layer, etc.).
Expand All @@ -24,6 +24,12 @@ object.properties = { myInteger=1, myNumber=1.2, ... }

You can set one property at a time, or all properties at the same
time. Each time a property is set, it generates undo information.
Changing any property will [modify](sprite.md#spriteismodified) the
Sprite and requires the Sprite to be **resaved** to store the data.

Properties are only stored on-disk in Aseprite-specific file formats,
and might be lost for other files, such as `.png` or `.gif`, when the
file is closed.

* The syntax `object.properties = { ... }` sets the user-defined
properties, but doesn't modify the properties related to extensions.
Expand Down