1. Epic GamesDeveloper
  3. UPlaneFalloff

UPlaneFalloff

PlaneFalloff

API > API/Runtime > API/Runtime/FieldSystemEngine

PlaneFalloff

   
Name UPlaneFalloff
Type class
Header File /Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h
Include Path #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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPlaneFalloff()

   Field/FieldSystemObjects.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UPlaneFalloff()

   Field/FieldSystemObjects.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Default float The field value will be set to Default if the sample distance from the plane is higher than the distance Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Default Value"
Distance float Distance limit for the plane falloff field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Plane Distance"
Falloff TEnumAsByte< EFieldFalloffType > Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Falloff Type"
Magnitude float Magnitude of the plane falloff field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Field Magnitude"
MaxRange float The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Max Range"
MinRange float The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Min Range"
Normal FVector Plane normal of the plane falloff field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Plane Normal"
Position FVector Plane position of the plane falloff field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Center Position"

Functions

Public

Name Remarks Include Path Unreal Specifiers

UPlaneFalloff * SetPlaneFalloff ( float Magnitude,
float MinRange,
float MaxRange,
float Default,
float Distance,
FVector Position,
FVector Normal,
EFieldFalloffType Falloff
)

 Plane scalar field that will be defined only within a distance from a plane Field/FieldSystemObjects.h
  • BlueprintPure
  • Category="Field"
  • Meta=(Magnitude="1.0", MinRange="0.0", MaxRange="1.0")

Overridden from UFieldNodeBase

Name Remarks Include Path Unreal Specifiers

virtual FFieldNodeBase * NewEvaluationGraph ( TArray< const UFieldNodeBase* >& Nodes
) const

   Field/FieldSystemObjects.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page