Skip to content

Commit

Permalink
chore: Update README and add newline
Browse files Browse the repository at this point in the history
  • Loading branch information
TheCyberRonin committed Oct 9, 2023
1 parent 0fa1f1c commit f65c0f1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ aseFile.parse();
## Layer Object
| Field | Type | Description |
|-----------------|---------|-------------------------------|
| flags | integer | flags for the layer |
| flags | [layer flags](#layer-flags-object) | flags for the layer translated into a map |
| type | integer | type |
| layerChildLevel | integer | layer child level |
| opacity | integer | opacity (0-255) |
Expand Down Expand Up @@ -271,6 +271,19 @@ aseFile.parse();
| x | integer | X position of the pivot |
| y | integer | Y position of the pivot |

## Layer Flags Object

This object is a utility object that will have ***ALL*** fields present. If a field is "on" it will be `true`, if the field is "off" it will be `false`.

| Field | Description |
|-------|---------|
| visible | Whether or not the layer is visible |
| editable | Whether or not the layer is editable |
| lockMovement | Whether or not the layer is a background layer |
| preferLinkedCels | Whether or not the layer prefers linked cels |
| collapsedGroup | Whether or not the layer group should be displayed collapsed |
| reference | Whether or not the layer is a reference layer |

# Further Info

If you would like to read up on the Aseprite file spec: [Spec](https://github.com/aseprite/aseprite/blob/master/docs/ase-file-specs.md)
2 changes: 1 addition & 1 deletion typings/Aseprite.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ declare namespace Aseprite {
collapsedGroup: boolean;
reference: boolean;
}
}
}

0 comments on commit f65c0f1

Please sign in to comment.