Navigation
API > API/Runtime > API/Runtime/FieldSystemEngine > API/Runtime/FieldSystemEngine/Field > API/Runtime/FieldSystemEngine/Field/UWaveScalar
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", Wavelength="1000", Period="1", HidePin="Time"),
DisplayName="Set Wave Scalar")
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
)
Remarks
Set a temporal wave scalar value according to the sample distance from the field position.
Parameters
| Name | Description |
|---|---|
| Magnitude | Magnitude of the wave function |
| Position | Center position of the wave field |
| Wavelength | Distance between 2 wave peaks |
| Period | Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/period |
| Function | Wave function used for the field |
| Falloff | Type of falloff function used if the falloff function is picked |