unreal.WaterSubsystem

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

Bases: TickableWorldSubsystem

This is the API used to get information about water at runtime

C++ Source:

• Plugin: Water

• Module: Water

• File: WaterSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

• on_camera_underwater_state_changed (OnCameraUnderwaterStateChanged): [Read-Write]

• on_water_scalability_changed (OnWaterScalabilityChanged): [Read-Write]

get_camera_underwater_depth() → float

Get Camera Underwater Depth

Return type:

float

get_ocean_base_height() → float

Returns the base height of the ocean. This should correspond to its world Z position

Return type:

float

get_ocean_flood_height() → float

Returns the relative flood height

Return type:

float

get_ocean_total_height() → float

Returns the total height of the ocean. This should correspond to the base height plus any additional height, like flood for example

Return type:

float

classmethod get_shallow_water_max_dynamic_forces() → int32

Get Shallow Water Max Dynamic Forces

Return type:

int32

classmethod get_shallow_water_max_impulse_forces() → int32

Get Shallow Water Max Impulse Forces

Return type:

int32

classmethod get_shallow_water_simulation_render_target_size() → int32

Get Shallow Water Simulation Render Target Size

Return type:

int32

get_smoothed_world_time_seconds() → float

Get Smoothed World Time Seconds

Return type:

float

get_water_time_seconds() → float

Get Water Time Seconds

Return type:

float

is_shallow_water_simulation_enabled() → bool

Is Shallow Water Simulation Enabled

Return type:

bool

is_underwater_post_process_enabled() → bool

Is Underwater Post Process Enabled

Return type:

bool

is_water_rendering_enabled() → bool

Is Water Rendering Enabled

Return type:

bool

property on_camera_underwater_state_changed: OnCameraUnderwaterStateChanged

[Read-Write]

Type:

(OnCameraUnderwaterStateChanged)

property on_water_scalability_changed: OnWaterScalabilityChanged

[Read-Write]

Type:

(OnWaterScalabilityChanged)

print_to_water_log(message, warning) → None

Print to Water Log

Parameters:

• message (str) –

• warning (bool) –

set_ocean_flood_height(flood_height) → None

Set Ocean Flood Height

Parameters:

flood_height (float) –