beam_spotlight
beam_spotlight
is a point entity available in all Source games since Left 4 Dead.
class hierarchy |
---|
CBeamSpotlight defined in 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:This spotlight is entirely client side, and rotation may be desynchronized between clients.
Note:This entity is also available in Garry's Mod .
Tip:Can be set to rotate for a lighthouse search beam effect.
Contents
Flags
- [
1
] : Start On
- [
2
] : No Dynamic Light - Do not create any actual light.
- [
4
] : Start with Rotation On
- [
8
] : Reverse Direction
- [
16
] : X Axis
- [
32
] : Y Axis
([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 ) - The material that should be used for the halo.
- Beam Sprite
(BeamSprite)
<sprite> (only in ) - The material that should be used for the beam.
RenderFields:
- Render Mode
(rendermode)
<choices> - Set a non-standard rendering mode on this entity.
- Render FX
(renderfx)
<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render FX / Transparency (0 - 255)
(renderamt)
<integer> - 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.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean> - Prevent the entity from receiving shadows on itself.
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 than0
.
Color
<color255>- Sets an RGB color for the entity.
Outputs
OnLightOn
- Fires when light turns on.
OnLightOff
- Fires when light turns off.