Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UWaterSplineComponent

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

USplineComponent

UWaterSplineComponent

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterSplineComponent.h
Include	#include "WaterSplineComponent.h"

Syntax

UCLASS(ClassGroup=(Custom), Meta=(BlueprintSpawnableComponent))
class UWaterSplineComponent : public USplineComponent

Variables

		Name	Description
	FWaterSplineCur...	PreviousWaterSplineDefaults	This stores the last defaults propagated to spline points on an instance of this component Used to determine if spline points were modifed by users or if they exist at a current default value
	FWaterSplineCur...	WaterSplineDefaults	Defaults which are used to propagate values to spline points on instances of this in the world

Constructors

	Name	Description
	UWaterSplineComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	K2_SynchronizeAndBroadcastDataChange()	Call to update water spline Necessary if using USplineComponent::AddPoint(s) instead of editing the spline in editor
FOnWaterSpli...	OnWaterSplineDataChanged()
void	ResetSpline ( const TArray< FVector >& Points )
bool	SynchronizeWaterProperties()

Overridden from USplineComponent

	Name	Description
bool	AllowsSplinePointScaleEditing()	Controls the visibility of the Spline point scale editor in the details panel.
TArray< ESpl...	GetEnabledSplinePointTypes()	Get the enabled Spline Point types for this spline component.
USplineMetad...	GetSplinePointsMetadata()	Spline component interface
const USplin...	GetSplinePointsMetadata()

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditImport()	Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Functions

		Name	Description
	PRAGMA_DISAB...	OnSplineDataChanged()	Use FOnWaterSplineDataChanged Use OnWaterSplineDataChanged

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

Take our survey

Cancel