1. Epic GamesDeveloper
  3. UWaveScalar

UWaveScalar

[UWaveScalar](API\Runtime\FieldSystemEngine\UWaveScalar)

API > API/Runtime > API/Runtime/FieldSystemEngine

UWaveScalar

   
Name UWaveScalar
Type class
Header File /Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h
Include Path #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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UWaveScalar()

   Field/FieldSystemObjects.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UWaveScalar()

   Field/FieldSystemObjects.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Falloff TEnumAsByte< EFieldFalloffType > Type of falloff function used if the falloff function is picked Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Falloff Type"
Function TEnumAsByte< EWaveFunctionType > Wave function used for the field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Wave Function"
Magnitude float Magnitude of the wave function Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Field Magnitude"
Period float Time over which the wave will travel from one peak to another one. Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Wave Period"
Position FVector Center position of the wave field Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Center Position"
Wavelength float Distance between 2 wave peaks Field/FieldSystemObjects.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Field"
  • DisplayName="Wave Length"

Functions

Public

Name Remarks Include Path Unreal Specifiers

UWaveScalar * SetWaveScalar ( float Magnitude,
FVector Position,
float Wavelength,
float Period,
float Time,
EWaveFunctionType Function,
EFieldFalloffType Falloff
)

 Set a temporal wave scalar value according to the sample distance from the field position. Field/FieldSystemObjects.h
  • BlueprintPure
  • Category="Field"
  • Meta=(Magnitude="1.0", Wavelength="1000", Period="1", HidePin="Time")
  • DisplayName="Set Wave Scalar"

Overridden from UFieldNodeBase

Name Remarks Include Path Unreal Specifiers

virtual FFieldNodeBase * NewEvaluationGraph ( TArray< const UFieldNodeBase* >& Nodes
) const

   Field/FieldSystemObjects.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page