This article's documentation is for anything that uses the Source engine. Click here for more information.

Beam spotlight: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Reformatted the note that says this entity is also available in Garry's Mod into the format seen on other pages.)
 
(19 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{base point|beam_spotlight|sprite=1}} It is used to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. Unless the 'No Dynamic Light' spawnflag is checked, it will also create a dynamic light wherever the end of the spotlight rests. Other than its ability to rotate, this entity is functionally identical to [[point_spotlight]].
{{LanguageBar}}
{{this is a|point entity|name=beam_spotlight|sprite=1|engine=Source|since=Left 4 Dead}} It is also available in {{gmod|4}}.
{{CD|CBeamSpotlight|file1=beamspotlight.cpp}}


This spotlight is entirely client side, it is not sync'd across clients.
It is used to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. It will also create a dynamic light wherever the end of the spotlight rests. Other than its ability to rotate, this entity is functionally identical to {{ent|point_spotlight}}.
 
{{note|This spotlight is entirely client side, and rotation may be desynchronized between clients.}}


{{tip|Can be set to rotate for a lighthouse search beam effect.}}
{{tip|Can be set to rotate for a lighthouse search beam effect.}}


== Keyvalues ==
==Flags==
{{KV|Max Rotation Speed|integer|The maximum rotation speed of the spotlight, in degrees per second.}}
{{fl|1|Start On|}}
{{KV|Spotlight Length|integer|Length of the spotlight beam.}}
{{fl|2|No Dynamic Light - Do not create any actual light.|}}
{{KV|Spotlight Width|integer|Width of the spotlight beam.}}
{{fl|4|Start with Rotation On|}}
{{KV|Color (R G B)|color255|The color of the beam. Black makes the beam invisible, so no "Shadow Beams." }}
{{fl|8|Reverse Direction|}}
{{KV|HDR color scale.|float|float value to multiply sprite color by when running in HDR mode.}}
{{fl|16|X Axis|}}
{{KV Targetname}}
{{fl|32|Y Axis|}}
{{KV Parentname}}
({{clarify}} are these axes relative to the world or to the entity?)
 
==Keyvalues==
{{KV|Max Rotation Speed|intn=maxspeed|integer|The maximum rotation speed of the spotlight, in degrees per second.}}
{{KV|Spotlight Length|intn=SpotlightLength|integer|Length of the spotlight beam.}}
{{KV|Spotlight Width|intn=SpotlightWidth|integer|Width of the spotlight beam.}}
{{KV|HDR color scale|intn=HDRColorScale|float|Multiplier for sprite color by when running in HDR mode.}}
{{KV|Halo Sprite|intn=HaloSprite|sprite|The material that should be used for the halo.|only={{l4d}}}}
{{KV|Beam Sprite|intn=BeamSprite|sprite|The material that should be used for the beam.|only={{l4d}}}}
{{KV RenderFields}}
{{KV RenderFields}}
{{KV Angles}}
{{KV DXLevelChoice}}
{{KV SystemLevelChoice}}
== Flags ==
:* 1 : Start On
:* 2 : No Dynamic Light
:* 4 : Start rotation on
:* 8 : Reverse Direction
:* 16 : X Axis
:* 32 : Y Axis


== Inputs ==
==Inputs==
{{IO|LightOn|Turn the spotlight on.}}
{{I|LightOn|Turn the spotlight on.}}
{{IO|LightOff|Turn the spotlight off}}
{{I|LightOff|Turn the spotlight off}}
{{IO|Start|Start the rotator rotating.}}
{{I|Start|Start rotating.}}
{{IO|Stop|Stop the rotator from rotating.}}
{{I|Stop|Stop rotating.}}
{{IO|Reverse|Reverse the direction of rotation of the rotator.}}
{{I|Reverse|Reverse the direction of rotation.}}
{{I Targetname}}
{{I Parentname}}
{{I RenderFields}}
{{I RenderFields}}


== Outputs ==
==Outputs==
{{IO|OnLightOn|Fires when light turns on.}}
{{O|OnLightOn|Fires when light turns on.}}
{{IO|OnLightOff|Fires when light turns off.}}
{{O|OnLightOff|Fires when light turns off.}}
{{O Targetname}}


[[Category:Lighting]]
[[Category:Lighting]]

Latest revision as of 06:19, 4 October 2025

English (en)Русский (ru)Translate (Translate)
Beam spotlight.png

beam_spotlight is a point entity available in all Source Source games since Left 4 Dead Left 4 Dead. It is also available in Garry's Mod Garry's Mod.

C++ Class hierarchy
CBeamSpotlight
↳CBaseEntity
C++ beamspotlight.cpp

It is used to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. It will also create a dynamic light wherever the end of the spotlight rests. Other than its ability to rotate, this entity is functionally identical to point_spotlight.

Note.pngNote:This spotlight is entirely client side, and rotation may be desynchronized between clients.
Tip.pngTip:Can be set to rotate for a lighthouse search beam effect.

Flags

Start On : [1]
No Dynamic Light - Do not create any actual light. : [2]
Start with Rotation On : [4]
Reverse Direction : [8]
X Axis : [16]
Y Axis : [32]

([Clarify] are these axes relative to the world or to the entity?)

Keyvalues

Max Rotation Speed (maxspeed) <integer>
The maximum rotation speed of the spotlight, in degrees per second.
Spotlight Length (SpotlightLength) <integer>
Length of the spotlight beam.
Spotlight Width (SpotlightWidth) <integer>
Width of the spotlight beam.
HDR color scale (HDRColorScale) <float>
Multiplier for sprite color by when running in HDR mode.
Halo Sprite (HaloSprite) <sprite> (only in Left 4 Dead)
The material that should be used for the halo.
Beam Sprite (BeamSprite) <sprite> (only in Left 4 Dead)
The material that should be used for the beam.

RenderFields:

Render Mode (rendermode) <byte choices>
Set a non-standard rendering mode on this entity.
Render Modes
  • 0: Normal
  • 1: Color
  • 2: Texture
  • 3: Glow
  • 4: Solid/Alphatest Obsolete
  • 5: Additive
  • 6: Removed, does nothing Obsolete
  • 7: Additive Fractional Frame
  • 8: Alpha Add
  • 9: World Space Glow
  • 10: Don't Render
Render FX (renderfx) <byte choices>
Various somewhat legacy alpha effects. See render effects.
Render Amount / Transparency (renderamt) <byte>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.

Inputs

LightOn
Turn the spotlight on.
LightOff
Turn the spotlight off
Start
Start rotating.
Stop
Stop rotating.
Reverse
Reverse the direction of rotation.

RenderFields:

Alpha <integer 0–255>
Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its rendermode set to a number other than 0.
Color <color255RedirectInput/color32>
Sets an RGB color for the entity.

Outputs

OnLightOn
Fires when light turns on.
OnLightOff
Fires when light turns off.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Beam_spotlight&oldid=489833"