Highlight

Show Deprecated

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

Original ObjectBlack Outline, Yellow InteriorYellow 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.

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.

For low-end devices, Studio uses a fallback version that doesn't have high performance overheads. This version doesn't have the outline effect; instead, it creates an interior fill with a checker pattern to emulate the FillTransparency property.

Summary

Properties

The Instance that the Highlight is applied to.

Sets whether or not the highlight is enabled

Sets the Class.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

Events

Methods

Properties

Adornee

The Instance for which to apply the Highlight, to insert a Highlight for an Instance outside of a child/parent relationship.

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 user 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 user is only able to see the object if there are no obstructing objects between the highlighted object and the camera's view.

DepthMode = AlwaysOnTopDepthMode = Occluded

Enabled

Sets whether or not the highlight is enabled. This does not impact performance, however if disabled the Highlight instance will still take one of the 31 available slots. If you plan to permanently disable a Highlight instance, it's recommended to delete it rather than disable it.

FillColor

Sets the Class.Color3 value of the highlight's interior

FillColor = [255, 100, 50]FillColor = [0, 255, 125]FillColor = [75, 150, 255]

FillTransparency

Sets the visibility of the highlight's interior to any value between the default value of 0 (opaque) and 1 (transparent). You can use this property to determine how much of the object's existing color you want users to see.

FillTransparency = 0FillTransparency = 0.5FillTransparency = 1

OutlineColor

Sets the Color3 value of the highlight's outline.

OutlineColor = [255, 100, 50]OutlineColor = [0, 255, 125]OutlineColor = [75, 150, 255]

OutlineTransparency

Sets the visibility of the highlight's outline to a value between 0 (opaque) and 1 (transparent).

OutlineTransparency = 0OutlineTransparency = 1

Events

Methods