env_beam

From Valve Developer Community
Revision as of 15:24, 10 February 2024 by N0one (talk | contribs) (Created page with "{{tabs|env_beam|goldsrc = 1|source = 1|main = source}} {{This is a|name=env_beam|e0|engine=1}} It creates a visible energy beam running between two entities, in ei...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

env_beam is an e0 available in all Template:1 games.Template:1 topicon

Warning.pngWarning:
  • The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template.
    If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page.

It creates a visible energy beam running between two entities, in either a line or ring shape.

Key Values

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Start Entity (LightningStart) <targetname>
Entity that the beam starts at. If omitted the entity will instead use a random position on any surface within its Radius value. A new random position will be appointed for every strike. See usage note above.
Ending Entity (LightningEnd) <targetname>
Entity that the beam ends at. If omitted the entity will instead use a random position on any surface within its Radius value. A new random position will be appointed for every strike. See usage note above.
Brightness (1 - 255) (renderamt) <integer>
Brightness of the beam, 1 = fully dark, 255 = Fully bright.
Beam Color (R G B) (rendercolor) <color255>
Beam color.
Radius (Radius) <integer>
If the Start Entity and/or Ending Entity values are omitted, this radius determines the area within which the endpoints will randomly strike. A new random position will be appointed for every strike.
Life (seconds 0 = infinite) (life) <string>
Amount of time before the beam dies. Setting to zero will make the beam stay forever.
Width of beam (pixels*0.1 0-255) (BoltWidth) <integer>
Pixel width of the beam. Range: 1 to MAX_BEAM_WIDTH.
Amount of noise (0-255) (NoiseAmplitude) <float>
The amount of noise in the beam. 0 is a perfectly straight beam, while the maximum is very jagged.
Sprite Name (texture) <sprite>
The material used to draw the beam.
Texture Scroll Rate (0-100) (TextureScroll) <integer>
Rate at which the beam texture should scroll along the beam.
Frames per 10 seconds (framerate) <integer>
Framerate at which the beam texture should animate, if it has multiple frames.
Starting Frame (framestart) <integer>
The frame to start the beam texture on.
Strike again time (secs) (StrikeTime) <string>
Refire time between random strikes of the beam. Only used if the 'Random Strike' spawnflag is set.
Damage/second (damage) <string>
How much damage this beam does per second to things it hits when it is continually on, or instantaneously if it strikes. For continuous damage, the value should be greater than 10 or it may not work.
Render FX (renderfx) <choices>
Render FX mode to use, for special effects.
Value Description
0 Normal
1 Slow Pulse
2 Fast Pulse
3 Slow Wide Pulse
4 Fast Wide Pulse
5 Slow Fade Away
6 Fast Fade Away
7 Slow Become Solid
8 Fast Become Solid
9 Slow Strobe
10 Fast Strobe
11 Faster Strobe
12 Slow Flicker
13 Fast Flicker
14 Constant Glow
15 Distort
16 Hologram (Distort + fade)
Render Mode (rendermode) <choices>
Render Mode to use.
Value Description
0 Normal
1 Color
2 Texture
3 Glow
4 Solid
5 Additive
Render Amount (0-255) (renderamt) <integer>
Controls transparency when using another render mode then normal. 0 is completely invisible, and 255 is opaque. If render mode is solid, then all values except 0 are opaque.
Render Color (R G B) (rendercolor) <color255>
Color to use by the specified render mode.
Also used on brush entities to control the speed of scrolling textures; see func_conveyor for more information.


Flags

  • [1]: Start On
  • [2]: Toggle
  • [4]: Random Strike
  • [8]: Ring
  • [16]: StartSparks
  • [32]: EndSparks
  • [64]: Decal End
  • [128]: Shade Start
  • [256]: Shade End