Search Results for

    Show / Hide Table of Contents

    Class Light

    Base class for all light types.

    Inheritance
    System.Object
    Object
    SceneObject
    Actor
    Light
    LightWithShadow
    SkyLight
    Implements
    ISerializable
    Inherited Members
    Actor.HasTag()
    Actor.HasTag(String)
    Actor.SetParent(Actor, Boolean, Boolean)
    Actor.GetChild(Int32)
    Actor.GetChild(String)
    Actor.GetChild(Type)
    Actor.GetChildren(Type)
    Actor.GetScript(Int32)
    Actor.GetScript(Type)
    Actor.GetScripts(Type)
    Actor.AddMovement(Vector3)
    Actor.AddMovement(Vector3, Quaternion)
    Actor.GetWorldToLocalMatrix(Matrix)
    Actor.GetLocalToWorldMatrix(Matrix)
    Actor.FindActor(String)
    Actor.FindActor(Type)
    Actor.FindScript(Type)
    Actor.HasActorInHierarchy(Actor)
    Actor.HasActorInChildren(Actor)
    Actor.IntersectsItself(Ray, Single, Vector3)
    Actor.Intersects(Ray, Single, Vector3)
    Actor.LookAt(Vector3)
    Actor.LookAt(Vector3, Vector3)
    Actor.LookingAt(Vector3)
    Actor.LookingAt(Vector3, Vector3)
    Actor.ToBytes(Actor[])
    Actor.FromBytes(Byte[])
    Actor.FromBytes(Byte[], Dictionary<Guid, Guid>)
    Actor.TryGetSerializedObjectsIds(Byte[])
    Actor.ToJson()
    Actor.FromJson(String)
    Actor.OnBeginPlay()
    Actor.OnEndPlay()
    Actor.AddStaticFlags(StaticFlags)
    Actor.RemoveStaticFlags(StaticFlags)
    Actor.SetStaticFlag(StaticFlags, Boolean)
    Actor.HasStaticFlag(StaticFlags)
    Actor.ResetLocalTransform()
    Actor.AddChild(Type)
    Actor.AddChild<T>()
    Actor.GetChild<T>()
    Actor.TryGetChild<T>(T)
    Actor.GetOrAddChild<T>()
    Actor.AddScript(Type)
    Actor.AddScript<T>()
    Actor.GetScript<T>()
    Actor.TryGetScript<T>(T)
    Actor.FindScript<T>()
    Actor.FindActor<T>()
    Actor.GetChildren<T>()
    Actor.GetScripts<T>()
    Actor.DestroyChildren(Single)
    Actor.RotateAround(Vector3, Vector3, Single)
    Actor.ToString()
    Actor.Children
    Actor.Scripts
    Actor.HideFlags
    Actor.Layer
    Actor.LayerName
    Actor.Tag
    Actor.Name
    Actor.Scene
    Actor.ChildrenCount
    Actor.ScriptsCount
    Actor.IsActive
    Actor.IsActiveInHierarchy
    Actor.StaticFlags
    Actor.Transform
    Actor.Position
    Actor.Orientation
    Actor.Scale
    Actor.Rotation
    Actor.PerInstanceRandom
    Actor.Direction
    Actor.LocalTransform
    Actor.LocalPosition
    Actor.LocalOrientation
    Actor.LocalScale
    Actor.Sphere
    Actor.Box
    Actor.BoxWithChildren
    Actor.EditorBox
    Actor.EditorBoxChildren
    Actor.HasContentLoaded
    Actor.IsPrefabRoot
    Actor.PhysicsScene
    Actor.IsStatic
    Actor.IsTransformStatic
    Actor.EulerAngles
    Actor.LocalEulerAngles
    Actor.HasChildren
    Actor.WorldToLocalMatrix
    Actor.LocalToWorldMatrix
    SceneObject.SetParent(Actor, Boolean)
    SceneObject.LinkPrefab(Guid, Guid)
    SceneObject.BreakPrefabLink()
    SceneObject.GetNamePath(Char)
    SceneObject.HasParent
    SceneObject.Parent
    SceneObject.OrderInParent
    SceneObject.HasPrefabLink
    SceneObject.PrefabID
    SceneObject.PrefabObjectID
    Object.__unmanagedPtr
    Object.__internalId
    Object.As<T>()
    Object.NewValue(Type)
    Object.New(String)
    Object.New<T>()
    Object.New(Type)
    Object.Find<T>(Guid)
    Object.Find(Guid, Type)
    Object.TryFind<T>(Guid)
    Object.Destroy(Object, Single)
    Object.Destroy<T>(T, Single)
    Object.GetUnmanagedPtr(Object)
    Object.GetUnmanagedInterface(Object, Type)
    Object.GetHashCode()
    Object.ID
    Object.TypeName
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: FlaxEngine
    Assembly: FlaxEngine.CSharp.dll
    Syntax
    [Unmanaged]
    public abstract class Light : Actor, ISerializable

    Constructors

    Light()

    Initializes a new instance of the Light.

    Declaration
    protected Light()

    Properties

    Brightness

    Brightness of the light

    Declaration
    [EditorOrder(30)]
    [EditorDisplay("Light", null)]
    [Limit(0F, 1E+08F, 0.1F)]
    [Unmanaged]
    public float Brightness { get; set; }
    Property Value
    System.Single

    CastVolumetricShadow

    Toggles whether or not to cast a volumetric shadow for lights contributing to Volumetric Fog. Also shadows casting by this light should be enabled in order to make it cast volumetric fog shadow.

    Declaration
    [EditorOrder(120)]
    [EditorDisplay("Volumetric Fog", "Cast Shadow")]
    [Unmanaged]
    public bool CastVolumetricShadow { get; set; }
    Property Value
    System.Boolean

    Color

    Color of the light

    Declaration
    [EditorOrder(20)]
    [EditorDisplay("Light", null)]
    [Unmanaged]
    public Color Color { get; set; }
    Property Value
    Color

    IndirectLightingIntensity

    Controls how much this light will contribute indirect lighting. When set to 0, there is no GI from the light. The default value is 1.

    Declaration
    [EditorOrder(40)]
    [Limit(0F, 100F, 0.1F)]
    [EditorDisplay("Light", "Indirect Lighting Intensity")]
    [Unmanaged]
    public float IndirectLightingIntensity { get; set; }
    Property Value
    System.Single

    ViewDistance

    Controls light visibility range. The distance at which the light be completely faded. Use value 0 to always draw light.

    Declaration
    [EditorOrder(35)]
    [Limit(0F, 3.40282347E+38F, 10F)]
    [EditorDisplay("Light", null)]
    [Unmanaged]
    public float ViewDistance { get; set; }
    Property Value
    System.Single

    VolumetricScatteringIntensity

    Controls how much this light will contribute to the Volumetric Fog. When set to 0, there is no contribution.

    Declaration
    [EditorOrder(110)]
    [Limit(0F, 100F, 0.01F)]
    [EditorDisplay("Volumetric Fog", "Scattering Intensity")]
    [Unmanaged]
    public float VolumetricScatteringIntensity { get; set; }
    Property Value
    System.Single

    Extension Methods

    Extensions.ReflectiveCompare<T>(T, T)
    Extensions.RawClone<T>(T)
    In This Article
    Back to top Copyright © 2012-2021 Wojciech Figat