[ScriptedImporter(21300003, new string[] { "aseprite", "ase" }, AllowCaching = true)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.aseprite@latest")]
public class AsepriteImporter : ScriptedImporter, ISpriteEditorDataProvider

Properties

OnPostAsepriteImport

Event that is fired at the last step of the Aseprite import process.

Declaration

public AsepriteImporter.AsepriteImportEventHandler OnPostAsepriteImport { get; set; }

Property Value

Type	Description
AsepriteImporter.AsepriteImportEventHandler

addShadowCasters

Add Shadow Casters to the generated GameObjects with SpriteRenderers.

Declaration

public bool addShadowCasters { get; set; }

Property Value

Type	Description
bool

addSortingGroup

Add a Sorting Group component to the root of the generated model prefab if it has more than one Sprite Renderer.

Declaration

public bool addSortingGroup { get; set; }

Property Value

Type	Description
bool

aniso

Anisotropic filtering level of the texture.

Declaration

public int aniso { get; set; }

Property Value

Type	Description
int

asepriteFile

A parsed representation of the Aseprite file.

Declaration

public AsepriteFile asepriteFile { get; }

Property Value

Type	Description
AsepriteFile

canvasSize

The canvas size of the source file.

Declaration

public Vector2 canvasSize { get; }

Property Value

Type	Description
Vector2

customPivotPosition

Normalized position of the custom pivot.

Declaration

public Vector2 customPivotPosition { get; set; }

Property Value

Type	Description
Vector2

filterMode

Filtering mode of the texture.

Declaration

public FilterMode filterMode { get; set; }

Property Value

Type	Description
FilterMode

generateAnimationClips

Generate Animation Clips based on the frame data of the source asset.

Declaration

public bool generateAnimationClips { get; set; }

Property Value

Type	Description
bool

generateIndividualEvents

Events will be generated with their own method name. If disabled, all events will be received by the method OnAnimationEvent(string).

Declaration

public bool generateIndividualEvents { get; set; }

Property Value

Type	Description
bool

generateModelPrefab

Generate a Model Prefab based on the layers of the source asset.

Declaration

public bool generateModelPrefab { get; set; }

Property Value

Type	Description
bool

generatePhysicsShape

If enabled, generates a default physics shape from the outline of the Sprite/s when a physics shape has not been set in the Sprite Editor.

Declaration

public bool generatePhysicsShape { get; set; }

Property Value

Type	Description
bool

generateSpriteAtlas

Generate a Sprite Atlas to contain the created texture. This is only available when importing a Tile Set.

Declaration

public bool generateSpriteAtlas { get; set; }

Property Value

Type	Description
bool

importMode

How the file should be imported.

Declaration

public FileImportModes importMode { get; set; }

Property Value

Type	Description
FileImportModes

includeHiddenLayers

Should include hidden layers from the source file.

Declaration

public bool includeHiddenLayers { get; set; }

Property Value

Type	Description
bool

layerImportMode

The import mode for all layers in the file.

Declaration

public LayerImportModes layerImportMode { get; set; }

Property Value

Type	Description
LayerImportModes

mipMapBias

Mip map bias of the texture.

Declaration

public float mipMapBias { get; set; }

Property Value

Type	Description
float

mipMapsPreserveCoverage

Enables or disables coverage-preserving alpha mipmapping.

Enable this to rescale the alpha values of computed mipmaps so coverage is preserved. This means a higher percentage of pixels passes the alpha test and lower mipmap levels do not become more transparent. This is disabled by default (set to false).

Declaration

public bool mipMapsPreserveCoverage { get; set; }

Property Value

Type	Description
bool

mipmapEnabled

Generate Mip Maps.

Select this to enable mip-map generation. Mipmaps are smaller versions of the Texture that get used when the Texture is very small on screen.

Declaration

public bool mipmapEnabled { get; set; }

Property Value

Type	Description
bool

mipmapFadeDistanceEnd

Mip level where texture is faded out completely.

Declaration

public int mipmapFadeDistanceEnd { get; set; }

Property Value

Type	Description
int

mipmapFadeDistanceStart

Mip level where texture begins to fade out.

Declaration

public int mipmapFadeDistanceStart { get; set; }

Property Value

Type	Description
int

mipmapFilter

Mip level where texture is faded out completely.

Declaration

public TextureImporterMipFilter mipmapFilter { get; set; }

Property Value

Type	Description
TextureImporterMipFilter

mosaicPadding

External padding between each SpriteRect, in pixels.

Declaration

public uint mosaicPadding { get; set; }

Property Value

Type	Description
uint

pivotAlignment

How a Sprite's graphic rectangle is aligned with its pivot point.

Declaration

public SpriteAlignment pivotAlignment { get; set; }

Property Value

Type	Description
SpriteAlignment

pivotSpace

The space the Sprite pivots are being calculated.

Declaration

public PivotSpaces pivotSpace { get; set; }

Property Value

Type	Description
PivotSpaces

sRGBTexture

Whether this texture stores data in sRGB (also called gamma) color space.

Declaration

public bool sRGBTexture { get; set; }

Property Value

Type	Description
bool

spriteExtrude

The number of blank pixels to leave between the edge of the graphic and the mesh.

Declaration

public uint spriteExtrude { get; set; }

Property Value

Type	Description
uint

spriteImportMode

Selects Single or Manual import mode for Sprite textures.

Declaration

public SpriteImportMode spriteImportMode { get; set; }

Property Value

Type	Description
SpriteImportMode	Valid values are SpriteImportMode.Multiple or SpriteImportMode.Single.

Exceptions

Type	Condition
ArgumentException	Exception when non valid values are set.

spriteMeshType

Sets the type of mesh to ge generated for each Sprites.

Declaration

public SpriteMeshType spriteMeshType { get; set; }

Property Value

Type	Description
SpriteMeshType

spritePadding

Internal padding within each SpriteRect, in pixels.

Declaration

public uint spritePadding { get; set; }

Property Value

Type	Description
uint

spritePixelsPerUnit

The number of pixels in the sprite that correspond to one unit in world space.

Declaration

public float spritePixelsPerUnit { get; set; }

Property Value

Type	Description
float

streamingMipmaps

Enable mipmap streaming for the texture.

Only load larger mipmaps as needed to render the current game cameras. Requires texture streaming to be enabled in quality settings.

Declaration

public bool streamingMipmaps { get; set; }

Property Value

Type	Description
bool

streamingMipmapsPriority

Mipmap streaming priority when there's contention for resources. Positive numbers represent higher priority. The valid range is -128 to 127.

Declaration

public int streamingMipmapsPriority { get; set; }

Property Value

Type	Description
int

textureType

Which type of texture are we dealing with here.

Declaration

public TextureImporterType textureType { get; set; }

Property Value

Type	Description
TextureImporterType	Valid values are TextureImporterType.Default or TextureImporterType.Sprite.

Exceptions

Type	Condition
ArgumentException	Exception when non valid values are set.

wrapMode

Texture coordinate wrapping mode.

Using wrapMode sets the same wrapping mode on all axes. Different per-axis wrap modes can be set using wrapModeU, wrapModeV, wrapModeW. Querying the value returns the U axis wrap mode (same as wrapModeU getter).

Declaration

public TextureWrapMode wrapMode { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeU

Texture U coordinate wrapping mode.

Controls wrapping mode along texture U (horizontal) axis.

Declaration

public TextureWrapMode wrapModeU { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeV

Texture V coordinate wrapping mode.

Controls wrapping mode along texture V (vertical) axis.

Declaration

public TextureWrapMode wrapModeV { get; set; }

Property Value

Type	Description
TextureWrapMode

wrapModeW

Texture W coordinate wrapping mode for Texture3D.

Controls wrapping mode along texture W (depth, only relevant for Texture3D) axis.

Declaration

public TextureWrapMode wrapModeW { get; set; }

Property Value

Type	Description
TextureWrapMode

Methods

GetImporterPlatformSettings(BuildTarget)

Retrieves the platform settings used by the importer for a given build target.

Declaration

public TextureImporterPlatformSettings GetImporterPlatformSettings(BuildTarget buildTarget)

Parameters

Type	Name	Description
BuildTarget	buildTarget	The build target to query.

Returns

Type	Description
TextureImporterPlatformSettings	TextureImporterPlatformSettings used for importing the texture for the build target.

OnImportAsset(AssetImportContext)

This method must by overriden by the derived class and is called by the Asset pipeline to import files.

Declaration

public override void OnImportAsset(AssetImportContext ctx)

Parameters

Type	Name	Description
AssetImportContext	ctx	This argument contains all the contextual information needed to process the import event and is also used by the custom importer to store the resulting Unity Asset.

Overrides

ScriptedImporter.OnImportAsset(AssetImportContext)

SetImporterPlatformSettings(TextureImporterPlatformSettings)

Sets the platform settings used by the importer for a given build target.

Declaration

public void SetImporterPlatformSettings(TextureImporterPlatformSettings setting)

Parameters

Type	Name	Description
TextureImporterPlatformSettings	setting	TextureImporterPlatformSettings to be used by the importer for the build target indicated by TextureImporterPlatformSettings.

SupportsRemappedAssetType(Type)

Override this method if your ScriptedImporter supports remapping specific asset types.

Declaration

public override bool SupportsRemappedAssetType(Type type)

Parameters

Type	Name	Description
Type	type	The type of asset to check.

Returns

Type	Description
bool	Returns true if the importer supports remapping the given type. Otherwise, returns false.

Overrides

ScriptedImporter.SupportsRemappedAssetType(Type)

Implements

UnityEditor.U2D.Sprites.ISpriteEditorDataProvider