UWaveScalar | Unreal Engine 5.5 Documentation

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

Inheritance Hierarchy

UActorComponent
UFieldNodeBase
UFieldNodeFloat
UWaveScalar

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="Set a temporal wave scalar value according to the sample distance from the field position."),  
       ShowCategories=("Field"), MinimalAPI)  
class UWaveScalar : public UFieldNodeFloat

Remarks

UWaveScalar

Variables

Type	Name	Description
TEnumAsByte< EFieldFalloffType >	Falloff	Type of falloff function used if the falloff function is picked
TEnumAsByte< EWaveFunctionType >	Function	Wave function used for the field
float	Magnitude	Magnitude of the wave function
float	Period	Time over which the wave will travel from one peak to another one.
FVector	Position	Center position of the wave field
float	Wavelength	Distance between 2 wave peaks

Constructors

	Type	Name	Description
		UWaveScalar ()

Destructors

	Type	Name	Description
		~UWaveScalar ()

Functions

	Type	Name	Description
	UWaveScalar *	SetWaveScalar ( UPARAM(DisplayName="Field Magnitude") float Magnitude, UPARAM(DisplayName="Center Position") FVector Position, UPARAM(DisplayName="Wave Length") float Wavelength, UPARAM(DisplayName="Wave Period") float Period, UPARAM(DisplayName="Time Offset") float Time, UPARAM(DisplayName="Wave Function") EWaveFunctionType Function, UPARAM(DisplayName="Falloff Type") EFieldFalloffType Falloff )	Set a temporal wave scalar value according to the sample distance from the field position.