# Beam

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/Beam/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Beam

Connects two `Attachments` by drawing a texture between them.

## Properties

### Brightness

```luau
Beam.Brightness: number = 1
```

- Tags: Read capabilities: Basic

Scales the light emitted from the beam when [`LightInfluence`](https://rapi.sleaze.dev/classes/Beam.md) is less than 1.

### Color

```luau
Beam.Color: ColorSequence = 0 1 1 1 0 1 1 1 1 0
```

- Tags: Read capabilities: Basic

Determines the color of the beam across its [`Segments`](https://rapi.sleaze.dev/classes/Beam.md).

### Enabled

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

- Tags: Read capabilities: Basic

Determines whether the beam is visible or not.

### LightEmission

```luau
Beam.LightEmission: number = 0
```

- Tags: Read capabilities: Basic

Determines to what degree the colors of the beam are blended with the colors behind it.

### LightInfluence

```luau
Beam.LightInfluence: number = 0
```

- Tags: Read capabilities: Basic

Determines the degree to which the beam is influenced by the environment's lighting.

### LocalTransparencyModifier

```luau
Beam.LocalTransparencyModifier: number = 0
```

- Tags: Hidden, Not replicated, Read capabilities: Basic

Determines a multiplier for [`Beam.Transparency`](https://rapi.sleaze.dev/classes/Beam.md) that is only visible to the local client.

### Texture

```luau
Beam.Texture: string = ""
```

- Tags: Read capabilities: Basic

The content ID of the texture to be displayed on the beam.

### TextureContent

```luau
Beam.TextureContent: Content
```

- Tags: Capabilities: Basic

The texture displayed on the beam. Supports [asset URIs](https://create.roblox.com/docs/projects/assets#asset-uris).

### TextureLength

```luau
Beam.TextureLength: number = 1
```

- Tags: Read capabilities: Basic

Sets the length of the beam's texture, dependent on [`TextureMode`](https://rapi.sleaze.dev/classes/Beam.md).

### TextureMode

```luau
Beam.TextureMode: Enum.TextureMode = Enum.TextureMode.Stretch
```

- Tags: Read capabilities: Basic

Determines the manner in which the [`Texture`](https://rapi.sleaze.dev/classes/Texture.md) scales and repeats.

### TextureSpeed

```luau
Beam.TextureSpeed: number = 1
```

- Tags: Read capabilities: Basic

Determines the speed at which the [`Texture`](https://rapi.sleaze.dev/classes/Texture.md) image moves along the beam.

### Transparency

```luau
Beam.Transparency: NumberSequence = 0 0.5 0 1 0.5 0
```

- Tags: Read capabilities: Basic

Determines the transparency of the beam across its segments.

### ZOffset

```luau
Beam.ZOffset: number = 0
```

- Tags: Read capabilities: Basic

The distance, in studs, the beam display is offset relative to the `CurrentCamera`.

### Attachment0

```luau
Beam.Attachment0: Attachment
```

- Tags: Read capabilities: Basic

The [`Attachment`](https://rapi.sleaze.dev/classes/Attachment.md) the beam originates from.

### Attachment1

```luau
Beam.Attachment1: Attachment
```

- Tags: Read capabilities: Basic

The [`Attachment`](https://rapi.sleaze.dev/classes/Attachment.md) the beam ends at.

### CurveSize0

```luau
Beam.CurveSize0: number = 0
```

- Tags: Read capabilities: Basic

Determines, along with [`Attachment0`](https://rapi.sleaze.dev/classes/Beam.md), the position of the second control point in the beam's Bézier curve.

### CurveSize1

```luau
Beam.CurveSize1: number = 0
```

- Tags: Read capabilities: Basic

Determines, along with [`Attachment1`](https://rapi.sleaze.dev/classes/Beam.md), the position of the third control point in the beam's Bézier curve.

### FaceCamera

```luau
Beam.FaceCamera: boolean = false
```

- Tags: Read capabilities: Basic

Determines whether the [`Segments`](https://rapi.sleaze.dev/classes/Beam.md) of the beam will always face the camera, regardless of its orientation.

### Segments

```luau
Beam.Segments: number = 10
```

- Tags: Read capabilities: Basic

Sets how many straight segments the beam is made up of.

### Width0

```luau
Beam.Width0: number = 1
```

- Tags: Read capabilities: Basic

The width of the beam at its origin ([`Attachment0`](https://rapi.sleaze.dev/classes/Beam.md)), in studs.

### Width1

```luau
Beam.Width1: number = 1
```

- Tags: Read capabilities: Basic

The width of the beam at its end ([`Attachment1`](https://rapi.sleaze.dev/classes/Beam.md)), in studs.

## Methods

### SetTextureOffset

```luau
Beam:SetTextureOffset(offset: number? = 0)
```

- Tags: Capabilities: Basic

Sets the current offset of the beam's texture cycle.

Parameters:

- `offset`: The desired offset of the texture cycle.

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