Highlight
CreatorHub

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

Memory category	Instances

Member index 9

History		Member
553		Adornee: Instance
553		DepthMode: HighlightDepthMode
553		Enabled: bool
553		FillColor: Color3
553		FillTransparency: float
566		LineThickness: int
553		OutlineColor: Color3
553		OutlineTransparency: float
553		ReservedId: ReservedHighlightId
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(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.

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
Hide member changes

566 Change Default of LineThickness from 0 to 1
565 Change Default of LineThickness from 1026162035 to 0
564 Change Default of LineThickness from 0 to 1026162035
554 Change Default of LineThickness from 186261472 to 0
555 Change Default of LineThickness from 0 to 186261472
555 Change Default of LineThickness from 187406120 to 0
554 Change Default of LineThickness from -536556268 to 187406120
553 Change Default of ReservedId from to Standard
553 Change Default of OutlineTransparency from to 0
553 Change Default of OutlineColor from to Color3(1, 1, 1)
553 Change Default of LineThickness from to -536556268
553 Change Default of FillTransparency from to 0.5
553 Change Default of FillColor from to Color3(1, 0, 0)
553 Change Default of Enabled from to true
553 Change Default of DepthMode from to AlwaysOnTop
553 Change Default of Adornee from to
547 Add ReservedId
547 Add LineThickness
508 Add Adornee
499 Add OutlineTransparency
499 Add OutlineColor
499 Add FillTransparency
499 Add FillColor
499 Add Enabled
499 Add DepthMode
499 Add Highlight

Members 9

Adornee
CreatorHub

Type		Default
Instance

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

553 Change Default of Adornee from to
508 Add Adornee

DepthMode
CreatorHub

Type		Default
HighlightDepthMode		AlwaysOnTop

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.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

553 Change Default of DepthMode from to AlwaysOnTop
499 Add DepthMode

Enabled
CreatorHub

Type		Default
bool		true

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 safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

553 Change Default of Enabled from to true
499 Add Enabled

FillColor
CreatorHub

Type		Default
Color3		1, 0, 0

Sets the Color3 value of the highlight's interior.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

553 Change Default of FillColor from to Color3(1, 0, 0)
499 Add FillColor

FillTransparency
CreatorHub

Type		Default
float		0.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.