Highlight
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.
 |  |  |
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 31 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 31 available slots, so if you plan to permanently disable a Highlight instance, it's best to delete it rather than disable it.
Summary
Properties
Controls how the Highlight effect displays with respect to other objects in the world.
Sets whether or not the highlight is enabled.
Sets the Color3 value of the highlight's interior.
Sets the transparency of the highlight's interior.
Sets the Color3 value of the highlight's outline.
Sets the transparency of the highlight's outline.
Properties
Adornee
The Instance for which to apply the Highlight, used to apply the effect to an Instance outside of a child/parent relationship.
DepthMode
Controls how the Highlight effect displays with respect to other objects in the world. You can set this property to one of the following options:
AlwaysOnTop — Allows the highlight to display regardless if there are objects between the camera and the highlighted object. This means the viewer is always able to see the highlight regardless of what is between the highlighted object and the camera.
Occluded — Hides the highlight if there are objects between the camera and the highlighted object. This means the viewer is only able to see the object if there are no obstructing objects between the highlighted object and the camera's view.
 |  |
Enabled
Sets whether or not the highlight is enabled. This does not impact performance, but disabled Highlight instances will still take one of the 31 available slots. If you plan to permanently disable a Highlight instance, it's best to delete it rather than disable it.
FillColor
Sets the Color3 value of the highlight's interior.
 |  |  |
FillTransparency
Sets the visibility of the highlight's interior to any value between the default value of 0 (opaque) and 1 (invisible). You can use this property to determine how much of the object's existing color you want viewers to see.
 |  |  |
OutlineColor
Sets the Color3 value of the highlight's outline.
 |  |  |
OutlineTransparency
Sets the visibility of the highlight's outline to a value between 0 (opaque) and 1 (transparent).
 | |