fxFoliageReplicator
An emitter to replicate fxFoliageItem objects across an area.
Debugging
bool
Culling bins are drawn when set to true.
float
Height multiplier for drawn culling bins.
bool
Foliage is hidden when set to true.
bool
Draw placement rings when set to true.
int
Height of the placement ring in world units.
LinearColorF
Color of the placement ring.
Media
int
Random seed for foliage placement.
filename
Image file for the foliage texture.
int
Maximum foliage instance count.
int
Number of times to try placing a foliage instance before giving up.
Area
int
Placement area inner radius on the X axis.
int
Placement area inner radius on the Y axis.
int
Placement area outer radius on the X axis.
int
Placement area outer radius on the Y axis.
Dimensions
float
Minimum width of foliage billboards.
float
Maximum width of foliage billboards.
float
Minimum height of foliage billboards.
float
Maximum height of foliage billboards.
bool
Maintain aspect ratio of image if true. This option ignores MaxWidth.
bool
Use only MaxWidth and MaxHeight for billboard size. Ignores MinWidth and MinHeight.
float
Offset billboards by this amount vertically.
bool
Randomly flip billboards left-to-right.
bool
Use camera facing billboards ( including the z axis ).
Culling
bool
Use culling bins when enabled.
int
Minimum size of culling bins. Must be >= 8 and <= OuterRadius.
float
Maximum distance from camera where foliage appears.
float
Minimum distance from camera where foliage appears.
float
Region beyond ViewDistance where foliage fades in/out.
float
Region before ViewClosest where foliage fades in/out.
float
Minimum alpha value allowed on foliage instances.
float
Alpha of the foliage at ground level. 0 = transparent, 1 = opaque.
Animation
bool
Foliage should sway randomly when true.
bool
Foliage instances should sway together when true and SwayOn is enabled.
float
Left-to-right sway magnitude.
float
Front-to-back sway magnitude.
float
Minumum sway cycle time in seconds.
float
Maximum sway cycle time in seconds.
Lighting
bool
Foliage should be illuminated with changing lights when true.
bool
Foliage instances have the same lighting when set and LightOn is set.
float
Minimum luminance for foliage instances.
float
Maximum luminance for foliage instances.
float
Time before foliage illumination cycle repeats.
Restrictions
bool
Foliage will be placed on terrain when set.
bool
Foliage will be placed on Static shapes when set.
bool
Foliage will be placed on/under water when set.
bool
Foliage will be placed on water when set. Requires AllowOnWater.
int
Maximum surface angle allowed for foliage instances.
AFX
float
Multiplier controling amount foliage is modulated by sun's ambient.
Public Static Attributes
bool
Disables rendering of all instances of this type.
bool
Disables selection of all instances of this type.
Detailed Description
An emitter to replicate fxFoliageItem objects across an area.
Debugging
bool UseDebugInfo
Culling bins are drawn when set to true.
float DebugBoxHeight
Height multiplier for drawn culling bins.
bool HideFoliage
Foliage is hidden when set to true.
bool ShowPlacementArea
Draw placement rings when set to true.
int PlacementAreaHeight
Height of the placement ring in world units.
LinearColorF PlacementColour
Color of the placement ring.
Media
int seed
Random seed for foliage placement.
filename FoliageFile
Image file for the foliage texture.
int FoliageCount
Maximum foliage instance count.
int FoliageRetries
Number of times to try placing a foliage instance before giving up.
Area
int InnerRadiusX
Placement area inner radius on the X axis.
int InnerRadiusY
Placement area inner radius on the Y axis.
int OuterRadiusX
Placement area outer radius on the X axis.
int OuterRadiusY
Placement area outer radius on the Y axis.
Dimensions
float MinWidth
Minimum width of foliage billboards.
float MaxWidth
Maximum width of foliage billboards.
float MinHeight
Minimum height of foliage billboards.
float MaxHeight
Maximum height of foliage billboards.
bool FixAspectRatio
Maintain aspect ratio of image if true. This option ignores MaxWidth.
bool FixSizeToMax
Use only MaxWidth and MaxHeight for billboard size. Ignores MinWidth and MinHeight.
float OffsetZ
Offset billboards by this amount vertically.
bool RandomFlip
Randomly flip billboards left-to-right.
bool useTrueBillboards
Use camera facing billboards ( including the z axis ).
Culling
bool UseCulling
Use culling bins when enabled.
int CullResolution
Minimum size of culling bins. Must be >= 8 and <= OuterRadius.
float ViewDistance
Maximum distance from camera where foliage appears.
float ViewClosest
Minimum distance from camera where foliage appears.
float FadeInRegion
Region beyond ViewDistance where foliage fades in/out.
float FadeOutRegion
Region before ViewClosest where foliage fades in/out.
float AlphaCutoff
Minimum alpha value allowed on foliage instances.
float GroundAlpha
Alpha of the foliage at ground level. 0 = transparent, 1 = opaque.
Animation
bool SwayOn
Foliage should sway randomly when true.
bool SwaySync
Foliage instances should sway together when true and SwayOn is enabled.
float SwayMagSide
Left-to-right sway magnitude.
float SwayMagFront
Front-to-back sway magnitude.
float MinSwayTime
Minumum sway cycle time in seconds.
float MaxSwayTime
Maximum sway cycle time in seconds.
Lighting
bool LightOn
Foliage should be illuminated with changing lights when true.
bool LightSync
Foliage instances have the same lighting when set and LightOn is set.
float MinLuminance
Minimum luminance for foliage instances.
float MaxLuminance
Maximum luminance for foliage instances.
float lightTime
Time before foliage illumination cycle repeats.
Restrictions
bool AllowOnTerrain
Foliage will be placed on terrain when set.
bool AllowOnStatics
Foliage will be placed on Static shapes when set.
bool AllowOnWater
Foliage will be placed on/under water when set.
bool AllowWaterSurface
Foliage will be placed on water when set. Requires AllowOnWater.
int AllowedTerrainSlope
Maximum surface angle allowed for foliage instances.