Beam

Not yet Class World & Effects

Connects two Attachments by drawing a texture between them.

Not implemented yet

Textured ribbons between attachments are not implemented.

Workaround: Use a thin Part or a Trail-like chain of parts for simple effects.

0 Nova members · 27 modern Roblox members not implemented yet

Description

A Beam object connects two Attachments by drawing a texture between them.

To display, a beam must be a descendant of the Workspace with its Attachment0 and Attachment1 properties set to Attachments also descending from the Workspace.

The beam's appearance can be customized using the range of properties outlined below. Also see the Beams guide for visual examples.

Beam Curvature

Beams are configured to use a cubic Bézier curve formed by four control points. This means they are not constrained to straight lines and the curve of the beam can be modified by changing CurveSize0, CurveSize1, and the orientation of the beam's Attachments.

• P0 — The start of the beam; position of Attachment0.
• P1 — CurveSize0 studs away from Attachment0, in the positive X direction of Attachment0.
• P2 — CurveSize1 studs away from Attachment1, in the negative X direction of Attachment1.
• P3 — The end of the beam; position of Attachment1

Inheritance

Object → Instance → Beam

Properties

Member	Signature	Summary
Attachment0	Attachment0: Attachment	The Attachment the beam originates from.
Attachment1	Attachment1: Attachment	The Attachment the beam ends at.
Brightness	Brightness: float	Scales the light emitted from the beam when LightInfluence is less than 1.
Color	Color: ColorSequence	Determines the color of the beam across its Segments.
CurveSize0	CurveSize0: float	Determines, along with Attachment0, the position of the second control point in the beam's Bézier curve.
CurveSize1	CurveSize1: float	Determines, along with Attachment1, the position of the third control point in the beam's Bézier curve.
Enabled	Enabled: bool	Determines whether the beam is visible or not.
FaceCamera	FaceCamera: bool	Determines whether the Segments of the beam will always face the camera, regardless of its orientation.
LightEmission	LightEmission: float	Determines to what degree the colors of the beam are blended with the colors behind it.
LightInfluence	LightInfluence: float	Determines the degree to which the beam is influenced by the environment's lighting.
LocalTransparencyModifier	LocalTransparencyModifier: float	Determines a multiplier for Beam.Transparency that is only visible to the local client.
Segments	Segments: int	Sets how many straight segments the beam is made up of.
Texture	Texture: ContentId	The content ID of the texture to be displayed on the beam.
TextureContent	TextureContent: Content	The texture displayed on the beam. Supports asset URIs.
TextureLength	TextureLength: float	Sets the length of the beam's texture, dependent on TextureMode.
TextureMode	TextureMode: TextureMode	Determines the manner in which the Texture scales and repeats.
TextureSpeed	TextureSpeed: float	Determines the speed at which the Texture image moves along the beam.
Transparency	Transparency: NumberSequence	Determines the transparency of the beam across its segments.
Width0	Width0: float	The width of the beam at its origin (Attachment0), in studs.
Width1	Width1: float	The width of the beam at its end (Attachment1), in studs.
ZOffset	ZOffset: float	The distance, in studs, the beam display is offset relative to the CurrentCamera.

Methods

Member	Signature	Summary
SetTextureOffset	Beam:SetTextureOffset(offset: float = 0): null	Sets the current offset of the beam's texture cycle.

Roblox reference: Beam

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.