Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Highlight

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

Memory categoryInstances

Member index 9

HistoryMember
553Adornee: Instance
553DepthMode: HighlightDepthMode
553Enabled: bool
553FillColor: Color3
553FillTransparency: float
553OutlineColor: Color3
553OutlineTransparency: float
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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

History 26

Members 9

Adornee

TypeDefault
Instance

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

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

DepthMode

TypeDefault
HighlightDepthModeAlwaysOnTop

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.

DepthMode = AlwaysOnTop
DepthMode = Occluded
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Enabled

TypeDefault
booltrue

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.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

FillColor

TypeDefault
Color31, 0, 0

Sets the Color3 value of the highlight's interior.

FillColor = [255, 100, 50]
FillColor = [0, 255, 125]
FillColor = [75, 150, 255]
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

FillTransparency

TypeDefault
float0.5

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.

FillTransparency = 0
FillTransparency = 0.5
FillTransparency = 1
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

OutlineColor

TypeDefault
Color31, 1, 1

Sets the Color3 value of the highlight's outline.

OutlineColor = [255, 100, 50]
OutlineColor = [0, 255, 125]
OutlineColor = [75, 150, 255]
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

OutlineTransparency

TypeDefault
float0

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

OutlineTransparency = 0
OutlineTransparency = 1
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Settings

Appearance
Visibility