UWaveScalar

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

FieldSystemEngine

Header

/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h

Include

#include "Field/FieldSystemObjects.h"

Syntax

class UWaveScalar : public UFieldNodeFloat

Remarks

Variables

Name Description

Public variable

TEnumAsByte< EF...

 

Falloff

Type of falloff function used if the falloff function is picked

Public variable

TEnumAsByte< EW...

 

Function

Wave function used for the field

Public variable

float

 

Magnitude

Magnitude of the wave function

Public variable

float

 

Period

Time over which the wave will travel from one peak to another one.

Public variable

FVector

 

Position

Center position of the wave field

Public variable

float

 

Wavelength

Distance between 2 wave peaks

Constructors

Name Description

Public function

UWaveScalar()

Destructors

Name Description

Public function Virtual

~UWaveScalar()

Functions

Name Description

Public function

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.

Overridden from UFieldNodeBase

Name Description

Public function Virtual Const

FFieldNodeBa...

 

NewEvaluationGraph

(
    TArray< const UFieldNodeBase* ...
)

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