unreal.ShallowWaterSubsystem

class unreal.ShallowWaterSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: TickableWorldSubsystem

Shallow Water Subsystem

C++ Source:

  • Plugin: WaterAdvanced

  • Module: WaterAdvanced

  • File: ShallowWaterSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • mpc (MaterialParameterCollection): [Read-Only]

  • normal_rt (TextureRenderTarget2D): [Read-Only]

  • settings (ShallowWaterSettings): [Read-Only]

  • shallow_water_niagara_simulation (NiagaraComponent): [Read-Only] Asset can be set in Project Settings - Plugins - Water ShallowWaterSimulation

  • water_info_texture (TextureRenderTarget2DArray): [Read-Only]

add_collision_agent(collision_tracker_actor: Actor, max_lifespan: float = 60.0) → None

deprecated: ‘add_collision_agent’ was renamed to ‘add_collision_tracker_for_actor’.

add_collision_tracker_for_actor(collision_tracker_actor, max_lifespan=60.000000) → None
Parameters:

  • collision_tracker_actor (Actor)

  • max_lifespan (float) – Max lifespan in case RemoveCollisionTrackerForActor() is not called on tracker destroy, which could causing the sim to keep active indefinitely

get_all_overlapping_water_bodies_and_update_collision_trackers() → Set[WaterBody]

  • 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’

Returns:

Should be the the water body touched by the most relevant pawn. If that’s not available we try to find water body touched by nearby pawns, sorted by significance.

Return type:

Set[WaterBody]

property mpc: MaterialParameterCollection

[Read-Only]

Type:

(MaterialParameterCollection)

property normal_rt: TextureRenderTarget2D

[Read-Only]

Type:

(TextureRenderTarget2D)

register_impact(impact_position, impact_velocity, impact_radius) → None

Register Impact

Parameters:
remove_collision_agent_for_actor(collision_tracker_actor: Actor) → None

deprecated: ‘remove_collision_agent_for_actor’ was renamed to ‘remove_collision_tracker_for_actor’.

remove_collision_tracker_for_actor(collision_tracker_actor) → None

Remove Collision Tracker for Actor

Parameters:

collision_tracker_actor (Actor)

set_water_body_mid_parameters(water_body) → None

Manually set MID parameters for water bodies before they collide with any pawns or CollisionTrackers

Parameters:

water_body (WaterBody)

property settings: ShallowWaterSettings

[Read-Only]

Type:

(ShallowWaterSettings)

property shallow_water_niagara_simulation: NiagaraComponent

[Read-Only] Asset can be set in Project Settings - Plugins - Water ShallowWaterSimulation

Type:

(NiagaraComponent)

property water_info_texture: TextureRenderTarget2DArray

[Read-Only]

Type:

(TextureRenderTarget2DArray)