unreal.ShallowWaterSettings

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

Bases: DeveloperSettings

Shallow Water Settings

C++ Source:

  • Plugin: WaterAdvanced

  • Module: WaterAdvanced

  • File: ShallowWaterSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • default_ocean_patch_niagara_system (NiagaraSystem): [Read-Write]

  • default_shallow_water_collision_ndc (NiagaraDataChannelAsset): [Read-Write]

  • default_shallow_water_niagara_simulation (NiagaraSystem): [Read-Write]

  • grid_center_mpc_name (Name): [Read-Write]

  • max_active_pawn_num (int32): [Read-Write]

  • max_impulse_force_num (int32): [Read-Write]

  • normal_rt_material_name (Name): [Read-Write]

  • physics_asset_proxies_data_asset (ShallowWaterPhysicsAssetOverridesDataAsset): [Read-Write] Default overrides. Game Feature Plugin can register their own overrides asset with subsystem RegisterPhysicsAssetOverridesDataAsset()

  • resolution_max_axis_mpc_name (Name): [Read-Write]

  • shallow_water_sim_parameters (ShallowWaterSimParameters): [Read-Write]

  • use_default_shallow_water_subsystem (bool): [Read-Write]

  • visualize_active_pawn (bool): [Read-Write]

  • water_mpc (MaterialParameterCollection): [Read-Write]

  • world_grid_size_mpc_name (Name): [Read-Write]

property default_ocean_patch_niagara_system: NiagaraSystem

[Read-Only]

Type:

(NiagaraSystem)

property default_shallow_water_collision_ndc: NiagaraDataChannelAsset

[Read-Only]

Type:

(NiagaraDataChannelAsset)

property default_shallow_water_niagara_simulation: NiagaraSystem

[Read-Only]

Type:

(NiagaraSystem)

property grid_center_mpc_name: Name

[Read-Only]

Type:

(Name)

property max_active_pawn_num: int

[Read-Only]

Type:

(int32)

property max_impulse_force_num: int

[Read-Only]

Type:

(int32)

property normal_rt_material_name: Name

[Read-Only]

Type:

(Name)

property physics_asset_overrides_data_asset: ShallowWaterPhysicsAssetOverridesDataAsset

‘physics_asset_overrides_data_asset’ was renamed to ‘physics_asset_proxies_data_asset’.

Type:

deprecated

property physics_asset_proxies_data_asset: ShallowWaterPhysicsAssetOverridesDataAsset

[Read-Only] Default overrides. Game Feature Plugin can register their own overrides asset with subsystem RegisterPhysicsAssetOverridesDataAsset()

Type:

(ShallowWaterPhysicsAssetOverridesDataAsset)

property resolution_max_axis_mpc_name: Name

[Read-Only]

Type:

(Name)

property shallow_water_sim_parameters: ShallowWaterSimParameters

[Read-Only]

Type:

(ShallowWaterSimParameters)

property use_default_shallow_water_subsystem: bool

[Read-Only]

Type:

(bool)

property visualize_active_pawn: bool

[Read-Only]

Type:

(bool)

property water_mpc: MaterialParameterCollection

[Read-Only]

Type:

(MaterialParameterCollection)

property world_grid_size_mpc_name: Name

[Read-Only]

Type:

(Name)