unreal.LandscapeProxy

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

Bases: unreal.Actor

Landscape Proxy

C++ Source:

  • Module: Landscape
  • File: LandscapeProxy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affect_distance_field_lighting (bool): [Read-Write] Controls whether the landscape should affect dynamic distance field lighting methods. *
  • allow_tick_before_begin_play (bool): [Read-Write] Whether we allow this Actor to tick before it receives the BeginPlay event. Normally we don’t tick actors until after BeginPlay; this setting allows this behavior to be overridden. This Actor must be able to tick for this setting to be relevant.
  • always_relevant (bool): [Read-Write] Always relevant for network (overrides bOnlyRelevantToOwner).
  • auto_destroy_when_finished (bool): [Read-Write] If true then destroy self when “finished”, meaning all relevant components report that they are done and no timelines or timers are in flight.
  • auto_receive_input (AutoReceiveInput): [Read-Write] Automatically registers this actor to receive input from a player.
  • bake_material_position_offset_into_collision (bool): [Read-Write] Whether to bake the landscape material’s vertical world position offset into the collision heightfield.
    Note: Only z (vertical) offset is supported. XY offsets are ignored. Does not work with an XY offset map (mesh collision)
  • block_input (bool): [Read-Write] If true, all input on the stack below this actor will not be considered
  • body_instance (BodyInstance): [Read-Write] Collision profile settings for this landscape
  • can_be_damaged (bool): [Read-Write] Whether this actor can take damage. Must be true for damage events (e.g. ReceiveDamage()) to be called. https://www.unrealengine.com/blog/damage-in-ue4: TakeDamage(), ReceiveDamage():
  • can_be_in_cluster (bool): [Read-Write] If true, this actor can be put inside of a GC Cluster to improve Garbage Collection performance
  • cast_far_shadow (bool): [Read-Write] Whether this primitive should cast shadows in the far shadow cascades.
  • cast_shadow_as_two_sided (bool): [Read-Write] Whether this primitive should cast dynamic shadows as if it were a two sided material.
  • cast_static_shadow (bool): [Read-Write] Cast Static Shadow
  • collision_mip_level (int32): [Read-Write] Landscape LOD to use for collision tests. Higher numbers use less memory and process faster, but are much less accurate
  • collision_thickness (float): [Read-Write] Thickness of the collision surface, in unreal units
  • component_screen_size_to_use_sub_sections (float): [Read-Write] Component screen size (0.0 - 1.0) at which we should keep sub sections. This is mostly pertinent if you have large component of > 64 and component are close to the camera. The goal is to reduce draw call, so if a component is smaller than the value, we merge all subsections into 1 drawcall.
  • 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_time_dilation (float): [Read-Write] Allow each actor to run at a different time speed. The DeltaTime for a frame is multiplied by the global TimeDilation (in WorldSettings) and this CustomTimeDilation for this actor’s tick.
  • default_phys_material (PhysicalMaterial): [Read-Write] Default physical material, used when no per-layer values physical materials
  • enable_auto_lod_generation (bool): [Read-Write] If true, and if World setting has bEnableHierarchicalLOD equal to true, then it will generate LODActor from groups of clustered Actor
  • export_lod (int32): [Read-Write] LOD level to use when exporting the landscape to obj or FBX
  • find_camera_component_when_view_target (bool): [Read-Write] If true, this actor should search for an owned camera component to view through when used as a view target.
  • generate_overlap_events (bool): [Read-Write] If true, Landscape will generate overlap events when other components are overlapping it (eg Begin Overlap). Both the Landscape and the other component must have this flag enabled for overlap events to occur. [Overlap Events](https://docs.unrealengine.com/latest/INT/Engine/Physics/Collision/index.html#overlapandgenerateoverlapevents): UpdateOverlaps(), BeginComponentOverlap(), EndComponentOverlap():
  • generate_overlap_events_during_level_streaming (bool): [Read-Write] If true, this actor will generate overlap events when spawned as part of level streaming. You might enable this is in the case where a streaming level loads around an actor and you want overlaps to trigger.
  • hidden (bool): [Read-Write] Allows us to only see this Actor in the Editor, and not in the actual game. SetActorHiddenInGame():
  • ignores_origin_shifting (bool): [Read-Write] Whether this actor should not be affected by world origin shifting.
  • initial_life_span (float): [Read-Write] How long this Actor lives before dying, 0=forever. Note this is the INITIAL value and should not be modified once play has begun.
  • input_priority (int32): [Read-Write] The priority of this input component when pushed in to the stack.
  • instigator (Pawn): [Read-Write] Pawn responsible for damage and other gameplay events caused by this actor.
  • is_editor_only_actor (bool): [Read-Write] Whether this actor is editor-only. Use with care, as if this actor is referenced by anything else that reference will be NULL in cooked builds
  • landscape_hole_material (MaterialInterface): [Read-Write] Material used to render landscape components with holes. If not set, LandscapeMaterial will be used (blend mode will be overridden to Masked if it is set to Opaque)
  • landscape_material (MaterialInterface): [Read-Write] Combined material used to render the landscape
  • landscape_materials_override (Array(LandscapeProxyMaterialOverride)): [Read-Write] Landscape Materials Override
  • ld_max_draw_distance (float): [Read-Write] Max draw distance exposed to LDs. The real max draw distance is the min (disregarding 0) of this and volumes affecting this object.
  • lighting_channels (LightingChannels): [Read-Write] Channels that this Landscape should be in. Lights with matching channels will affect the Landscape. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.
  • lightmass_settings (LightmassPrimitiveSettings): [Read-Write] The Lightmass settings for this object.
  • lod0_distribution_setting (float): [Read-Write] The distribution setting used to change the LOD 0 generation, 1.75 is the normal distribution, numbers influence directly the LOD0 proportion on screen.
  • lod_distribution_setting (float): [Read-Write] The distribution setting used to change the LOD generation, 2 is the normal distribution, small number mean you want your last LODs to take more screen space and big number mean you want your first LODs to take more screen space.
  • max_lod_level (int32): [Read-Write] Max LOD level to use when rendering, -1 means the max available
  • max_painted_layers_per_component (int32): [Read-Write] Max Painted Layers Per Component
  • min_net_update_frequency (float): [Read-Write] Used to determine what rate to throttle down to when replicated properties are changing infrequently
  • navigation_geometry_gathering_mode (NavDataGatheringMode): [Read-Write] Navigation Geometry Gathering Mode
  • negative_z_bounds_extension (float): [Read-Write] Allows overriding the landscape bounds. This is useful if you distort the landscape with world-position-offset, for example Extension value in the negative Z axis, positive value increases bound size Note that this can also be overridden per-component when the component is selected with the component select tool
  • net_cull_distance_squared (float): [Read-Write] Square of the max distance from the client’s viewpoint that this actor is relevant and will be replicated.
  • net_dormancy (NetDormancy): [Read-Write] Dormancy setting for actor to take itself off of the replication list without being destroyed on clients.
  • net_load_on_client (bool): [Read-Write] This actor will be loaded on network clients during map load
  • net_priority (float): [Read-Write] Priority for this actor when checking for replication in a low bandwidth or saturated situation, higher priority means it is more likely to replicate
  • net_update_frequency (float): [Read-Write] How often (per second) this actor will be considered for replication, used to determine NetUpdateTime
  • net_use_owner_relevancy (bool): [Read-Write] If actor has valid Owner, call Owner’s IsNetRelevantFor and GetNetPriority
  • occluder_geometry_lod (int32): [Read-Write] Landscape LOD to use as an occluder geometry for software occlusion
  • on_actor_begin_overlap (ActorBeginOverlapSignature): [Read-Write] Called when another actor begins to overlap this actor, for example a player walking into a trigger. For events when objects have a blocking collision, for example a player hitting a wall, see ‘Hit’ events. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_end_overlap (ActorEndOverlapSignature): [Read-Write] Called when another actor stops overlapping this actor. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_hit (ActorHitSignature): [Read-Write] Called when this Actor hits (or is hit by) something solid. This could happen due to things like Character movement, using Set Location with ‘sweep’ enabled, or physics simulation. For events when objects overlap (e.g. walking into a trigger) see the ‘Overlap’ event. For collisions during physics simulation to generate hit events, ‘Simulation Generates Hit Events’ must be enabled.:
  • on_begin_cursor_over (ActorBeginCursorOverSignature): [Read-Write] Called when the mouse cursor is moved over this actor if mouse over events are enabled in the player controller.
  • on_clicked (ActorOnClickedSignature): [Read-Write] Called when the left mouse button is clicked while the mouse is over this actor and click events are enabled in the player controller.
  • on_destroyed (ActorDestroyedSignature): [Read-Write] Event triggered when the actor has been explicitly destroyed.
  • on_end_cursor_over (ActorEndCursorOverSignature): [Read-Write] Called when the mouse cursor is moved off this actor if mouse over events are enabled in the player controller.
  • on_end_play (ActorEndPlaySignature): [Read-Write] Event triggered when the actor is being deleted or removed from a level.
  • on_input_touch_begin (ActorOnInputTouchBeginSignature): [Read-Write] Called when a touch input is received over this actor when touch events are enabled in the player controller.
  • on_input_touch_end (ActorOnInputTouchEndSignature): [Read-Write] Called when a touch input is received over this component when touch events are enabled in the player controller.
  • on_input_touch_enter (ActorBeginTouchOverSignature): [Read-Write] Called when a finger is moved over this actor when touch over events are enabled in the player controller.
  • on_input_touch_leave (ActorEndTouchOverSignature): [Read-Write] Called when a finger is moved off this actor when touch over events are enabled in the player controller.
  • on_released (ActorOnReleasedSignature): [Read-Write] Called when the left mouse button is released while the mouse is over this actor and click events are enabled in the player controller.
  • on_take_any_damage (TakeAnyDamageSignature): [Read-Write] Called when the actor is damaged in any way.
  • on_take_point_damage (TakePointDamageSignature): [Read-Write] Called when the actor is damaged by point damage.
  • on_take_radial_damage (TakeRadialDamageSignature): [Read-Write] Called when the actor is damaged by radial damage.
  • only_relevant_to_owner (bool): [Read-Write] If true, this actor is only relevant to its owner. If this flag is changed during play, all non-owner channels would need to be explicitly closed.
  • optimize_bp_component_data (bool): [Read-Write] Whether to cook additional data to speed up spawn events at runtime for any Blueprint classes based on this Actor. This option may slightly increase memory usage in a cooked build.
  • pivot_offset (Vector): [Read-Write] Local space pivot offset for the actor, only used in the editor
  • positive_z_bounds_extension (float): [Read-Write] Allows overriding the landscape bounds. This is useful if you distort the landscape with world-position-offset, for example Extension value in the positive Z axis, positive value increases bound size Note that this can also be overridden per-component when the component is selected with the component select tool
  • primary_actor_tick (ActorTickFunction): [Read-Write] Primary Actor tick function, which calls TickActor(). Tick functions can be configured to control whether ticking is enabled, at what time during a frame the update occurs, and to set up tick dependencies. https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/Engine/FTickFunction/: AddTickPrerequisiteActor(), AddTickPrerequisiteComponent():
  • relevant_for_level_bounds (bool): [Read-Write] If true, this actor’s component’s bounds will be included in the level’s bounding box unless the Actor’s class has overridden IsLevelBoundsRelevant
  • render_custom_depth (bool): [Read-Write] If true, the Landscape will be rendered in the CustomDepth pass (usually used for outlines)
  • replay_rewindable (bool): [Read-Write] If true, this actor will only be destroyed during scrubbing if the replay is set to a time before the actor existed. Otherwise, RewindForReplay will be called if we detect the actor needs to be reset. Note, this Actor must not be destroyed by gamecode, and RollbackViaDeletion may not be used.
  • replicate_movement (bool): [Read-Write] If true, replicate movement/location related properties. Actor must also be set to replicate. SetReplicates(): https://docs.unrealengine.com/latest/INT/Gameplay/Networking/Replication/:
  • replicated_movement (RepMovement): [Read-Write] Used for replication of our RootComponent’s position and velocity
  • replicates (bool): [Read-Write] If true, this actor will replicate to remote machines SetReplicates():
  • root_component (SceneComponent): [Read-Write] The component that defines the transform (location, rotation, scale) of this Actor in the world, all other components must be attached to this one somehow
  • simple_collision_mip_level (int32): [Read-Write] If set higher than the “Collision Mip Level”, this specifies the Landscape LOD to use for “simple collision” tests, otherwise the “Collision Mip Level” is used for both simple and complex collision. Does not work with an XY offset map (mesh collision)
  • spawn_collision_handling_method (SpawnActorCollisionHandlingMethod): [Read-Write] Controls how to handle spawning this actor in a situation where it’s colliding with something else. “Default” means AlwaysSpawn here.
  • sprite_scale (float): [Read-Write] The scale to apply to any billboard components in editor builds (happens in any WITH_EDITOR build, including non-cooked games).
  • static_lighting_lod (int32): [Read-Write] LOD level to use when running lightmass (increase to 1 or 2 for large landscapes to stop lightmass crashing)
  • static_lighting_resolution (float): [Read-Write] The resolution to cache lighting at, in texels/quad in one axis Total resolution would be changed by StaticLightingResolution*StaticLightingResolution Automatically calculate proper value for removing seams
  • streaming_distance_multiplier (float): [Read-Write] Allows artists to adjust the distance where textures using UV 0 are streamed in/out. 1.0 is the default, whereas a higher value increases the streamed-in resolution. Value can be < 0 (from legcay content, or code changes)
  • tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing.
  • tessellation_component_screen_size (float): [Read-Write] Component screen size (0.0 - 1.0) at which we should enable tessellation.
  • tessellation_component_screen_size_falloff (float): [Read-Write] Component screen size (0.0 - 1.0) at which we start the tessellation falloff.
  • use_dynamic_material_instance (bool): [Read-Write] When set to true it will generate MaterialInstanceDynamic for each components, so material can be changed at runtime
  • use_landscape_for_culling_invisible_hlod_vertices (bool): [Read-Write] Flag whether or not this Landscape’s surface can be used for culling hidden triangles *
  • use_material_position_offset_in_static_lighting (bool): [Read-Write] Whether to use the landscape material’s vertical world position offset when calculating static lighting.
    Note: Only z (vertical) offset is supported. XY offsets are ignored. Does not work correctly with an XY offset map (mesh collision)
  • use_tessellation_component_screen_size_falloff (bool): [Read-Write] Tell if we should enable tessellation falloff. It will ramp down the Tessellation Multiplier from the material linearly. It should be disabled if you plan on using a custom implementation in material/shaders.
  • used_for_navigation (bool): [Read-Write] Hints navigation system whether this landscape will ever be navigated on. true by default, but make sure to set it to false for faraway, background landscapes
affect_distance_field_lighting

(bool) – [Read-Only] Controls whether the landscape should affect dynamic distance field lighting methods. *

body_instance

(BodyInstance) – [Read-Only] Collision profile settings for this landscape

change_component_screen_size_to_use_sub_sections(component_screen_size_to_use_sub_sections) → None

Change ComponentScreenSizeToUseSubSections value on the render proxy.

Parameters:component_screen_size_to_use_sub_sections (float) –
change_lod_distance_factor(lod_distance_factor) → None

Change the Level of Detail distance factor deprecated: This value can’t be changed anymore, you should edit the property LODDistributionSetting of the Landscape

Parameters:lod_distance_factor (float) –
change_tessellation_component_screen_size(tessellation_component_screen_size) → None

Change TessellationComponentScreenSize value on the render proxy.

Parameters:tessellation_component_screen_size (float) –
change_tessellation_component_screen_size_falloff(use_tessellation_component_screen_size_falloff) → None

Change TessellationComponentScreenSizeFalloff value on the render proxy.

Parameters:use_tessellation_component_screen_size_falloff (float) –
change_use_tessellation_component_screen_size_falloff(component_screen_size_to_use_sub_sections) → None

Change UseTessellationComponentScreenSizeFalloff value on the render proxy.

Parameters:component_screen_size_to_use_sub_sections (bool) –
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)

editor_apply_spline(spline_component, start_width=200.000000, end_width=200.000000, start_side_falloff=200.000000, end_side_falloff=200.000000, start_roll=0.000000, end_roll=0.000000, num_subdivisions=20, raise_heights=True, lower_heights=True, paint_layer=None) → None

Deform landscape using a given spline

Parameters:
  • spline_component (SplineComponent) –
  • start_width (float) – Width of the spline at the start node, in Spline Component local space
  • end_width (float) – Width of the spline at the end node, in Spline Component local space
  • start_side_falloff (float) – Width of the falloff at either side of the spline at the start node, in Spline Component local space
  • end_side_falloff (float) – Width of the falloff at either side of the spline at the end node, in Spline Component local space
  • start_roll (float) – Roll applied to the spline at the start node, in degrees. 0 is flat
  • end_roll (float) – Roll applied to the spline at the end node, in degrees. 0 is flat
  • num_subdivisions (int32) – Number of triangles to place along the spline when applying it to the landscape. Higher numbers give better results, but setting it too high will be slow and may cause artifacts
  • raise_heights (bool) – Allow the landscape to be raised up to the level of the spline. If both bRaiseHeights and bLowerHeights are false, no height modification of the landscape will be performed
  • lower_heights (bool) – Allow the landscape to be lowered down to the level of the spline. If both bRaiseHeights and bLowerHeights are false, no height modification of the landscape will be performed
  • paint_layer (LandscapeLayerInfoObject) – LayerInfo to paint, or none to skip painting. The landscape must be configured with the same layer info in one of its layers or this will do nothing!
generate_overlap_events

(bool) – [Read-Only] If true, Landscape will generate overlap events when other components are overlapping it (eg Begin Overlap). Both the Landscape and the other component must have this flag enabled for overlap events to occur. [Overlap Events](https://docs.unrealengine.com/latest/INT/Engine/Physics/Collision/index.html#overlapandgenerateoverlapevents): UpdateOverlaps(), BeginComponentOverlap(), EndComponentOverlap():

landscape_export_heightmap_to_render_target(render_target, export_height_into_rg_channel=False) → bool

Output a landscape heightmap to a render target

Parameters:
  • render_target (TextureRenderTarget2D) – Valid render target with a format of RTF_RGBA16f, RTF_RGBA32f or RTF_RGBA8
  • export_height_into_rg_channel (bool) – Tell us if we should export the height that is internally stored as R & G (for 16 bits) to a single R channel of the render target (the format need to be RTF_RGBA16f or RTF_RGBA32f) Note that using RTF_RGBA16f with InExportHeightIntoRGChannel == false, could have precision loss.
Returns:

Return type:

bool

landscape_export_weightmap_to_render_target(render_target, layer_name) → bool

Output a landscape weightmap to a render target Only works in the editor

Parameters:
Returns:

Return type:

bool

landscape_import_heightmap_from_render_target(render_target, import_height_from_rg_channel=False) → bool

Overwrites a landscape heightmap with render target data

Parameters:
  • render_target (TextureRenderTarget2D) – Valid render target with a format of RTF_RGBA16f, RTF_RGBA32f or RTF_RGBA8
  • import_height_from_rg_channel (bool) – Only relevant when using format RTF_RGBA16f or RTF_RGBA32f, and will tell us if we should import the height data from the R channel only of the Render target or from R & G. Note that using RTF_RGBA16f with InImportHeightFromRGChannel == false, could have precision loss Only works in the editor
Returns:

Return type:

bool

landscape_import_weightmap_from_render_target(render_target, layer_name) → bool

Overwrites a landscape weightmap with render target data Only works in the editor

Parameters:
Returns:

Return type:

bool

landscape_material

(MaterialInterface) – [Read-Write] Combined material used to render the landscape

ld_max_draw_distance

(float) – [Read-Only] Max draw distance exposed to LDs. The real max draw distance is the min (disregarding 0) of this and volumes affecting this object.

lighting_channels

(LightingChannels) – [Read-Only] Channels that this Landscape should be in. Lights with matching channels will affect the Landscape. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.

render_custom_depth

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

set_landscape_material_scalar_parameter_value(parameter_name, value) → None

Set a MID scalar (float) parameter value for all landscape components.

Parameters:
  • parameter_name (Name) –
  • value (float) –
set_landscape_material_texture_parameter_value(parameter_name, value) → None

Set an MID texture parameter value for all landscape components.

Parameters:
set_landscape_material_vector_parameter_value(parameter_name, value) → None

Set an MID vector parameter value for all landscape components.

Parameters: