unreal.FoliageType

class unreal.FoliageType(outer=None, name='None')

Bases: unreal.Object

Foliage Type

C++ Source:

  • Module: Foliage
  • File: FoliageType.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affect_distance_field_lighting (bool): [Read-Write] Controls whether the primitive should affect dynamic distance field lighting methods. This flag is only used if CastShadow is true.
  • affect_dynamic_indirect_lighting (bool): [Read-Write] Controls whether the foliage should inject light into the Light Propagation Volume. This flag is only used if CastShadow is true.
  • align_max_angle (float): [Read-Write] The maximum angle in degrees that foliage instances will be adjusted away from the vertical
  • align_to_normal (bool): [Read-Write] Whether foliage instances should have their angle adjusted away from vertical to match the normal of the surface they’re painted on If AlignToNormal is enabled and RandomYaw is disabled, the instance will be rotated so that the +X axis points down-slope
  • average_spread_distance (float): [Read-Write] The average distance between the spreading instance and its seeds. For example, a tree with an AverageSpreadDistance 10 will ensure the average distance between the tree and its seeds is 10cm
  • body_instance (BodyInstance): [Read-Write] Custom collision for foliage
  • can_grow_in_shade (bool): [Read-Write] If true, seeds of this type will ignore shade radius during overlap tests with other types.
  • cast_dynamic_shadow (bool): [Read-Write] Controls whether the foliage should cast shadows in the case of non precomputed shadowing. This flag is only used if CastShadow is true.
  • cast_shadow (bool): [Read-Write] Controls whether the foliage should cast a shadow or not.
  • cast_shadow_as_two_sided (bool): [Read-Write] Whether this foliage should cast dynamic shadows as if it were a two sided material.
  • cast_static_shadow (bool): [Read-Write] Whether the foliage should cast a static shadow from shadow casting lights. This flag is only used if CastShadow is true.
  • collision_radius (float): [Read-Write] The CollisionRadius determines when two instances overlap. When two instances overlap a winner will be picked based on rules and priority.
  • collision_scale (Vector): [Read-Write] The foliage instance’s collision bounding box will be scaled by the specified amount before performing the overlap check
  • collision_with_world (bool): [Read-Write] If checked, an overlap test with existing world geometry is performed before each instance is placed
  • cull_distance (Int32Interval): [Read-Write] The distance where instances will begin to fade out if using a PerInstanceFadeAmount material node. 0 disables. When the entire cluster is beyond this distance, the cluster is completely culled and not rendered at all.
  • custom_depth_stencil_value (int32): [Read-Write] Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)
  • custom_navigable_geometry (HasCustomNavigableGeometry): [Read-Write] Force navmesh
  • density (float): [Read-Write] Foliage instances will be placed at this density, specified in instances per 1000x1000 unit area
  • density_adjustment_factor (float): [Read-Write] The factor by which to adjust the density of instances. Values >1 will increase density while values <1 will decrease it.
  • distribution_seed (int32): [Read-Write] The seed that determines placement of initial seeds.
  • enable_density_scaling (bool): [Read-Write] Whether this foliage type should be affected by the Engine Scalability system’s Foliage scalability setting. Enable for detail meshes that don’t really affect the game. Disable for anything important. Typically, this will be enabled for small meshes without collision (e.g. grass) and disabled for large meshes with collision (e.g. trees)
  • ground_slope_angle (FloatInterval): [Read-Write] Foliage instances will only be placed on surfaces sloping in the specified angle range from the horizontal
  • height (FloatInterval): [Read-Write] The valid altitude range where foliage instances will be placed, specified using minimum and maximum world coordinate Z values
  • initial_seed_density (float): [Read-Write] Specifies the number of seeds to populate along 10 meters. The number is implicitly squared to cover a 10m x 10m area
  • landscape_layers (Array(Name)): [Read-Write] If a layer name is specified, painting on landscape will limit the foliage to areas of landscape with the specified layer painted
  • lighting_channels (LightingChannels): [Read-Write] Lighting channels that placed foliage will be assigned. Lights with matching channels will affect the foliage. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.
  • lightmap_type (LightmapType): [Read-Write] Controls the type of lightmap used for this component.
  • max_age (float): [Read-Write] Specifies the oldest a seed can be. After reaching this age the instance will still spread seeds, but will not get any older
  • max_initial_age (float): [Read-Write] Allows a new seed to be older than 0 when created. New seeds will be randomly assigned an age in the range [0,MaxInitialAge]
  • max_initial_seed_offset (float): [Read-Write] The seed that determines placement of initial seeds.
  • minimum_layer_weight (float): [Read-Write] Specifies the minimum value above which the landscape layer weight value must be, in order for foliage instances to be placed in a specific area
  • mobility (ComponentMobility): [Read-Write] Mobility property to apply to foliage components
  • num_steps (int32): [Read-Write] The number of times we age the species and spread its seeds.
  • overlap_priority (float): [Read-Write] When two instances overlap we must determine which instance to remove. The instance with a lower OverlapPriority will be removed. In the case where OverlapPriority is the same regular simulation rules apply.
  • overridden_light_map_res (int32): [Read-Write] Overrides the lightmap resolution defined in the static mesh
  • override_light_map_res (bool): [Read-Write] Whether to override the lightmap resolution defined in the static mesh.
  • procedural_scale (FloatInterval): [Read-Write] The scale range of this type when being procedurally generated. Configured with the Scale Curve.
  • radius (float): [Read-Write] The minimum distance between foliage instances
  • random_pitch_angle (float): [Read-Write] A random pitch adjustment can be applied to each instance, up to the specified angle in degrees, from the original vertical
  • random_yaw (bool): [Read-Write] If selected, foliage instances will have a random yaw rotation around their vertical axis applied
  • reapply_align_to_normal (bool): [Read-Write] If checked, foliage instances will have their normal alignment adjusted by the Reapply tool
  • reapply_collision_with_world (bool): [Read-Write] If checked, foliage instances will have an overlap test with the world reapplied, and overlapping instances will be removed by the Reapply tool
  • reapply_density (bool): [Read-Write] If checked, the density of foliage instances already placed will be adjusted by the density adjustment factor.
  • reapply_ground_slope (bool): [Read-Write] If checked, foliage instances not meeting the ground slope condition will be removed by the Reapply too
  • reapply_height (bool): [Read-Write] If checked, foliage instances not meeting the valid Z height condition will be removed by the Reapply tool
  • reapply_landscape_layers (bool): [Read-Write] If checked, foliage instances painted on areas that do not have the appropriate landscape layer painted will be removed by the Reapply tool
  • reapply_radius (bool): [Read-Write] If checked, foliage instances not meeting the new Radius constraint will be removed
  • reapply_random_pitch_angle (bool): [Read-Write] If checked, foliage instances will have their pitch adjusted by the Reapply tool
  • reapply_random_yaw (bool): [Read-Write] If checked, foliage instances will have their yaw adjusted by the Reapply tool
  • reapply_scale_x (bool): [Read-Write] If checked, foliage instances will have their X scale adjusted by the Reapply tool
  • reapply_scale_y (bool): [Read-Write] If checked, foliage instances will have their Y scale adjusted by the Reapply tool
  • reapply_scale_z (bool): [Read-Write] If checked, foliage instances will have their Z scale adjusted by the Reapply tool
  • reapply_scaling (bool): [Read-Write] If checked, foliage instances will have their scale adjusted to fit the specified scaling behavior by the Reapply tool
  • reapply_vertex_color_mask (bool): [Read-Write] If checked, foliage instances no longer matching the vertex color constraint will be removed by the Reapply too
  • reapply_z_offset (bool): [Read-Write] If checked, foliage instances will have their Z offset adjusted by the Reapply tool
  • receives_decals (bool): [Read-Write] Whether the foliage receives decals.
  • render_custom_depth (bool): [Read-Write] If true, the foliage will be rendered in the CustomDepth pass (usually used for outlines)
  • scale_curve (RuntimeFloatCurve): [Read-Write] Instance scale factor as a function of normalized age (i.e. Current Age / Max Age). X = 0 corresponds to Age = 0, X = 1 corresponds to Age = Max Age. Y = 0 corresponds to Min Scale, Y = 1 corresponds to Max Scale.
  • scale_x (FloatInterval): [Read-Write] Specifies the range of scale, from minimum to maximum, to apply to a foliage instance’s X Scale property
  • scale_y (FloatInterval): [Read-Write] Specifies the range of scale, from minimum to maximum, to apply to a foliage instance’s Y Scale property
  • scale_z (FloatInterval): [Read-Write] Specifies the range of scale, from minimum to maximum, to apply to a foliage instance’s Z Scale property
  • scaling (FoliageScaling): [Read-Write] Specifies foliage instance scaling behavior when painting.
  • seeds_per_step (int32): [Read-Write] The number of seeds an instance will spread in a single step of the simulation.
  • shade_radius (float): [Read-Write] The ShadeRadius determines when two instances overlap. If an instance can grow in the shade this radius is ignored.
  • spawns_in_shade (bool): [Read-Write] Whether new seeds are spawned exclusively in shade. Occurs in a second pass after all types that do not spawn in shade have been simulated. Only valid when CanGrowInShade is true.
  • spread_variance (float): [Read-Write] Specifies how much seed distance varies from the average. For example, a tree with an AverageSpreadDistance 10 and a SpreadVariance 1 will produce seeds with an average distance of 10cm plus or minus 1cm
  • use_as_occluder (bool): [Read-Write] If enabled, foliage will render a pre-pass which allows it to occlude other primitives, and also allows it to correctly receive DBuffer decals. Enabling this setting may have a negative performance impact.
  • vertex_color_mask_by_channel (FoliageVertexColorChannelMask): [Read-Write] Vertex Color Mask by Channel
  • z_offset (FloatInterval): [Read-Write] Specifies a range from minimum to maximum of the offset to apply to a foliage instance’s Z location
affect_distance_field_lighting

(bool) – [Read-Only] Controls whether the primitive should affect dynamic distance field lighting methods. This flag is only used if CastShadow is true.

affect_dynamic_indirect_lighting

(bool) – [Read-Only] Controls whether the foliage should inject light into the Light Propagation Volume. This flag is only used if CastShadow is true.

cast_dynamic_shadow

(bool) – [Read-Only] Controls whether the foliage should cast shadows in the case of non precomputed shadowing. This flag is only used if CastShadow is true.

cast_shadow

(bool) – [Read-Only] Controls whether the foliage should cast a shadow or not.

cast_shadow_as_two_sided

(bool) – [Read-Only] Whether this foliage should cast dynamic shadows as if it were a two sided material.

cast_static_shadow

(bool) – [Read-Only] Whether the foliage should cast a static shadow from shadow casting lights. This flag is only used if CastShadow is true.

custom_depth_stencil_value

(int32) – [Read-Only] Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)

lighting_channels

(LightingChannels) – [Read-Only] Lighting channels that placed foliage will be assigned. Lights with matching channels will affect the foliage. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.

lightmap_type

(LightmapType) – [Read-Only] Controls the type of lightmap used for this component.

mobility

(ComponentMobility) – [Read-Only] Mobility property to apply to foliage components

overridden_light_map_res

(int32) – [Read-Only] Overrides the lightmap resolution defined in the static mesh

override_light_map_res

(bool) – [Read-Only] Whether to override the lightmap resolution defined in the static mesh.

receives_decals

(bool) – [Read-Only] Whether the foliage receives decals.

render_custom_depth

(bool) – [Read-Only] If true, the foliage will be rendered in the CustomDepth pass (usually used for outlines)

use_as_occluder

(bool) – [Read-Only] If enabled, foliage will render a pre-pass which allows it to occlude other primitives, and also allows it to correctly receive DBuffer decals. Enabling this setting may have a negative performance impact.