Beam
Renders a textured strip between two attachments.
- Creatable
Instance.new("Beam")- Inherits
- Instance
- Replication
- Standard
Behavior
Beam renders a textured strip between two attachments.
Summary
The first attachment used by the constraint or effect.
The second attachment used by the constraint or effect.
The brightness multiplier applied to the rendered particles or strip.
The color applied when rendering this instance.
The color distribution along the effect.
The tangent length controlling the Beam's curve at Attachment0.
The tangent length controlling the Beam's curve at Attachment1.
Whether this beam is enabled.
Whether the effect's strip faces the active camera.
The self-illumination contribution of the effect.
The amount of scene lighting applied to the rendered effect.
The number of segments used to approximate the Beam's curve.
The content identifier of the texture used by this instance.
The length of one repeated texture section along the Beam.
Whether the Beam texture stretches, wraps, or remains fixed.
The rate at which the effect's texture moves along its length.
The rendering transparency, from 0 for opaque to 1 for invisible.
The transparency distribution along the effect.
The strip width at Attachment0, in studs.
The strip width at Attachment1, in studs.
The depth offset applied when rendering the effect.
Returns this instance if it is an ExecutionGroup.
Properties
Attachment0
Beam.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
Beam.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Brightness
Beam.Brightness: number = 1The brightness multiplier applied to the rendered particles or strip.
Color
Beam.Color: Color3 = Color3.new(1, 1, 1)The color applied when rendering this instance.
ColorSequence
Beam.ColorSequence: ColorSequence = ColorSequence.new(...)The color distribution along the effect.
CurveSize0
Beam.CurveSize0: number = 0The tangent length controlling the Beam's curve at Attachment0.
CurveSize1
Beam.CurveSize1: number = 0The tangent length controlling the Beam's curve at Attachment1.
Enabled
Beam.Enabled: boolean = trueWhether this beam is enabled.
FaceCamera
Beam.FaceCamera: boolean = falseWhether the effect's strip faces the active camera.
LightEmission
Beam.LightEmission: number = 0The self-illumination contribution of the effect.
LightInfluence
Beam.LightInfluence: number = 0The amount of scene lighting applied to the rendered effect.
Segments
Beam.Segments: number = 10The number of segments used to approximate the Beam's curve.
Texture
Beam.Texture: Content = ""The content identifier of the texture used by this instance.
TextureLength
Beam.TextureLength: number = 1The length of one repeated texture section along the Beam.
TextureMode
Beam.TextureMode: Enum.TextureMode = Enum.TextureMode.StretchWhether the Beam texture stretches, wraps, or remains fixed.
TextureSpeed
Beam.TextureSpeed: number = 0The rate at which the effect's texture moves along its length.
Transparency
Beam.Transparency: number = 0The rendering transparency, from 0 for opaque to 1 for invisible.
TransparencySequence
Beam.TransparencySequence: NumberSequence = NumberSequence.new(...)The transparency distribution along the effect.
Width0
Beam.Width0: number = 1The strip width at Attachment0, in studs.
Width1
Beam.Width1: number = 1The strip width at Attachment1, in studs.
ZOffset
Beam.ZOffset: number = 0The depth offset applied when rendering the effect.
Methods
GetExecutionGroup
Beam:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying