Highlight

Not yet Class World & Effects

A visual effect which you can use to call attention to a specific object within an experience.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 13 modern Roblox members not implemented yet

Description

The Highlight instance is a visual effect which you can use to call attention to a specific object within an experience. Every highlight effect has a silhouette outline that surrounds the object and a solid overlay interior that displays over the object. You can customize both of these components independently to modify the highlight's visual appearance.

Base object

White outline, 50% red interior

Yellow outline, black interior

Useful applications of the highlight effect include:

• Providing visual feedback that an object is important and/or interactable.
• Making distant objects visible through objects that are closer to the user.
• Indicating the current position and status of other characters.

Limitations

As a performance limit, Studio only displays 255 simultaneous Highlight instances on the client at a time. If you exceed this limit, the additional instances are silently ignored. Note that while a Highlight with Enabled set to false doesn't display, it still takes one of the 255 available slots, so if you plan to permanently disable a Highlight instance, it's best to delete it rather than disable it.

Inheritance

Object → Instance → Highlight

Properties

Member	Signature	Summary
Adornee	Adornee: Instance	The Instance that the Highlight is applied to.
DepthMode	DepthMode: HighlightDepthMode	Controls how the Highlight effect displays with respect to other objects in the world.
Enabled	Enabled: bool	Sets whether or not the highlight is enabled.
FillColor	FillColor: Color3	Sets the Color3 value of the highlight's interior.
FillTransparency	FillTransparency: float	Sets the transparency of the highlight's interior.
LineThickness	LineThickness: int	—
OutlineColor	OutlineColor: Color3	Sets the Color3 value of the highlight's outline.
OutlineTransparency	OutlineTransparency: float	Sets the transparency of the highlight's outline.
ReservedId	ReservedId: ReservedHighlightId	—

Roblox reference: Highlight

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.