Navigation
API > API/Runtime > API/Runtime/FieldSystemEngine > API/Runtime/FieldSystemEngine/Field > API/Runtime/FieldSystemEngine/Field/UPlaneFalloff
References
| Module | FieldSystemEngine |
| Header | /Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h |
| Include | #include "Field/FieldSystemObjects.h" |
| Source | /Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Private/Field/FieldSystemObjects.cpp |
UFUNCTION (BlueprintPure, Category="Field", Meta=(Magnitude="1.0", MinRange="0.0", MaxRange="1.0"))
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
)
Remarks
Plane scalar field that will be defined only within a distance from a plane
Parameters
| Name | Description |
|---|---|
| Magnitude | Magnitude of the plane falloff field |
| MinRange | The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude |
| MaxRange | The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude |
| Default | The field value will be set to default if the sample projected distance ((Sample Position - Center Position).dot(Plane Normal)) is higher than the Plane Distance |
| Distance | Distance limit for the plane falloff field starting from the center position and extending in the direction of the plane normal |
| Position | Plane center position of the plane falloff field |
| Normal | Plane normal of the plane falloff field |
| Falloff | Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface |