UPlaneFalloff | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Runtime > FieldSystemEngine > Field

Inheritance Hierarchy

UActorComponent
UFieldNodeBase
UFieldNodeFloat
UPlaneFalloff

References


Module	FieldSystemEngine
Header	/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h
Include	#include "Field/FieldSystemObjects.h"

Syntax

UCLASS (ClassGroup="Field",  
       Meta=(BlueprintSpawnableComponent, ToolTip="Plane scalar field that will be defined only within a distance from a plane"),  
       ShowCategories=("Field"), MinimalAPI)  
class UPlaneFalloff : public UFieldNodeFloat

Remarks

PlaneFalloff

Variables

Type	Name	Description
float	Default	The field value will be set to Default if the sample distance from the plane is higher than the distance
float	Distance	Distance limit for the plane falloff field
TEnumAsByte< EFieldFalloffType >	Falloff	Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface
float	Magnitude	Magnitude of the plane falloff field
float	MaxRange	The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude
float	MinRange	The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude
FVector	Normal	Plane normal of the plane falloff field
FVector	Position	Plane position of the plane falloff field

Constructors

	Type	Name	Description
		UPlaneFalloff ()

Destructors

	Type	Name	Description
		~UPlaneFalloff ()

Functions

	Type	Name	Description
	UPlaneFalloff *	SetPlaneFalloff ( UPARAM(DisplayName="Field Magnitude") float Magnitude, UPARAM(DisplayName="Min Range") float MinRange, UPARAM(DisplayName="Max Range") float MaxRange, UPARAM(DisplayName="Default Value") float Default, UPARAM(DisplayName="Plane Distance") float Distance, UPARAM(DisplayName="Center Position") FVector Position, UPARAM(DisplayName="Plane Normal") FVector Normal, UPARAM(DisplayName="Falloff Type") EFieldFalloffType Falloff )	Plane scalar field that will be defined only within a distance from a plane