# Highlight

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/Highlight/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Highlight

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

## Properties

### Adornee

```luau
Highlight.Adornee: Instance
```

- Tags: Capabilities: Basic

The [`Instance`](https://rapi.sleaze.dev/classes/Instance.md) that the [`Highlight`](https://rapi.sleaze.dev/classes/Highlight.md) is applied to.

### DepthMode

```luau
Highlight.DepthMode: Enum.HighlightDepthMode = Enum.HighlightDepthMode.AlwaysOnTop
```

- Tags: Capabilities: Basic

Controls how the [`Highlight`](https://rapi.sleaze.dev/classes/Highlight.md) effect displays with respect to other objects in the world.

### Enabled

```luau
Highlight.Enabled: boolean = true
```

- Tags: Capabilities: Basic

Sets whether or not the highlight is enabled.

### FillColor

```luau
Highlight.FillColor: Color3 = Color3.new(1, 0, 0)
```

- Tags: Capabilities: Basic

Sets the [`Color3`](https://rapi.sleaze.dev/index/types/Color3.md) value of the highlight's interior.

### FillTransparency

```luau
Highlight.FillTransparency: number = 0.5
```

- Tags: Capabilities: Basic

Sets the transparency of the highlight's interior.

### LineThickness

```luau
Highlight.LineThickness: number = 1
```

- Tags: Hidden, Roblox script security, Read capabilities: Basic

### OutlineColor

```luau
Highlight.OutlineColor: Color3 = Color3.new(1, 1, 1)
```

- Tags: Capabilities: Basic

Sets the [`Color3`](https://rapi.sleaze.dev/index/types/Color3.md) value of the highlight's outline.

### OutlineTransparency

```luau
Highlight.OutlineTransparency: number = 0
```

- Tags: Capabilities: Basic

Sets the transparency of the highlight's outline.

### ReservedId

```luau
Highlight.ReservedId: Enum.ReservedHighlightId = Enum.ReservedHighlightId.Standard
```

- Tags: Hidden, Roblox script security, Read capabilities: Basic

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`