s&box docs
API ReferenceSandbox

SceneDirectionalLightclass

A directional scene light that is used to mimic sun light in a `Sandbox.SceneWorld`. Direction is controlled by this object's `Rotation`.

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

Constructors1

Showing 1 constructors

Methods1

Showing 1 methods

public void SetCascadeDistanceScale(float distance)PUBLIC

Set the max distance of the shadow cascade

ParameterTypeDescription
distancefloat—
Returns:void—

Properties4

Showing 4 properties

public bool Sandbox.SceneDirectionalLight.IncludeStaticShadowCasters { get; set; }PUBLICGETSET

Include static shadow casters independently of the light's baked-light index.

Returns:bool—

public int Sandbox.SceneDirectionalLight.ShadowCascadeCount { get; set; }PUBLICGETSET

Control number of shadow cascades

Returns:int—

public float Sandbox.SceneDirectionalLight.ShadowCascadeSplitRatio { get; set; }PUBLICGETSET

Returns:float—

public Color Sandbox.SceneDirectionalLight.SkyColor { get; set; }PUBLICGETSETOBSOLETE

Ambient light color outside of all light probes.

Obsolete: Use AmbientLight Component or World.AmbientLightColor Instead.

Returns:Color—

SceneCustomObject.ctor()

Previous Page

IncludeStaticShadowCasters

Next Page

On this page

Constructorspublic SceneDirectionalLight(Sandbox.SceneWorld sceneWorld, Rotation rotation, Color color)Methodspublic System.Void SetCascadeDistanceScale(System.Single distance)Propertiespublic System.Boolean Sandbox.SceneDirectionalLight.IncludeStaticShadowCasters { get; set; }public System.Int32 Sandbox.SceneDirectionalLight.ShadowCascadeCount { get; set; }public System.Single Sandbox.SceneDirectionalLight.ShadowCascadeSplitRatio { get; set; }public Color Sandbox.SceneDirectionalLight.SkyColor { get; set; }Metadata