Skip to main content

env_beam

Point Entity

An entity that creates a visible beam between two points. The points can be attached to entities to make the beam move around.

Keyvalues

  • Render FX (renderfx) <Choices>

    • Normal
    • Slow Pulse
    • Fast Pulse
    • Slow Wide Pulse
    • Fast Wide Pulse
    • Slow Strobe
    • Fast Strobe
    • Faster Strobe
    • Slow Flicker
    • Fast Flicker
    • Slow Fade Away
    • Fast Fade Away
    • Slow Become Solid
    • Fast Become Solid
    • Constant Glow
    • Distort
    • Hologram (Distort + fade)
    • Cull By Distance (TEST)
    • Spotlight FX
    • Fade Near

  • Parent (parentname) <TargetDestination>
    The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.

  • Parent Model Bone/Attachment Name (parentAttachmentName) <ParentAttachment>
    The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment.

  • Model Attachment position offset (local.origin) <Vector>
    Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Model Attachment angular offset (local.angles) <Angle>
    Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Model Attachment scale (local.scales) <Vector>
    Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Use Model Attachment Offset (useLocalOffset) <Boolean>
    Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • Brightness (1 - 255) (renderamt) <Integer>

  • Beam Color (R G B) (rendercolor) <Color255>

  • Radius (Radius) <Integer>
    If the 'Random Strike' spawnflag is set, this radius determines the area within which the endpoints will randomly 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 (BoltWidth) <Float>
    Pixel width of the beam.

  • Amount of noise (0-255) (NoiseAmplitude) <Float>
    The amount of noise in the beam. 0 is a perfectly straight beam.

  • 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.

  • Start Entity (LightningStart) <TargetDestination>
    Entity that the beam starts at.

  • Ending Entity (LightningEnd) <TargetDestination>
    Entity that the beam ends at.

  • Decal Name (decalname) <String>
    Decal to be applied at the end of the beam

  • HDR color scale. (HDRColorScale) <Float>
    float value to multiply sprite color by when running in HDR mode.

  • Endpoint handle (targetpoint) <Vecline>
    If a LightningEnd entity is not specified, use this point as the destination instead. If the env_beam moves, the destination point will move along with it.

  • Spawnflags (spawnflags) <Flags>

    • Start On
    • Toggle
    • Random Strike
    • Ring
    • StartSparks
    • EndSparks
    • Decal End
    • Shade Start
    • Shade End
    • Taper Out

  • Touch Type (tripwire) (TouchType) <Choices>
    If you want the beam to fire an output when touched by entities, choose the entity type here.

    • Not a tripwire
    • Player Only
    • NPC Only
    • Player or NPC
    • Player or NPC or Physprop

  • Beam clipping (ClipStyle) <Choices>
    Select whether you want the beam to clip against geometry or characters

    • Do not clip (default)
    • Clip to geometry
    • Clip to everything solid

  • Filter Name (filtername) <FilterClass>
    Filter to use to see if activator triggers me. See filter_activator_name for more explanation.

Inputs

  • SetParent <TargetDestination>
    Changes the entity's parent in the movement hierarchy.

  • SetParentAttachment <String>
    Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

  • SetParentAttachmentMaintainOffset <String>
    Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.

  • ClearParent <Void>
    Removes this entity from the the movement hierarchy, leaving it free to move independently.

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

  • CallScriptFunction <String>
    Call a script function

  • CallPrivateScriptFunction <String>
    Calls a script function from this entity's private script scope.

  • CallGlobalScriptFunction <String>
    Calls a script function in the global script scope.

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • TurnOn <Void>
    Turns the beam on.

  • TurnOff <Void>
    Turns the beam off.

  • Toggle <Void>
    Toggles the beam between on and off.

  • StrikeOnce <Void>
    Causes the beam to strike once. It will stay on for its set Life and then turn off (it will never turn off if Life is set to zero).

  • Alpha <Integer>
    Sets the beam's alpha (0 - 255).

  • Color <Color255>
    Sets the beam's render color (R G B).

  • ColorRedValue <Float>
    Sets the red color channel's value (0 - 255).

  • ColorGreenValue <Float>
    Sets the green color channel's value (0 - 255).

  • ColorBlueValue <Float>
    Sets the blue color channel's value (0 - 255).

  • Amplitude <Float>
    Set the amplitude of beam noise (0 - 255).

  • ScrollSpeed <Float>
    Set the scroll speed in units per second (0 - 100).

  • Width <Float>
    Set the width of the beam, in pixels.

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game.

  • OnTouchedByEntity <Void>
    Fired when an entity touches the beam. Only fired if the entity passes the 'Touch Type' choice.