1. Epic GamesDeveloper
  3. ULandscapePatchComponent

ULandscapePatchComponent

Base class for landscape patches: components that can be attached to meshes and moved around to make the meshes affect the landscape around themselves.

API > API/Plugins > API/Plugins/LandscapePatch

Inheritance Hierarchy

References

   
Module LandscapePatch
Header /Engine/Plugins/Experimental/LandscapePatch/Source/LandscapePatch/Public/LandscapePatchComponent.h
Include #include "LandscapePatchComponent.h"

Syntax

UCLASS&40;Blueprintable, BlueprintType, Abstract&41;  
class ULandscapePatchComponent : public USceneComponent

Remarks

Base class for landscape patches: components that can be attached to meshes and moved around to make the meshes affect the landscape around themselves.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere bool bIsEnabled When false, patch does not affect the landscape. Useful for temporarily disabling the patch.
Protected variable bool bLoadedButNotYetRegistered This is true for existing height patches right after they are loaded, so that we can ignore the first OnRegister call.
Protected variable bool bWasCopy Determines whether the height patch was made by copying a different height patch.
Protected variable UProperty Category, EditAnywhere TSoftObjectPtr< ALandscape > Landscape  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay TSoftObjectPtr< ALandscapePatchManager > PatchManager  

Constructors

  Type Name Description
Public function  

ULandscapePatchComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool

AffectsWeightmapLayer ( const FName& InLayerName
)

  
Public function void  
Public function Const UFunction BlueprintCallable, Category FTransform  
Public function Virtual Const UFunction BlueprintCallable, Category ALandscapePatchManager *  
Public function Virtual void

Initialize_Native ( const FTransform& InLandscapeTransform,
const FIntPoint& InLandscapeSize,
const FIntPoint& InLandscapeRenderTargetSize
)

  
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Protected function UFunction Category callineditor void Move the patch to be the last processed patch in the current patch manager.
Public function Virtual UTextureRenderTarget2D *  
Public function UFunction BlueprintCallable, Category void

RequestLandscapeUpdate ( bool bInUserTriggeredUpdate
)

  
Public function UFunction BlueprintCallable, Category void

SetIsEnabled ( bool bEnabledIn
)

 Allows the patch to be disabled, so that it no longer affects the landscape.
Public function Virtual UFunction BlueprintCallable, Category void

SetLandscape ( ALandscape* NewLandscape
)

  
Public function Virtual UFunction BlueprintCallable, Category void  

Overridden from USceneComponent

  Type Name Description
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 USceneComponent.

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const void Add properties to the component owner's actor desc.
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual void UActorComponent.
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Returns whether this component is an editor-only object or not
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 UObject.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Deprecated Functions

  Type Name Description
Public function Virtual Const bool

IsAffectingWeightmapLayer ( const FName& InLayerName
)

 Use AffectsWeightmapLayer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page