Engine.LightComponent

Extends

ActorComponent

Modifiers

native noexport abstract collapsecategories

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.ActorComponent
      |   
      +-- Engine.LightComponent

Direct Known Subclasses:

DirectionalLightComponent, PointLightComponent, SkyLightComponent

Functions Summary
	vector	GetDirection ()
	vector	GetOrigin ()
		OnUpdatePropertyBrightness ()))
		OnUpdatePropertyLightColor ()))
		SetEnabled (bool bSetEnabled)
		SetLightProperties (optional float NewBrightness = Brightness, optional color NewLightColor = LightColor, optional LightFunction NewLightFunction = Function)
		UpdateColorAndBrightness ()

bHasLightEverBeenBuiltIntoLightMap Source code

Whether light has ever been built into a lightmap

ExclusionConvexVolumes Source code

Array of convex exclusion volumes, populated from ExclusionVolumes by PostEditChange.

InclusionConvexVolumes Source code

Array of convex inclusion volumes, populated from InclusionVolumes by PostEditChange.

LightGuid Source code

GUID used to associate a light component with precomputed shadowing information across levels. The GUID changes whenever the light position changes.

LightListIndex Source code

The munged index of this light in the light list > 0 == static light list 0 == not part of any light list < 0 == dynamic light list

LightmapGuid Source code

GUID used to associate a light component with precomputed shadowing information across levels. The GUID changes whenever any of the lighting relevant properties changes.

LightToWorld Source code

RequireDynamicShadows Source code

deprecated: This variable has been replaced with bForceDynamicLight.

SceneInfo Source code

WorldToLight Source code

LightComponent

bCanAffectDynamicPrimitivesOutsideDynamicChannel Source code

Whether the light can affect dynamic primitives even though the light is not affecting the dynamic channel.

bCastCompositeShadow Source code

True if the light should cast shadow from primitives which use a composite light environment.

bEnabled Source code

Is this light enabled?

bForceDynamicLight Source code

True if this light should use dynamic shadows for all primitives. forces the use of shadow volumes/ stencil shadows which avoid potential issues with cubemaps and also avoids any memory used for static shadowing

bOnlyAffectSameAndSpecifiedLevels Source code

Whether to only affect primitives that are in the same level/ share the same GetOutermost() or are in the set of additionally specified ones.

Brightness Source code

bUseVolumes Source code

Whether to use the inclusion/ exclusion volumes.

CastDynamicShadows Source code

True if the light can be blocked by dynamic shadow casting primitives. controls whether the light should cast shadows from objects that cannot receive static shadowing

CastShadows Source code

True if the light can be blocked by shadow casting primitives. controls whether the light should cast shadows

CastStaticShadows Source code

True if the light can be blocked by static shadow casting primitives. controls whether the light should cast shadows from objects that can receive static shadowing

ExclusionVolumes Source code

Array of volumes used by AffectsBounds if bUseVolumes is set. Light will only affect primitives if they neither touching nor are contained by at least one volume. Exclusion overrides inclusion.

Function Source code

InclusionVolumes Source code

Array of volumes used by AffectsBounds if bUseVolumes is set. Light will only affect primitives if they are touching or are contained by at least one volume. Exclusion overrides inclusion.

LightAffectsClassification Source code

This is the classification of this light. This is used for placing a light for an explicit purpose. Basically you can now have "type" information with lights and understand the intent of why a light was placed. This is very useful for content people getting maps from others and understanding why there is a dynamic affect light in the middle of the world with a radius of 32k! And also useful for being able to do searches such as the following: show me all lights which effect dynamic objects. Now show me the set of lights which are not explicitly set as Dynamic Affecting lights.

LightColor Source code

LightEnvironment Source code

The light environment which the light affects. NULL represents an implicit default light environment including all primitives and lights with LightEnvironment=NULL.

LightingChannels Source code

Lighting channels controlling light/ primitive interaction. Only allows interaction if at least one channel is shared

LightShadowMode Source code

Type of shadowing to apply for the light

MaxShadowResolution Source code

override for max square dimensions (in texels) allowed for rendering shadow subject depths 0 defaults to Engine.MaxShadowResolution

MinShadowResolution Source code

override for min dimensions (in texels) allowed for rendering shadow subject depths. 0 defaults to Engine.MinShadowResolution

ModShadowColor Source code

Shadow color for modulating entire scene

ModShadowFadeoutExponent Source code

Exponent that controls mod shadow fadeout curve.

ModShadowFadeoutTime Source code

Time since the caster was last visible at which the mod shadow will fade out completely.

OtherLevelsToAffect Source code

Array of other levels to affect if bOnlyAffectSameAndSpecifiedLevels is TRUE, own level always implicitly part of array.

ShadowFilterQuality Source code

Quality of shadow buffer filtering to use on this light

ShadowProjectionTechnique Source code

Type of shadow projection to use for this light

UseDirectLightMap Source code

Set to True to store the direct flux of this light in a light-map.

ELightAffectsClassification Source code

ELightShadowMode Source code

EShadowFilterQuality Source code

EShadowProjectionTechnique Source code

LightingChannelContainer Source code

bInitialized:

Whether the lighting channel has been initialized. Used to determine whether UPrimitveComponent::Attach should set defaults.

GetDirection Source code

Script interface to retrieve light direction.

GetOrigin Source code

Script interface to retrieve light location.

OnUpdatePropertyBrightness Source code

Called from matinee code when Brightness property changes.

OnUpdatePropertyLightColor Source code

Called from matinee code when LightColor property changes.

SetEnabled Source code

Toggles the light on or off
@param bSetEnabled TRUE to enable the light or FALSE to disable it

SetLightProperties Source code

sets Brightness, LightColor, and/or LightFunction

UpdateColorAndBrightness Source code

Script interface to update the color and brightness on the render thread.

defaultproperties
{
   Brightness=1.000000
   LightColor=(B=255,G=255,R=255,A=0)
   bEnabled=True
   CastShadows=True
   CastStaticShadows=True
   CastDynamicShadows=True
   LightingChannels=(bInitialized=True,BSP=True,Static=True,Dynamic=True,CompositeDynamic=True)
   ModShadowColor=(R=0.000000,G=0.000000,B=0.000000,A=1.000000)
   ModShadowFadeoutExponent=3.000000
   Name="Default__LightComponent"
   ObjectArchetype=ActorComponent'Engine.Default__ActorComponent'
}