Inheritance Item object >SpriteSheetExporter object
Flash Pro CS6.
The SpriteSheetExporter object is a subclass of the Item object.
In addition to the Item object methods, you can use the following methods with the SpriteSheetExporter object:
| Method | Description |
|---|---|
| SpriteSheetExporter.addBitmap() | Adds a bitmap or bitmapItem to the sprite sheet. |
| SpriteSheetExporter.addSymbol() | Adds a symbol to be used to generate the sprite sheet. |
| SpriteSheetExporter.beginExport() | Initializes the SpriteSheetExporter to create a new sprite sheet. |
| SpriteSheetExporter.changeSymbol() | Changes which symbol frames will be added to the sprite sheet. |
| SpriteSheetExporter.exportSpriteSheet() | Export the sprite sheet into a an image file. |
| SpriteSheetExporter.removeBitmap() | Remove a bitmap object from the sprite sheet. |
| SpriteSheetExporter.removeSymbol() | Remove a symbol from the sprite sheet. |
In addition to the Item object properties, the following properties are available for the SpriteSheetExporter object:
| Property | Description |
|---|---|
| SpriteSheetExporter.algorithm | Sets the encoding algorithm for the sprite sheet. |
| SpriteSheetExporter.allowRotate | Allows sprites to be rotated when added to the sprite sheet. |
| SpriteSheetExporter.allowTrimming | Allows trimming of whitespace around sprites. |
| SpriteSheetExporter.app | A string indicating the name of the application generating the sprite sheet. |
| SpriteSheetExporter.autoSize | Automatically size the sprite sheet to fit all sprites. |
| SpriteSheetExporter.borderPadding | The amount of padding around the sprite sheet borders, in pixels. |
| SpriteSheetExporter.canBorderPad | A Boolean value indicating whether border padding is supported by the framework specified by the layoutFormat property. |
| SpriteSheetExporter.canRotate | A Boolean value indicating whether sprite rotation is supported by the framework specified by the layoutFormat property. |
| SpriteSheetExporter.canShapePad | A Boolean value indicating whether shape padding is supported by the framework specified by the layoutFormat property. |
| Property | Description |
|---|---|
| SpriteSheetExporter.canStackDuplicateFrames | A Boolean value indicating whether sprite stacking is supported by the framework specified by the layoutFormat property. |
| SpriteSheetExporter.canTrim | A Boolean value indicating whether shape trimming is supported by the framework specified by the layoutFormat property. |
| SpriteSheetExporter.format | The format of the sprite sheet image file. |
| SpriteSheetExporter.image | The name of the image file of the sprite sheet. |
| SpriteSheetExporter.layoutFormat | The format of the sprite sheet metadata. |
| SpriteSheetExporter.maxSheetHeight | Controls the maximum height of the generated sprite sheet when autoSize = true, clipped to a maximum value of 8192. |
| SpriteSheetExporter.maxSheetWidth | Controls the maximum width of the generated sprite sheet when autoSize = true, clipped to a maximum value of 8192. |
| SpriteSheetExporter.overflowed | A Boolean value indicating whether all the specified frames can fit in the specified sprite sheet size. |
| SpriteSheetExporter.shapePadding | The amount of padding around each sprite, in pixels. |
| SpriteSheetExporter.sheetHeight | The height of the sprite sheet, in pixels. |
| SpriteSheetExporter.sheetWidth | The width of the sprite sheet, in pixels. |
| SpriteSheetExporter.stackDuplicate | A Boolean value indicating whether to stack identical symbol frames in the sprite sheet. |
| SpriteSheetExporter.version | The version number of the application creating the sprite sheet. |