PO/Library/PackageCache/com.unity.2d.spriteshape@5.1.4/Documentation~/index.md

2D Sprite Shape

Overview

The Sprite Shape is a flexible and powerful world building Asset that features Sprite tiling along a shape's outline that automatically deforms and swaps Sprites based on the angle of the outline. Additionally, you can assign a Fill texture to a Sprite Shape to create filled shapes with tiled textures as backgrounds or other large level-building props.

The following are examples of Sprite Shapes used to construct different parts of various levels.

Sprite Shapes comprise of two parts - the Sprite Shape Profile Asset, and the Sprite Shape Controller component. The Sprite Shape Profile contains the angle settings and Sprites used by the Sprite Shape, and you edit the Sprite Shape's outline with the Sprite Shape Controller component.

Importing Sprites for Sprite Shapes

When importing Sprites, use the following property settings to ensure that the Sprites are compatible for use with Sprite Shape:

1. Texture Type - Set this to ‘Sprite (2D and UI)’. Other Texture types are not supported for Sprite Shapes.
2. Sprite Mode - Set this to ‘Single’ if the Texture contains only a single Sprite.
3. Mesh Type - This must be set to Full Rect for the Sprite to be used with Sprite Shape.

In addition, if the Sprites used for the Sprite Shape are part of a Sprite Atlas, disable both Allow Rotation and Tight Packing options under the Sprite Atlas’ properties so that the Sprites can be used by the Sprite Shape.

Sprite Shape workflow

Create Sprite Shapes in following the steps:

1. Create a Sprite Shape Profile from the main menu (menu: Assets > Create > Sprite Shape Profile). Select from the two available options:
   • Open Shape
   • Closed Shape
2. Create Angle Ranges and assign Sprites in the Sprite Shape Profile.
3. Drag the Sprite Shape Profile into the Scene to automatically generate a Sprite Shape GameObject based on that Profile.
   • You can create a Sprite Shape GameObject without a Profile from the main menu (menu: GameObject > 2D Object > Sprite Shape). Then select a Sprite Shape Profile in the Sprite Shape Controller's Profile settings. The same Profile can be used by multiple Sprite Shapes.
4. Edit the outline of the Sprite Shape with the Sprite Shape Controller component settings.
5. Enable Physics2D interactions for your Sprite Shapes by attaching a Collider component.