UBoxFalloff | Unreal Engine 5.5 Documentation

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

Inheritance Hierarchy

UActorComponent
UFieldNodeBase
UFieldNodeFloat
UBoxFalloff

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="Box scalar field that will be defined only within a box"),  
       ShowCategories=("Field"), MinimalAPI)  
class UBoxFalloff : public UFieldNodeFloat

Remarks

BoxFalloff

Variables

Type	Name	Description
float	Default	The field value will be set to Default if the sample distance from the box is higher than the scale of the transform
TEnumAsByte< EFieldFalloffType >	Falloff	Type of falloff function used to model the evolution of the field from the box surface to the sample position
float	Magnitude	Magnitude of the box 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
FTransform	Transform	Translation, Rotation and Scale of the unit box

Constructors

	Type	Name	Description
		UBoxFalloff ()

Destructors

	Type	Name	Description
		~UBoxFalloff ()

Functions

	Type	Name	Description
	UBoxFalloff *	SetBoxFalloff ( 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="Box Transform") FTransform Transform, UPARAM(DisplayName="Falloff Type") EFieldFalloffType Falloff )	Box scalar field that will be defined only within a box