diff --git a/README.md b/README.md index 7e256dd..a049b4b 100644 --- a/README.md +++ b/README.md @@ -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) | @@ -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) \ No newline at end of file diff --git a/typings/Aseprite.d.ts b/typings/Aseprite.d.ts index 318abd9..eb62552 100644 --- a/typings/Aseprite.d.ts +++ b/typings/Aseprite.d.ts @@ -134,4 +134,4 @@ declare namespace Aseprite { collapsedGroup: boolean; reference: boolean; } -} \ No newline at end of file +}