The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:LightEnvironmentComponent (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:24, 17 January 2010 by (Talk)

Jump to: navigation, search
UDK Object >> Component >> ActorComponent >> LightEnvironmentComponent
Package: 
Engine
Direct subclass:
DynamicLightEnvironmentComponent
This class in other games:
UT3

This is used by the scene management to isolate lights and primitives. For lighting and actor or component use a DynamicLightEnvironmentComponent.

Properties

Property group 'LightEnvironmentComponent'

bEnabled

Type: bool

Modifiers: protected, const

Whether the light environment is used or treated the same as a LightEnvironment=NULL reference.

Default value: True

bForceNonCompositeDynamicLights

Type: bool

Whether the light environment should override GSystemSettings.bUseCompositeDynamicLights, and never composite dynamic lights into the light environment.

Internal variables

AffectedComponents

Type: array<PrimitiveComponent>

Modifiers: transient, protected

Array of primitive components which are using this light environment and currently attached.

bAllowAnyDominantLightInfluence

Type: bool

Modifiers: const

Whether to allow any dominant light interactions with any of the primitives this light environment is active on (AffectedComponents).

bAllowDominantDirectionalLightInfluence

Type: bool

Modifiers: const

Whether to allow dominant directional light interactions with any of the primitives this light environment is active on (AffectedComponents).

Native functions

IsEnabled

native final function bool IsEnabled () const

Returns whether the light environment is enabled

SetEnabled

native final function SetEnabled (bool bNewEnabled)

Changes the value of bEnabled.

Parameters:

  • bNewEnabled - The value to assign to bEnabled.