s&box docs
API ReferenceSandbox

Lightclass

object→Component→Light
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.Light : Sandbox.Component

Constructors1

Showing 1 constructors

protected Light()PROTECTEDCONSTRUCTOR

Methods5

Showing 5 methods

protected virtual void OnAwake()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnDisabled()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnEnabled()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnTagsChanged()PROTECTEDVIRTUAL

Tags have been updated - lets update our light's tags

Returns:void—

Properties7

Showing 7 properties

public Sandbox.Light.LightContribution Sandbox.Light.Contribution { get; set; }PUBLICGETSET

Which lighting terms this light is allowed to contribute to. For example, turn off `Sandbox.Light.LightContribution.Specular` to stop a light producing highlights.

Returns:LightContribution—

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

Returns:float—

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

The main color of the light

Returns:Color—

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

Returns:float—

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

Returns:float—

public bool Sandbox.Light.Shadows { get; set; }PUBLICGETSET

Should this light cast shadows?

Returns:bool—

Related Guides

→Light→Shading Model

LibraryAttribute.ctor()

Previous Page

Contribution

Next Page

On this page

Constructorsprotected Light()Methodsprotected virtual Sandbox.SceneLight CreateSceneObject()protected virtual System.Void OnAwake()protected virtual System.Void OnDisabled()protected virtual System.Void OnEnabled()protected virtual System.Void OnTagsChanged()Propertiespublic Sandbox.Light.LightContribution Sandbox.Light.Contribution { get; set; }public Sandbox.Light.FogInfluence Sandbox.Light.FogMode { get; set; }public System.Single Sandbox.Light.FogStrength { get; set; }public Color Sandbox.Light.LightColor { get; set; }public System.Single Sandbox.Light.ShadowBias { get; set; }public System.Single Sandbox.Light.ShadowHardness { get; set; }public System.Boolean Sandbox.Light.Shadows { get; set; }Metadata