1. Epic GamesDeveloper
  3. UShallowWaterSubsystem

UShallowWaterSubsystem

API > API/Plugins > API/Plugins/WaterAdvanced

Inheritance Hierarchy

References

   
Module WaterAdvanced
Header /Engine/Plugins/Experimental/WaterAdvanced/Source/WaterAdvanced/Public/ShallowWaterSubsystem.h
Include #include "ShallowWaterSubsystem.h"

Syntax

UCLASS (Abstract)  
class UShallowWaterSubsystem : public UTickableWorldSubsystem

Variables

  Type Name Description
Protected variable UProperty TArray< TWeakObjectPtr< APawn > > ActivePawns Consistent record through multiple frames since we want active pawns that affects the fluidsim to remain active Even when it's less significant than newly available pawns.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UMaterialParameterCollection > MPC  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UTextureRenderTarget2D > NormalRT  
Protected variable FVector PreviousProjectedLocation  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UShallowWaterSettings > Settings  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UNiagaraComponent > ShallowWaterNiagaraSimulation Asset can be set in Project Settings - Plugins - Water ShallowWaterSimulation.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< const UTextureRenderTarget2DArray > WaterInfoTexture  
Protected variable TWeakObjectPtr< APlayerController > WeakPlayerController  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function UFunction BlueprintCallable, Category void

AddCollisionTrackerForActor ( AActor* CollisionTrackerActor,
float MaxLifespan
)

  
Protected function void Remove invalid references. The owning actor may get destroyed.
Public function void  
Protected function void  
Protected function void VehicleCollisionProxies is handled inside.
Protected function void  
Public function void  
Protected function Virtual void  
Protected function Virtual UFunction BlueprintCallable, Category TSet< AWaterBody * > WaterBody is used for: Get water data texture Get water zone Get character location projected onto water surface Check if character or vehicle is 'in water'
Public function Const TOptional< FVector >  
Protected function Virtual Const float  
Protected function Virtual Const TOptional< FShallowWaterCollisionContext > By default getting the first SKM, if is ACharacter, get 'Mesh' component Override if e.g. The pawn is driving a boat, return SKM of boat instead
Public function Const int32  
Public function Const float  
Public function Virtual ECollisionChannel Override to return the ECC channel of bullets.
Public function Const APawn *  
Protected function TSet< AWaterBody * >  
Protected function TSet< AWaterBody * >  
Protected function Virtual Const TSet< AWaterBody * >  
Protected function Virtual Const TArray< APawn * >

GetPawnsInRange ( const bool bShouldSortBySignificance
)

 For overriden functions: Do not use GetTheMostRelevantPlayerPawn() inside to avoid loop. Use local controlled pawn location or camera location instead.
Protected function Virtual Const TArray< APawn * >

GetPawnsInRange ( const FVector ObservingLocation,
const bool bShouldSortBySignificance
)

  
Public function Const APawn * Think of this as a cursor that in most time locks on the current player pawn If the player doesn't have a physical pawn (e.g. spectating), the cursor jump around and lock on the nearest pawn to the camera If there is no relevant pawn (all eliminate), returns nullptr
Public function Virtual Const FGameplayTagContainer  
Public function void  
Public function Virtual void  
Public function Virtual Const bool Note: A world subsystem is always created and activated even when the plugin (GFP or not) it resides in is completely disabled When the subclass of this class is a Game Feature Plugin.
Public function Const bool  
Protected function UFunction void  
Public function UFunction BlueprintCallable, Category void

RegisterImpact ( FVector ImpactPosition,
FVector ImpactVelocity,
float ImpactRadius
)

  
Public function void Add PA overrides. Designed to be called by Game Feature Plugins.
Protected function UFunction BlueprintCallable, Category void

RemoveCollisionTrackerForActor ( AActor* CollisionTrackerActor
)

  
Public function UFunction BlueprintCallable, Category void Manually set MID parameters for water bodies before they collide with any pawns or CollisionTrackers.
Protected function Const bool  
Protected function void WaterBody
Public function void  
Protected function Virtual int32 Override to get most relevant pawns every frame.
Protected function void  
Public function void  
Protected function void

UpdateOverlappingWaterBodiesHistory ( TArray< AWaterBody* > OverlappingWaterBodies
)

  
Public function void

WriteImpactToNDC ( FVector ImpactPosition,
FVector ImpactVelocity,
float ImpactRadius
)

  

Overridden from UWorldSubsystem

  Type Name Description
Public function Virtual void

OnWorldBeginPlay ( UWorld& InWorld
)

 Called when world is ready to start gameplay before the game mode transitions to the correct state and call BeginPlay on all actors
Public function Virtual void Called once all UWorldSubsystems have been initialized

Overridden from USubsystem

  Type Name Description
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id used to track the performance of this object
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Constants

Name Description
ColliderComponentTag Collision

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page