Settings Reference

intermediate concepts

Tip: Hover over any option label in the Unity Inspector to see a tooltip with a short description.

General

Parameter	Description
Occluder	When enabled, this sprite triggers the see-through effect on other sprites with `HighlightEffect2D` when passing in front of them.
Preview In Editor	Renders effects in the Scene view without entering Play mode.
Pixel Snap	Aligns effects to the pixel grid for pixel-perfect rendering.
Alpha Cut Off	Pixels with alpha below this threshold are treated as transparent and excluded from effects.
Preserve Mesh	Uses the original mesh data instead of a generated quad. Enable when using `MeshRenderer` (e.g. Spine integration).
Polygon / SVG	Enable when the sprite uses polygon packing or is an SVG sprite.
Auto Size	When enabled, allows manual override of size, aspect ratio and center offset for effects.

Highlight

Parameter	Description
Ignore	Excludes this sprite from all highlight effects. Useful when effects are applied to a parent with Include = Children but this specific child should be skipped.
Highlighted	Master on/off toggle for the highlight state.
Include	Which objects receive effects: Only This Object, Children, or Root to Children.
Exclusive	Forces outline and glow to render independently on this object, even when overlapping other highlighted sprites.

Overlay

Adds a transparent solid-color layer on top of the sprite with optional blending modes and color animation.

Parameter	Description
Overlay	Enables the overlay effect.
Color	Tint color and alpha for the overlay.
Speed	Animation speed for the blinking/pulsing overlay.
Min Intensity	Minimum intensity during the animation cycle.

Outline

Adds a colored border around the sprite shape. Multiple quality levels are available.

Parameter	Description
Outline	Enables the outline effect.
Color	Color of the outline border.
Width	Width of the outline in pixels.
Exclusive	When enabled, renders the outline independently for this sprite even if it overlaps other highlighted sprites.

Glow

Adds a bloom-like glow around the sprite. Configure up to 4 glow passes with independent color, offset and alpha for rainbow or gradient effects.

Parameter	Description
Glow	Enables the glow effect.
Color	Base glow color.
Width	Glow width in pixels.
Speed	Speed of the glow animation cycle.
Auto Play	Whether the glow animation starts automatically.
Glow Passes	Array of passes (default 4). Each pass has its own Color, Alpha and Offset.

Scripting glow passes: Use SetGlowColor(color) for quick color changes, or access effect.glowPasses[] directly for per-pass control. Call UpdateMaterialProperties() after modifying passes.

Zoom Scale

Scales the sprite when highlighted to draw attention.

Parameter	Description
Zoom	Enables the zoom effect.
Scale	Scale factor applied when highlighted (e.g. 1.2 = 20% larger).

See-Through

Makes the sprite partially visible when occluded by other sprites marked as Occluder.

Parameter	Description
See-Through	Enables the x-ray silhouette effect.
Tint Color	Color of the see-through silhouette.
Tint Alpha	Transparency of the silhouette (0 = invisible, 1 = fully opaque).

Shadow

Adds a drop shadow behind the sprite. Supports 2D and 3D shadow styles.

Parameter	Description
Shadow	Enables the shadow effect.
Color	Shadow color.
Offset	Shadow offset from the sprite position (X, Y).

Hit FX

A one-shot flash effect triggered from script — ideal for damage feedback.

using HighlightPlus2D;

HighlightEffect2D effect = GetComponent<HighlightEffect2D>();
effect.HitFX(Color.red, 0.3f, 1f);

Parameter	Description
color	Flash color.
fadeOutDuration	Duration of the flash fade-out in seconds.
initialIntensity	Starting intensity of the flash (0–1).

Was this page helpful? |