Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > FieldSystemEngine > Field > UBoxFalloff > UBoxFalloff::SetBoxFalloff

Light Theme

Dark Theme

UBoxFalloff::SetBoxFalloff

Box scalar field that will be defined only within a box

Windows

MacOS

Linux

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

Syntax

UBoxFalloff * SetBoxFalloff
(
    float Magnitude,
    float MinRange,
    float MaxRange,
    float Default,
    FTransform Transform,
    EFieldFalloffType Falloff
)

Remarks

Box scalar field that will be defined only within a box

Parameters

Parameter	Description
Magnitude	Magnitude of the box 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 distance from the box is higher than the scale of the transform
Transform	Translation, Rotation and Scale of the unit box
Falloff	Type of falloff function used to model the evolution of the field from the box surface to the sample position

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss