8 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Highlight

Inherits from: Instance → Object

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.

    <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />

Base object

  </td>
  <td width="30%">
    

    <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/Adding-Highlight.jpg" />

White outline, 50% red interior

  </td>
  <td width="30%">
    

    <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" />

Yellow outline, black interior

  </td>
</tr>

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 255 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 255 available slots, so if you plan to permanently disable a Highlight instance, it's best to delete it rather than disable it.

Inherits from: Instance

Memory category: Instances

Properties

Name	Type / Returns	Description
Highlight.Adornee	Instance	The `Instance` that the `Highlight` is applied to.
Highlight.DepthMode	HighlightDepthMode	Controls how the `Highlight` effect displays with respect to other objects in the world.
Highlight.Enabled	boolean	Sets whether or not the highlight is enabled.
Highlight.FillColor	Color3	Sets the `Color3` value of the highlight's interior.
Highlight.FillTransparency	float	Sets the transparency of the highlight's interior.
Highlight.OutlineColor	Color3	Sets the `Color3` value of the highlight's outline.
Highlight.OutlineTransparency	float	Sets the transparency of the highlight's outline.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Highlight.Adornee

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

Field	Value
type	Instance
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

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

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/DepthMode-AlwaysOnTop.jpg" />

DepthMode = AlwaysOnTop

</td>
<td width="50%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/DepthMode-Occluded.jpg" />

DepthMode = Occluded

</td>

Field	Value
type	HighlightDepthMode
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Highlight.Enabled

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

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Highlight.FillColor

Sets the Color3 value of the highlight's interior.

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillColor-Red.jpg" />

FillColor = [255, 100, 50]

</td>
<td width="30%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillColor-Green.jpg" />

FillColor = [0, 255, 125]

</td>
<td width="30%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillColor-Blue.jpg" />

FillColor = [75, 150, 255]

</td>

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

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

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillTransparency-0.jpg" />

FillTransparency = 0

</td>
<td width="30%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillTransparency-Half.jpg" />

FillTransparency = 0.5

</td>
<td width="30%">
  

   <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/FillTransparency-1.jpg" />

FillTransparency = 1

</td>

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Highlight.OutlineColor

Sets the Color3 value of the highlight's outline.

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineColor-Red.jpg" />

OutlineColor = [255, 100, 50]

</td>
<td width="30%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineColor-Green.jpg" />

OutlineColor = [0, 255, 125]

</td>
<td width="30%">
  

   <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineColor-Blue.jpg" />

OutlineColor = [75, 150, 255]

</td>

Field	Value
type	Color3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Highlight.OutlineTransparency

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

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineTransparency-0.jpg" />

OutlineTransparency = 0

</td>
<td width="30%">
  

  <img src="https://prod.docsiteassets.roblox.com/assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />

OutlineTransparency = 1

</td>
<td width="30%">
</td>

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.