Prototype/Beam
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/BeamPrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Beam
Used as a laser beam.
Mandatory properties
This prototype inherits all the properties from Prototype/Entity.
All animations must have the same number of frames: Tail must have same number of frames as start, ending, head, body, start_light, ending_light, head_light, tail_light and body_light.
width
Type: double
damage_interval
Type: uint32
Damage interval can't be 0. A value of 1 will cause the attack to be applied each tick.
head
Type: Animation
Head segment of the beam.
tail
Type: Animation
Tail segment of the beam.
body
Type: AnimationVariations
Body segment of the beam. Must have at least 1 variation.
Optional properties
action
Type: Trigger
target_offset
Type: vector
random_target_offset
Type: bool
Default: false
action_triggered_automatically
Type: bool
Default: false
Whether this beams should trigger its action every damage_interval. If false, the action is instead triggered when its owner triggers shooting.
random_end_animation_rotation
Type: bool
Default: true
transparent_start_end_animations
Type: bool
Default: true
start
Type: Animation
Start point of the beam.
ending
Type: Animation
End point of the beam.
light_animations
Type: table
Lights are additively accumulated onto lightmap, which is multiplicatively rendered on the game world.[1]
Table with the following members:
- start - Animation - Optional.
- ending - Animation - Optional.
- head - Animation - Optional.
- tail - Animation - Optional.
- body - AnimationVariations - Optional.
ground_light_animations
Type: table
Table with the following members:
- start - Animation - Optional.
- ending - Animation - Optional.
- head - Animation - Optional.
- tail - Animation - Optional.
- body - AnimationVariations - Optional.
start_light
Type: Animation
This and the below properties ending in "_light" are considered deprecated. If they are present, then light_animations
and ground_light_animations
are not loaded.
ending_light
Type: Animation
head_light
Type: Animation
tail_light
Type: Animation
body_light
Type: AnimationVariations