Gah - a solution with more questions. – EntropicLqd

UE3:FoliageComponent (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Component >> ActorComponent >> PrimitiveComponent >> FoliageComponent
Package: 
Engine
This class in other games:
UT3


Properties[edit]

DirectionalStaticLightingScale[edit]

Type: float

Array size: 3

Modifiers: const

The scale factors applied to the directional static lighting.

InstanceStaticMesh[edit]

Type: StaticMesh

Modifiers: const

The mesh which is drawn for each foliage instance.

LightmassSettings[edit]

Type: EngineTypes.LightmassPrimitiveSettings

The Lightmass settings for this object.

Default value:

Member Value
DiffuseBoost 1.0
EmissiveBoost 1.0
EmissiveLightFalloffExponent 2.0
FullyOccludedSamplesFraction 1.0
SpecularBoost 1.0

LitInstances[edit]

Type: array<StoredFoliageInstance>

Modifiers: const

The component's foliage instances.

Material[edit]

Type: MaterialInterface

Modifiers: const

The material applied to the foliage instance mesh.

MaxDrawRadius[edit]

Type: float

The maximum distance to draw foliage instances at.

MaxScale[edit]

Type: Object.Vector

The minimum scale to draw foliage instances at.

MinScale[edit]

Type: Object.Vector

The minimum scale to draw foliage instances at.

MinThinningRadius[edit]

Type: float

The minimum distance to start thinning foliage instances at.

MinTransitionRadius[edit]

Type: float

The minimum distance to start scaling foliage instances away at.

SimpleStaticLightingScale[edit]

Type: float

Array size: 3

Modifiers: const

The scale factors applied to the simple static lighting.

StaticallyIrrelevantLights[edit]

Type: array<Object.Guid>

Modifiers: const

The statically irrelevant lights for all the component's foliage instances.

StaticallyRelevantLights[edit]

Type: array<Object.Guid>

Modifiers: const

The lights included in the foliage's static lighting.

SwayScale[edit]

Type: float

A scale for the effect of wind on the foliage mesh.

Default values[edit]

Property Value
bAcceptsLights True
bForceDirectLightMap True
bUsePrecomputedShadows True

Structs[edit]

FoliageInstanceBase[edit]

Modifiers: native

Information about an instance of the component's foliage mesh that is common to all foliage instance types.

Object.Vector Location 
The instance's world-space location.
Object.Vector XAxis 
The instance's X Axis.
Object.Vector YAxis 
The instance's Y Axis.
Object.Vector ZAxis 
The instance's Z Axis.
float DistanceFactorSquared 
The instance's distance factor, squared.

StoredFoliageInstance[edit]

Extends: FoliageInstanceBase

Modifiers: native

The information for each instance that is gathered during lighting and saved.

Object.Color StaticLighting[3]  
The static lighting received by the instance. The number of coefficients corresponds to NUM_STORED_LIGHTMAP_COEF in native.