s&box docs
API ReferenceSandbox

SceneLightclass

Base class for light scene objects for use with a `Sandbox.SceneWorld`.

object→SceneObject→SceneLight
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.SceneLight : Sandbox.SceneObject

Constructors2

Showing 2 constructors

Properties17

Showing 17 properties

public float Sandbox.SceneLight.ConstantAttenuation { get; set; }PUBLICGETSET

The light attenuation constant term

Returns:float—

public float Sandbox.SceneLight.FogStrength { get; set; }PUBLICGETSET

Returns:float—

public Color Sandbox.SceneLight.LightColor { get; set; }PUBLICGETSET

Color and brightness of the light

Returns:Color—

public Sandbox.Texture Sandbox.SceneLight.LightCookie { get; set; }PUBLICGETSET

Access the LightCookie - which is a texture that gets drawn over the light

Returns:Texture—

public float Sandbox.SceneLight.LinearAttenuation { get; set; }PUBLICGETSET

The light attenuation linear term

Returns:float—

public float Sandbox.SceneLight.QuadraticAttenuation { get; set; }PUBLICGETSET

The light attenuation quadratic term

Returns:float—

public float Sandbox.SceneLight.Radius { get; set; }PUBLICGETSET

Radius of the light in units

Returns:float—

public bool Sandbox.SceneLight.RenderDiffuse { get; set; }PUBLICGETSET

Should this light contribute diffuse lighting?

Returns:bool—

public bool Sandbox.SceneLight.RenderSpecular { get; set; }PUBLICGETSET

Should this light contribute specular highlights?

Returns:bool—

public bool Sandbox.SceneLight.RenderTransmissive { get; set; }PUBLICGETSET

Should this light contribute transmissive lighting (light passing through surfaces)?

Returns:bool—

public float Sandbox.SceneLight.ShadowBias { get; set; }PUBLICGETSET

Returns:float—

public float Sandbox.SceneLight.ShadowHardness { get; set; }PUBLICGETSET

Returns:float—

public bool Sandbox.SceneLight.ShadowsEnabled { get; set; }PUBLICGETSET

Enable or disable shadow rendering

Returns:bool—

public int Sandbox.SceneLight.ShadowTextureResolution { get; set; }PUBLICGETSET

Get or set the resolution of the shadow map. If this is zero the engine will decide what it should use.

Returns:int—

Related Guides

→Map Entities

SceneLayerType

Previous Page

ConstantAttenuation

Next Page

On this page

Constructorspublic SceneLight(Sandbox.SceneWorld sceneWorld, Vector3 position, System.Single radius, Color color)public SceneLight(Sandbox.SceneWorld sceneWorld)Propertiespublic System.Single Sandbox.SceneLight.ConstantAttenuation { get; set; }public Sandbox.SceneLight.FogLightingMode Sandbox.SceneLight.FogLighting { get; set; }public System.Single Sandbox.SceneLight.FogStrength { get; set; }public Color Sandbox.SceneLight.LightColor { get; set; }public Sandbox.Texture Sandbox.SceneLight.LightCookie { get; set; }public System.Single Sandbox.SceneLight.LinearAttenuation { get; set; }public System.Single Sandbox.SceneLight.QuadraticAttenuation { get; set; }public System.Single Sandbox.SceneLight.Radius { get; set; }public System.Boolean Sandbox.SceneLight.RenderDiffuse { get; set; }public System.Boolean Sandbox.SceneLight.RenderSpecular { get; set; }public System.Boolean Sandbox.SceneLight.RenderTransmissive { get; set; }public System.Single Sandbox.SceneLight.ShadowBias { get; set; }public System.Single Sandbox.SceneLight.ShadowHardness { get; set; }public System.Boolean Sandbox.SceneLight.ShadowsEnabled { get; set; }public System.Int32 Sandbox.SceneLight.ShadowTextureResolution { get; set; }public Sandbox.SceneLight.LightShape Sandbox.SceneLight.Shape { get; set; }public Vector2 Sandbox.SceneLight.ShapeSize { get; set; }Metadata