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 |
UWaveScalar &42; SetWaveScalar
&40;
float Magnitude,
FVector Position,
float Wavelength,
float Period,
float Time,
EWaveFunctionType Function,
EFieldFalloffType Falloff
&41;
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 |