Skip to main content

light_spot

Point Entity

A spot light source.

Keyvalues

  • Linear Attenuation (attenuation1) <Float>

  • Quadratic Attenuation (attenuation2) <Float>

  • Light Source Radius (lightsourceradius) <Float>
    The radius of the light source in game units

  • Indirect Light Multiplier (bouncescale) <Float>

  • Render Diffuse (renderdiffuse) <Boolean>

  • Render Specular (renderspecular) <Choices>

    • Off
    • On
    • Bake into cubemaps

  • Render Transmissive (rendertransmissive) <Choices>

    • Off
    • On

  • Indirect Lighting (indirectlight) <Choices>
    How indirect lighting should be represented

    • None
    • Baked

  • Enabled (enabled) <Boolean>

  • Color (color) <Color255>

  • Brightness (brightness) <Float>

  • Range (range) <Float>
    Distance range for light. 0=infinite

  • Cast Shadows (castshadows) <Choices>
    Whether this light casts shadow

    • No
    • Yes
    • Baked Only

  • Shadow Near Clip Plane (nearclipplane) <Float>
    Distance for near clip plane for shadow map

  • Appearance (style) <Choices>

    • Normal
    • Fluorescent flicker
    • Slow, strong pulse
    • Slow pulse, noblack
    • Gentle pulse
    • Flicker A
    • Flicker B
    • Candle A
    • Candle B
    • Candle C
    • Fast strobe
    • Slow strobe

  • Custom Appearance (pattern) <String>
    Set a custom pattern of light brightness for this light. Pattern format is a string of characters, where 'a' is total darkness, 'z' fully bright. i.e. 'aaggnnttzz' would be a steppy fade in from dark to light.

  • Start Fade Dist (fademindist) <Float>
    Distance at which the light starts to fade (<0 = use fademaxdist).

  • End Fade Dist (fademaxdist) <Float>
    Maximum distance at which the light is visible (0 = don't fade out).

  • Render to Cubemaps (rendertocubemaps) <Boolean>
    If true, this geometry renders into baked cube maps

  • Priority (priority) <Integer>
    When the number of visible lights exceeds the rendering budget, higher priority lights are chosen for rendering first.

  • Light Group (lightgroup) <String>
    Semicolon-delimited list of light groups to affect

  • Light Cookie (lightcookie) <String>
    light cookie name in effects/lightcookies.vtex

  • Falloff (falloff) <Float>
    angular falloff exponent for spot lights

  • Inner Cone Angle (innerconeangle) <Float>
    inner cone angle. no angular falloff within this cone

  • Outer Cone Angle (outerconeangle) <Float>
    outer cone angle

  • Shadow Start Fade Dist (shadowfademindist) <Float>
    Distance at which the shadow starts to fade (<0 = use fademaxdist).

  • Shadow End Fade Dist (shadowfademaxdist) <Float>
    Maximum distance at which the shadow is visible (0 = don't fade out).

  • Shadow Texture Width (shadowtexturewidth) <Integer>
    0 = use default texture resolution

  • Shadow Texture Height (shadowtextureheight) <Integer>
    0 = use default texture resolution

  • Direct Lighting (directlight) <Choices>
    How direct lighting should be represented

    • None
    • Baked
    • Per-Pixel
    • None
    • Baked
    • Per-Pixel

  • Transmit Shadow Casters to Client (pvs_modify_entity) <Boolean>
    When this light is visible to a player, add its shadow casters to the player's PVS.

  • Fog contribution strength (fogcontributionstrength) <Float>
    Overrides how much the light affects the fog (if enabled)

  • Volumetric Fogging (fog_lighting) <Choices>
    How should light interact with volumetric fogging

    • None
    • Baked
    • Dynamic
    • Baked - no shadows
    • Dynamic - no shadows

  • Baked Light Indexing (baked_light_indexing) <Boolean>
    Allows direct light to be indexed if baked. Indexed lights have per-pixel quality specular lighting and normal map response

Inputs

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

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

  • SetLightEnabled <Void>
    Sets whether the light is enabled (takes parameter of 0 or 1)

  • TurnOn <Void>
    Turn the light on.

  • TurnOff <Void>
    Turn the light off.

  • Toggle <Void>
    Toggle the light on/off.

  • SetLightColor <Vector>
    Set light color

  • SetLightBrightness <Float>
    Set light brightness

  • SetAppearance <Integer>
    Set appearance 0=Normal 1=Flicker A, 2=Slow, strong pulse 3=Candle A ...

  • SetCustomAppearance <String>
    Set a custom pattern of light brightness for this light. Pattern format is a string of characters, where 'a' is total darkness, 'z' fully bright. i.e. 'aaggnnttzz' would be a steppy fade in from dark to light.

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.