NSliceSpriteRenderer

Detailed reference for the NSliceSpriteRenderer component

NSliceSpriteRenderer Component

The NSliceSpriteRenderer component provides N-Slice functionality for 2D game environments. It extends the standard SpriteRenderer with advanced slicing capabilities.

Overview

NSliceSpriteRenderer is used in 2D game environments (not UI), providing essentially the same functionality as the N-Slice Image component. It divides images using the 9-slice method so that corners and borders remain undistorted when scaling to various sizes.

Key Features

  • Dedicated to 2D Game Environment: Works in World Space, not UI Canvas
  • N-Slice Compatible: Uses the same data format as N-Slice Image
  • SpriteRenderer Extension: Includes standard sprite rendering features
  • Real-time Size Adjustment: Size can be changed at runtime

⚠️ Important Warning

Size Adjustment in Scene View:

When you adjust object size by dragging with the mouse in Scene View, it changes the Transform Scale. This causes N-Slice borders to stretch as well, leading to unintended results.

  • Scene View Dragging: Scale changes → Border distortion
  • Inspector Size Field: Correct N-Slice behavior

Always adjust size using the Size field in the Inspector!

Component Reference

Differences from UI Image

FeatureNSliceSpriteRendererN-Slice Image
Environment2D World SpaceUI Canvas
Coordinate SystemWorld CoordinatesUI/Screen Coordinates
Size UnitsUnity UnitsPixels
Camera DependencyRequires CameraCanvas Rendering
Sorting MethodSorting Layer/OrderCanvas Hierarchy

Usage Examples

Creating Game Objects

1// Create new game object
2GameObject go = new GameObject("NSlice Object");
3
4// Add NSliceSpriteRenderer component
5NSliceSpriteRenderer renderer = go.AddComponent<NSliceSpriteRenderer>();
6
7// Assign N-Slice Data
8renderer.nSliceData = myNSliceData;
9
10// Set size (Important: Use Size field)
11renderer.size = new Vector2(5f, 3f);

Common Use Cases

  • Game UI Elements: Health bars, inventory slots, buttons
  • Environment Objects: Platforms, walls, decorations
  • Effects: Magic circles, portals, background effects
  • Tiling: Repeatable background patterns