Highlight

Show Deprecated

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 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

Properties

Adornee

Read Parallel
Read Parallel

Enabled

Read Parallel

FillColor

Read Parallel

FillTransparency

Read Parallel

OutlineColor

Read Parallel

OutlineTransparency

Read Parallel

Methods

Events