I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:LightEnvironmentComponent (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:41, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 3))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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[edit]

Property group 'LightEnvironmentComponent'[edit]

bEnabled[edit]

Type: bool

Modifiers: protected, const

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

Default value: True

bForceNonCompositeDynamicLights[edit]

Type: bool

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

Internal variables[edit]

AffectedComponents[edit]

Type: array<PrimitiveComponent>

Modifiers: transient, protected

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

bAllowAnyDominantLightInfluence[edit]

Type: bool

Modifiers: const

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

bAllowDominantDirectionalLightInfluence[edit]

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[edit]

IsEnabled[edit]

native final function bool IsEnabled () const

Returns whether the light environment is enabled

SetEnabled[edit]

native final function SetEnabled (bool bNewEnabled)

Changes the value of bEnabled.

Parameters:

  • bNewEnabled - The value to assign to bEnabled.